OpenStack

Agent Check

Overview

Get metrics from OpenStack service in real time to:

• Visualize and monitor OpenStack states.
• Be notified about OpenStack failovers and events.

Setup

Installation

To capture your OpenStack metrics, install the Agent on your hosts running hypervisors.

Configuration

Prepare OpenStack

Configure a Datadog role and user with your identity server:

openstack role create datadog_monitoring
openstack user create datadog \
    --password my_password \
    --project my_project_name
openstack role add datadog_monitoring \
    --project my_project_name \
    --user datadog

Then, update your policy.json files to grant the needed permissions. role:datadog_monitoring requires access to the following operations:

Nova

{
  "compute_extension": "aggregates",
  "compute_extension": "hypervisors",
  "compute_extension": "server_diagnostics",
  "compute_extension": "v3:os-hypervisors",
  "compute_extension": "v3:os-server-diagnostics",
  "compute_extension": "availability_zone:detail",
  "compute_extension": "v3:availability_zone:detail",
  "compute_extension": "used_limits_for_admin",
  "os_compute_api:os-aggregates:index": "rule:admin_api or role:datadog_monitoring",
  "os_compute_api:os-aggregates:show": "rule:admin_api or role:datadog_monitoring",
  "os_compute_api:os-hypervisors": "rule:admin_api or role:datadog_monitoring",
  "os_compute_api:os-server-diagnostics": "rule:admin_api or role:datadog_monitoring",
  "os_compute_api:os-used-limits": "rule:admin_api or role:datadog_monitoring"
}

Neutron

{
  "get_network": "rule:admin_or_owner or rule:shared or rule:external or rule:context_is_advsvc or role:datadog_monitoring"
}

Keystone

{
  "identity:get_project": "rule:admin_required or project_id:%(target.project.id)s or role:datadog_monitoring",
  "identity:list_projects": "rule:admin_required or role:datadog_monitoring"
}

You may need to restart your Keystone, Neutron, and Nova API services to ensure that the policy changes take.

Note: Installing the OpenStack integration could increase the number of VMs that Datadog monitors. For more information on how this may affect your billing, visit the Billing FAQ.

Agent configuration

1. Configure the Datadog Agent to connect to your Keystone server, and specify individual projects to monitor. Edit the openstack.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory with the configuration below. See the sample openstack.d/conf.yaml for all available configuration options:

   init_config:
     ## @param keystone_server_url - string - required
     ## Where your identity server lives.
     ## Note that the server must support Identity API v3
     #
     keystone_server_url: "https://<KEYSTONE_SERVER_ENDPOINT>:<PORT>/"
   
   instances:
     ## @param name - string - required
     ## Unique identifier for this instance.
     #
     - name: "<INSTANCE_NAME>"
   
       ## @param user - object - required
       ## User credentials
       ## Password authentication is the only auth method supported.
       ## `user` object expects the parameter `username`, `password`,
       ## and `user.domain.id`.
       ##
       ## `user` should resolve to a structure like:
       ##
       ##  {'password': '<PASSWORD>', 'name': '<USERNAME>', 'domain': {'id': '<DOMAINE_ID>'}}
       #
       user:
         password: "<PASSWORD>"
         name: datadog
         domain:
           id: "<DOMAINE_ID>"
   

2. Restart the Agent.

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.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.d/conf.yaml for all available configuration options.

Validation

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

Data Collected

Metrics

Events

The OpenStack check does not include any events.

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.
Statuses: ok, critical, unknown

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.
Statuses: ok, critical, unknown

openstack.keystone.api.up
Returns CRITICAL if the Agent is unable to query the Keystone API. 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

Troubleshooting

Need help? Contact Datadog support.

Further Reading

To get a better idea of how (or why) to integrate your Nova OpenStack compute module with Datadog, check out Datadog’s series of blog posts about it.

See also these other Datadog blog posts:

• Install OpenStack in two commands for dev and test
• OpenStack: host aggregates, flavors, and availability zones