Overview

Note: This integration only applies to OpenStack v13+. If you are looking to collect metrics from OpenStack v12 and below, use the OpenStack integration.

This check monitors OpenStack from the controller node.

Setup

Installation

The OpenStack Controller check is included in the Datadog Agent package, so you do not need to install anything else on your server.

Configuration

The OpenStack Controller integration is designed to collect information from all compute nodes and the servers running it. The integration should be run from a single Agent to monitor your OpenStack environment, and can be deployed on your controller node or an adjacent server that has access to the Keystone, Nova, Neutron, Cinder, Ironic, and Octavia endpoints.

Prepare OpenStack

Create a datadog user that is used in your openstack_controller.d/conf.yaml file. This user requires admin read-only permissions across your environment so that it can be run from a single node and read high level system information about all nodes and servers.

Agent configuration

1. Edit the openstack_controller.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your OpenStack Controller performance data. See the sample openstack_controller.d/conf.yaml for all available configuration options:

   init_config:
   
   instances:
     - keystone_server_url: "<AUTH_URL>"
       password: "<PASSWORD>"
       username: "<USER_NAME>"
       domain_id: "<DOMAIN_ID>"
   

2. Restart the Agent

Note: If you are upgrading the integration to v6.0.0 or later from v5.0.0 or older, you need to enable the use_legacy_check_version flag to use newer features. You may also need to make changes to your configuration to maintain compatibility. See the sample openstack controller.d/conf.yaml for details.

Log collection

1. Collecting logs is disabled by default in the Datadog Agent, you can enable it in datadog.yaml:

   logs_enabled: true
   

2. Add this configuration block to your openstack_controller.d/conf.yaml file to start collecting your Openstack logs:

   logs:
     - type: file
       path: "<LOG_FILE_PATH>"
       source: openstack
   

   Change the path parameter value and configure them for your environment. See the sample openstack_controller.d/conf.yaml for all available configuration options.

Validation

Run the Agent’s status subcommand and look for openstack_controller under the Checks section.

Data Collected

Metrics

Events

OpenStack Controller does not include any events.

Service Checks

openstack.neutron.api.up
Returns CRITICAL if the Agent is unable to query the Neutron API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical, unknown

openstack.nova.api.up
Returns CRITICAL if the Agent is unable to query the Nova API and UNKNOWN if endpoint is not found in the catalog Returns OK otherwise.
Statuses: ok, critical, unknown

openstack.keystone.api.up
Returns CRITICAL if the Agent is unable to query the Keystone API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical

openstack.ironic.api.up
Returns CRITICAL if the Agent is unable to query the Ironic API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical

openstack.cinder.api.up
Returns CRITICAL if the Agent is unable to query the Cinder API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical

openstack.octavia.api.up
Returns CRITICAL if the Agent is unable to query the Octavia API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical

openstack.glance.api.up
Returns CRITICAL if the Agent is unable to query the Glance API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical

openstack.nova.hypervisor.up
Returns UNKNOWN if the Agent is unable to get the Hypervisor state, CRITICAL if the Hypervisor is down. Returns OK otherwise.
Statuses: ok, critical, unknown

openstack.neutron.network.up
Returns UNKNOWN if the Agent is unable to get the Network state, CRITICAL if the Network is down. Returns OK otherwise.
Statuses: ok, critical, unknown

openstack.heat.api.up
Returns CRITICAL if the Agent is unable to query the HEAT API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical

openstack.swift.api.up
Returns CRITICAL if the Agent is unable to query the SWIFT API and UNKNOWN if endpoint is not found in the catalog. Returns OK otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles:

• Monitor your OpenStack components with Datadog