The Splunk Distribution of OpenTelemetry Collector provides this integration as the OpenStack monitor via the Smart Agent Receiver.
This monitor gathers metrics from OpenStack instances using the OpenStack Python plugin. This plugin is installed with the Smart Agent or the Splunk Distribution of OpenTelemetry Collector, so no additional installation is required to use this monitor.
This monitor covers the following OpenStack components:
Cinder (Block Storage)
See OpenStack for the monitor source.
To install this integration:
Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.
Configure the monitor, as described in the next section.
The Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.
Note: Providing an OpenStack monitor entry in your Smart Agent or Collector configuration is required for its use. Use the appropriate form for your agent type.
Smart Agent 🔗
To activate this monitor in the Smart Agent, add the following to your agent configuration:
monitors: # All monitor config goes under this key - type: collectd/openstack ... # Additional config
See Smart Agent example configuration for an autogenerated example of a YAML configuration file, with default values where applicable.
Splunk Distribution of OpenTelemetry Collector 🔗
To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:
receivers: smartagent/openstack: type: collectd/openstack ... # Additional config
To complete the monitor activation, you must also include the
smartagent/openstack receiver item in a
metrics pipeline. To do this, add the receiver item to the
receivers section of your configuration file.
See configuration examples for specific use cases that show how the collector can integrate and complement existing environments.
The following is an example OpenStack Smart Agent monitor configuration:
monitors: - type: collectd/openstack authURL: "http://192.168.11.111/identity/v3" username: "<admin-username>" password: "<admin-password>"
The following is an example OpenStack Smart Agent monitor configuration using
monitors: - type: collectd/openstack authURL: "https://192.168.11.111/identity/v3" username: "<admin-username>" password: "<admin-password>" skipVerify: true
Configuration settings 🔗
The following table shows the configuration options for the OpenStack monitor:
||Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime is used. This option can include arguments to the binary as well.|
||Keystone authentication URL/endpoint for the OpenStack cloud|
||Username to authenticate with keystone identity|
||Password to authenticate with keystone identity|
||Specify the name of Project to be monitored (default:"demo")|
||The project domain (default:"default")|
||The region name for URL discovery. The region name defaults to the first region if multiple regions are available.|
||The user domain ID (default:"default")|
||Skip SSL certificate validation (default:
Deployment host for the Smart Agent 🔗
Identify a host on which the Smart Agent will run. This integration collects data from OpenStack remotely via APIs, and so those API endpoints must be visible to the host on which the Smart Agent runs.
Do not install the Smart Agent directly on a compute instance because a compute instance/resource under one project cannot get stats about the resources under other projects. Also, a compute instance may go down due to lack of resources in the project.
These are the metrics available for this integration.