Openstack_controller

Agent Check

Overview

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 and Nova 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:
     ## @param name - string - required
     ## Unique identifier for this instance.
     #
     - name: "<INSTANCE_NAME>"
   
       ## @param user - object - required
       ## Password authentication is the only auth method supported
       ## User expects username, password, and user domain id
       ## `user` should resolve to a structure like
       ## {'password': '<PASSWORD>', 'name': '<USER_NAME>', 'domain': {'id': '<DOMAIN_ID>'}}
       ## The check uses the Unscoped token method to collect information about
       ## all available projects to the user.
       #
       user:
         password: "<PASSWORD>"
         name: "<USER_NAME>"
         domain:
           id: "<DOMAIN_ID>"
   

2. Restart the Agent

Validation

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

Data Collected

Metrics

Service Checks

openstack.neutron.api.up:
Returns CRITICAL if the Agent is unable to query the Neutron API, UNKNOWN if there is an issue with the Keystone API. Returns OK otherwise.

openstack.nova.api.up:
Returns CRITICAL if the Agent is unable to query the Nova API, UNKNOWN if there is an issue with the Keystone API. Returns OK otherwise.

openstack.keystone.api.up:
Returns CRITICAL if the Agent is unable to query the Keystone API. Returns OK otherwise.

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.

openstack.neutron.network.up:
Returns CRITICAL if the Network is down. Returns OK otherwise.

Events

OpenStack Controller does not include any events.

Troubleshooting

Need help? Contact Datadog support.