OpenStack 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the OpenStack monitor type for the Smart Agent Receiver.

Use this monitor to gather metrics from OpenStack instances using the OpenStack Python plugin.

This monitor covers the following OpenStack components:

Nova (Compute)
Cinder (Block Storage)
Neutron (Network)

Note

This monitor is not available on Windows as collectd plugins are only supported in Linux and Kubernetes.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

Note

Provide an OpenStack monitor entry in your Collector or Smart Agent (deprecated) configuration. Use the appropriate form for your agent type.

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 service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/openstack]

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 Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

The following is a sample 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 skipVerify:

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:

Option	Required	Type	Description
`pythonBinary`	No	`string`	Path to the Python binary. If not set, a built-in runtime is used. This setting can include arguments to the binary.
`authURL`	Yes	`string`	Keystone authentication URL or endpoint for the OpenStack cloud.
`username`	Yes	`string`	Username to authenticate with keystone identity.
`password`	Yes	`string`	Password to authenticate with keystone identity.
`projectName`	No	`string`	Specify the name of the project to be monitored. The default value is `demo`.
`projectDomainID`	No	`string`	The project domain. The default value is `default`.
`regionName`	No	`string`	The region name for URL discovery. The region name defaults to the first region if multiple regions are available.
`userDomainID`	No	`string`	The user domain ID. The default value is `default`.
`skipVerify`	No	`bool`	Skips SSL certificate validation. The default value is `false`.

Deployment host for the Smart Agent 🔗

Identify a host on which the Smart Agent runs. This integration collects data from OpenStack remotely using APIs. The API endpoints must be visible to the host on which the Smart Agent runs.

Don’t install the Smart Agent directly on a compute instance, as a compute instance or resource under one project cannot get stats about the resources under other projects. A compute instance might crash due to lack of resources in the project.

Metrics 🔗

The following metrics are available for this integration:

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics