Host Template: Cloud - OpenStack - Swift
Overview Copied
Monitor the status of your OpenStack Object Store
This Host Template includes the following Service Checks:
| Service Check Name | Description | Default Thresholds (Metric: Warning, Critical) | UOM |
|---|---|---|---|
| OpenStack - Swift - API | The status of the Swift API | N/A | N/A |
| OpenStack - Swift - Bytes Used | Number of bytes used for a given account | N/A | B |
| OpenStack - Swift - Container Count | Number of containers for a given account | N/A | N/A |
| OpenStack - Swift - Object Count | Number of objects for a given account | 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 - Swift 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_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 the swiftoperator role. For more information, refer to Swift Auth System.
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. |
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 - Swift - API | OpenStack.Swift.API |
| OpenStack - Swift - Bytes Used | OpenStack.Swift.Bytes |
| OpenStack - Swift - Container Count | OpenStack.Swift.Containers |
| OpenStack - Swift - Object Count | OpenStack.Swift.Objects |