Host Template: Cloud - OpenStack - Nova Hypervisor
Overview Copied
Monitor the status of your OpenStack Hypervisors
This Host Template includes the following Service Checks:
Service Check Name | Description | Default Thresholds (Metric: Warning, Critical) | UOM |
---|---|---|---|
OpenStack - Nova Hypervisor - Active State | Summary of hypervisor state | hypervisors_not_ok: N/A,0 |
N/A |
OpenStack - Nova Hypervisor - Available Disk Space | Total disk space available across the selected hypervisors | N/A | B |
OpenStack - Nova Hypervisor - Available Memory | Total RAM available across the selected hypervisors | N/A | B |
OpenStack - Nova Hypervisor - Services | Summary of services running across the selected hypervisors | services_not_ok: N/A,0 |
N/A |
OpenStack - Nova Hypervisor - System Load | Count of all current hypervisor operations | N/A | N/A |
OpenStack - Nova Hypervisor - Virtual CPUs | Total number of virtual CPUs across the selected hypervisors | N/A | N/A |
OpenStack - Nova Hypervisor - Virtual Machines | Total number of virtual machines running on the selected hypervisors | N/A | N/A |
Note
See details about Monitoring Plugin thresholds here.
Usage Instructions Copied
Please review the overall Cloud - OpenStack Opspack documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.
Add this Host Template Copied
Add the Cloud - OpenStack - Nova Hypervisor Host Template to your Opsview Monitor host. If the resource you’re monitoring has no hostname or public IP, then open the Advanced settings pane and change Host Check Command to Always assumed to be UP.
Note
For more information, refer to the documentation on Adding Host Templates to Hosts.
Add and configure Variables Copied
The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:
- OPENSTACK_CREDENTIALS
- OPENSTACK_KEYSTONE_ENDPOINT
- OPENSTACK_PROJECT
- OPENSTACK_AUTH_DOMAIN
- OPENSTACK_PROJECT_DOMAIN
- OPENSTACK_AVAILABILITY_ZONE
- OPENSTACK_HOST_AGGREGATE
- OPENSTACK_HYPERVISOR_NAME
- OPENSTACK_CERTIFICATES
Note
For more information, refer to the documentation on Adding Variables to Hosts.
Apply Changes Copied
Apply Changes and the system will now be monitored:
Additional Information Copied
Troubleshooting Permissions Copied
The Opsview ‘read’ user requires ‘GET’ access to the following Nova endpoints with minimum scope of ‘project’:
- /os-hypervisors/detail
- /os-availability-zone/detail
- /os-aggregates
- /os-services
Note
For more information regarding OpenStack Nova policies, refer to Nova configuration policy.
Available Variables Copied
OPENSTACK_CREDENTIALS Copied
The Value is not used and therefore can be set to anything.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (Opsview UI Only) | Value | OpenStack Credentials | N/A |
--username |
Arg1 | OpenStack Username | The username of your OpenStack monitoring credentials. |
--password |
Arg2 | OpenStack Password | The password of your OpenStack monitoring credentials. |
OPENSTACK_KEYSTONE_ENDPOINT Copied
The Value is not used and therefore can be set to anything.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (Opsview UI Only) | Value | OpenStack Keystone Endpoint | N/A |
--openstack-keystone-service-protocol |
Arg1 | OpenStack Keystone Protocol | The protocol (HTTP/HTTPS) that the OpenStack keystone service is listening on. |
--openstack-keystone-service-address |
Arg2 | OpenStack Keystone Address | The IP or hostname that the OpenStack keystone service is listening on. |
--openstack-keystone-service-port |
Arg3 | OpenStack Keystone Port | The port that the OpenStack keystone service is listening on. |
OPENSTACK_PROJECT Copied
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
--project |
Value | OpenStack Project | The OpenStack project you wish to monitor. |
OPENSTACK_AUTH_DOMAIN Copied
The Value is not used and therefore can be set to anything. Override the arguments with either your domain name or domain ID to be used for authentication.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (Opsview UI Only) | Value | OpenStack Auth Domain | N/A |
--auth-domain-name |
Arg1 | OpenStack Auth Domain Name | The domain name to be used for authentication. |
--auth-domain-id |
Arg2 | OpenStack Auth Domain ID | The domain ID to be used for authentication. |
OPENSTACK_PROJECT_DOMAIN Copied
The Value is not used and therefore can be set to anything. Override the arguments with either your domain name or domain ID for your project.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (Opsview UI Only) | Value | OpenStack Project Domain | N/A |
--project-domain-name |
Arg1 | OpenStack Project Domain Name | The domain name of your project. |
--project-domain-id |
Arg2 | OpenStack Project Domain ID | The domain ID for your project. |
OPENSTACK_AVAILABILITY_ZONE Copied
To monitor Hypervisors in an Availability Zone, do not supply the ‘Hypervisor Name’ or ‘Host Aggregate’ variables.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
--zone |
Value | OpenStack Availability Zone | The name of the Availability Zone to monitor a set of hypervisors. |
OPENSTACK_HOST_AGGREGATE Copied
To monitor Hypervisors in an Aggregate, do not supply the ‘Hypervisor Name’ or ‘Availability Zone’ variables.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
--aggregate |
Value | OpenStack Host Aggregate | The name of the Host Aggregate to monitor a set of hypervisors. |
OPENSTACK_HYPERVISOR_NAME Copied
To monitor a single Hypervisor, do not supply the ‘Availability Zone’ or ‘Host Aggregate’ variables.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
--hypervisor-name |
Value | OpenStack Hypervisor Name | The name of the hypervisor to monitor; by default all hypervisors will be monitored. |
SSL Certificates: OPENSTACK_CERTIFICATES Copied
Opsview Cloud
For Opsview Cloud customers, please contact ITRS Support for assistance with setting up certificate files, as they require Orchestrator access.
Additionally, you can use the OPENSTACK_CERTIFICATES variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics.
The Value is not used and therefore can be set to anything. Override the arguments with your certificates.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
--ca-path |
Arg1 | CA Certificate Path | Path to the CA Certificate |
--client-cert |
Arg2 | Client Certificate Path | Path to the Client Certificate |
--client-key |
Arg3 | Client Key Path | Path to the Client Key |
Plugin help Copied
Plugin: check_ostack
Secure Args
This plugin uses the Secure Args feature for argument passing.
For mode-specific help, run the plugin with the -h -m <mode>
flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:
Service Check Name | Mode |
---|---|
OpenStack - Nova Hypervisor - Active State | OpenStack.Nova.Hypervisor.State |
OpenStack - Nova Hypervisor - Available Disk Space | OpenStack.Nova.Hypervisor.Disk |
OpenStack - Nova Hypervisor - Available Memory | OpenStack.Nova.Hypervisor.Memory |
OpenStack - Nova Hypervisor - Services | OpenStack.Nova.Hypervisor.Services |
OpenStack - Nova Hypervisor - System Load | OpenStack.Nova.Hypervisor.Load |
OpenStack - Nova Hypervisor - Virtual CPUs | OpenStack.Nova.Hypervisor.VCPUs |
OpenStack - Nova Hypervisor - Virtual Machines | OpenStack.Nova.Hypervisor.VMs |