OpenStack Controller

Supported OS Linux Mac OS Windows

Integration version6.6.0

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

openstack.cinder.cluster.count
(gauge)
Number of cinder clusters
openstack.cinder.cluster.num_down_hosts
(gauge)
Number of cinder cluster hosts down
openstack.cinder.cluster.num_hosts
(gauge)
Number of cinder cluster hosts
openstack.cinder.pool.capabilities.free_capacity_gb
(gauge)
Free capacity for a backend volume
openstack.cinder.pool.capabilities.reserved_percentage
(gauge)
Percentage of CPU use reserved for internal use
Shown as percent
openstack.cinder.pool.capabilities.total_capacity_gb
(gauge)
Total capacity for a backend volume
openstack.cinder.pool.count
(gauge)
Number of cinder pools
openstack.cinder.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to cinder endpoint
Shown as millisecond
openstack.cinder.snapshot.count
(gauge)
Number of cinder snapshots
openstack.cinder.snapshot.size
(gauge)
Size of cinder snapshots
openstack.cinder.volume.count
(gauge)
Number of cinder volumes
openstack.cinder.volume.size
(gauge)
Size of cinder volumes
openstack.cinder.volume.transfer.count
(gauge)
Number of cinder volume transfers
openstack.glance.image.count
(gauge)
Number of public virtual machine images
openstack.glance.image.member.count
(gauge)
Number of members associated with an image
openstack.glance.image.size
(gauge)
Size of image file in bytes
openstack.glance.image.up
(gauge)
Whether a glance image is up
openstack.glance.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to glance endpoint
Shown as millisecond
openstack.heat.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to heat endpoint
Shown as millisecond
openstack.heat.stack.count
(gauge)
Number of public virtual machine stacks
openstack.ironic.allocation.count
(gauge)
Number of ironic allocations
openstack.ironic.conductor.count
(gauge)
Number of ironic conductors
openstack.ironic.conductor.up
(gauge)
Whether an ironic conductor is up
openstack.ironic.driver.count
(gauge)
Number of ironic drivers
openstack.ironic.node.count
(gauge)
Number of ironic nodes
openstack.ironic.node.portgroup.count
(gauge)
Number of portgroups associated with a node
openstack.ironic.node.up
(gauge)
Whether an ironic node is up
openstack.ironic.port.count
(gauge)
Number of ports
openstack.ironic.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to ironic endpoint
Shown as millisecond
openstack.ironic.volume.connector.count
(gauge)
Number of volume connectors
openstack.ironic.volume.target.count
(gauge)
Number of volume targets
openstack.keystone.domain.count
(gauge)
Number of domains of the Openstack deployment
openstack.keystone.domain.enabled
(gauge)
If set to 1 domain is enabled. If set to 0 domain is disabled
openstack.keystone.group.count
(gauge)
Number of groups of the Openstack deployment
openstack.keystone.group.users
(gauge)
Number of users for a group of the Openstack deployment
openstack.keystone.limit.limit
(gauge)
Value of the unified limit for a keystone Openstack resource
openstack.keystone.project.count
(gauge)
Number of projects of the Openstack deployment
openstack.keystone.project.enabled
(gauge)
If set to 1 project is enabled. If set to 0 project is disabled
openstack.keystone.region.count
(gauge)
Number of regions of the Openstack deployment
openstack.keystone.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to keystone endpoint
Shown as millisecond
openstack.keystone.service.count
(gauge)
Number of keystone services of the Openstack deployment
openstack.keystone.service.enabled
(gauge)
If set to 1 service is enabled. If set to 0 service is disabled
openstack.keystone.user.count
(gauge)
Number of users of the Openstack deployment
openstack.keystone.user.enabled
(gauge)
If set to 1 user is enabled. If set to 0 user is disabled
openstack.neutron.agent.admin_state_up
(gauge)
The administrative state of the agent.
openstack.neutron.agent.alive
(gauge)
If the agent is alive and running.
openstack.neutron.agent.count
(gauge)
Number of network agents
openstack.neutron.network.admin_state_up
(gauge)
The administrative state of the network, which is up or down
openstack.neutron.network.count
(gauge)
The total number of networks
openstack.neutron.network.is_default
(gauge)
The network is default pool or not.
openstack.neutron.network.l2_adjacency
(gauge)
Indicates whether L2 connectivity is available throughout the network.
openstack.neutron.network.mtu
(gauge)
The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
openstack.neutron.network.port_security_enabled
(gauge)
The port security status of the network. Valid values are enabled and disabled.
openstack.neutron.network.shared
(gauge)
Indicates whether this network is shared across all tenants. By default, only administrative users can change this value.
openstack.neutron.network.vlan_transparent
(gauge)
Indicates the VLAN transparency mode of the network, which is VLAN transparent or not VLAN transparent.
openstack.neutron.quota.floatingip
(gauge)
The number of floating IP addresses allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.network
(gauge)
The number of networks allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.port
(gauge)
The number of ports allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.rbac_policy
(gauge)
The number of role-based access control (RBAC) policies allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.router
(gauge)
The number of routers allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.security_group
(gauge)
The number of security groups allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.security_group_rule
(gauge)
The number of security group rules allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.subnet
(gauge)
The number of subnets allowed for each project. A value of -1 means no limit.
openstack.neutron.quota.subnetpool
(gauge)
The number of subnet pools allowed for each project. A value of -1 means no limit.
openstack.neutron.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to neutron endpoint
Shown as millisecond
openstack.nova.current_workload
(gauge)
Current workload on the Nova hypervisor [Legacy]
openstack.nova.disk_available_least
(gauge)
Disk available for the Nova hypervisor [Legacy]
Shown as gibibyte
openstack.nova.flavor.disk
(gauge)
The size of the root disk that will be created in GiB.
Shown as gibibyte
openstack.nova.flavor.ram
(gauge)
The amount of RAM a flavor has, in MiB.
Shown as mebibyte
openstack.nova.flavor.rxtx_factor
(gauge)
The receive / transmit factor (as a float) that will be set on ports if the network backend supports the QOS extension.
openstack.nova.flavor.swap
(gauge)
The size of a dedicated swap disk that will be allocated, in MiB. If 0 (the default), no dedicated swap disk will be created.
openstack.nova.flavor.vcpus
(gauge)
The number of virtual CPUs that will be allocated to the server.
Shown as mebibyte
openstack.nova.free_disk_gb
(gauge)
Free disk on the Nova hypervisor [Legacy]
Shown as gibibyte
openstack.nova.free_ram_mb
(gauge)
Free RAM on the Nova hypervisor [Legacy]
Shown as mebibyte
openstack.nova.hypervisor.count
(gauge)
The number of hypervisors
openstack.nova.hypervisor.current_workload
(gauge)
The number of tasks the hypervisor is responsible for
openstack.nova.hypervisor.disk_available_least
(gauge)
The actual free disk on this hypervisor
Shown as gigabyte
openstack.nova.hypervisor.free_disk_gb
(gauge)
The free disk remaining on this hypervisor
Shown as gigabyte
openstack.nova.hypervisor.free_ram_mb
(gauge)
The free RAM in this hypervisor
Shown as megabyte
openstack.nova.hypervisor.load_1
(gauge)
The hypervisor system's 1-minute load average
openstack.nova.hypervisor.load_15
(gauge)
The hypervisor system's 15-minute load average
openstack.nova.hypervisor.load_5
(gauge)
The hypervisor system's 5-minute load average
openstack.nova.hypervisor.local_gb
(gauge)
The disk in this hypervisor
Shown as gigabyte
openstack.nova.hypervisor.local_gb_used
(gauge)
The disk used in this hypervisor
Shown as gigabyte
openstack.nova.hypervisor.memory_mb
(gauge)
The memory of this hypervisor
Shown as megabyte
openstack.nova.hypervisor.memory_mb_used
(gauge)
The memory used in this hypervisor
Shown as megabyte
openstack.nova.hypervisor.running_vms
(gauge)
The number of running VMs on this hypervisor
openstack.nova.hypervisor.up
(gauge)
If set to 1 hypervisor is up. If set to 0 hypervisor is down
openstack.nova.hypervisor.vcpus
(gauge)
The number of vCPU in this hypervisor
openstack.nova.hypervisor.vcpus_used
(gauge)
The number of vCPU used in this hypervisor
openstack.nova.hypervisor_load.1
(gauge)
The average hypervisor load over one minute. [Legacy]
openstack.nova.hypervisor_load.15
(gauge)
The average hypervisor load over fifteen minutes. [Legacy]
openstack.nova.hypervisor_load.5
(gauge)
The average hypervisor load over five minutes. [Legacy]
openstack.nova.limit.absolute.max_image_meta
(gauge)
The number of allowed metadata items for each image
openstack.nova.limit.absolute.max_personality
(gauge)
The number of allowed injected files for each tenant
openstack.nova.limit.absolute.max_personality_size
(gauge)
The number of allowed bytes of content for each injected file
Shown as byte
openstack.nova.limit.absolute.max_security_group_rules
(gauge)
The number of allowed rules for each security group
openstack.nova.limit.absolute.max_security_groups
(gauge)
The number of allowed security groups for each tenant
openstack.nova.limit.absolute.max_server_group_members
(gauge)
The number of allowed members for each server group
openstack.nova.limit.absolute.max_server_groups
(gauge)
The number of allowed server groups for each tenant
openstack.nova.limit.absolute.max_server_meta
(gauge)
The number of allowed metadata items for each server
openstack.nova.limit.absolute.max_total_cores
(gauge)
The number of allowed server cores for each tenant
openstack.nova.limit.absolute.max_total_floating_ips
(gauge)
The number of allowed floating IP addresses for each tenant
openstack.nova.limit.absolute.max_total_instances
(gauge)
The number of allowed servers for each tenant
openstack.nova.limit.absolute.max_total_keypairs
(gauge)
The number of allowed key pairs for each user
openstack.nova.limit.absolute.max_total_ram_size
(gauge)
The amount of allowed server RAM for each tenant
Shown as megabyte
openstack.nova.limit.absolute.total_cores_used
(gauge)
The number of used server cores in each tenant
openstack.nova.limit.absolute.total_floating_ips_used
(gauge)
The number of used floating IP addresses in each tenant
openstack.nova.limit.absolute.total_instances_used
(gauge)
The number of servers in each tenant
openstack.nova.limit.absolute.total_ram_used
(gauge)
The amount of used server RAM in each tenant
Shown as megabyte
openstack.nova.limit.absolute.total_security_groups_used
(gauge)
The number of used security groups in each tenant
openstack.nova.limit.absolute.total_server_groups_used
(gauge)
The number of used server groups in each tenant
openstack.nova.limits.max_image_meta
(gauge)
The maximum allowed image metadata definitions for this tenant [Legacy]
openstack.nova.limits.max_personality
(gauge)
The maximum allowed personalities for this tenant [Legacy]
openstack.nova.limits.max_personality_size
(gauge)
The maximum size of a single personality allowed for this tenant [Legacy]
openstack.nova.limits.max_security_group_rules
(gauge)
The maximum number of security group rules allowed for this tenant [Legacy]
openstack.nova.limits.max_security_groups
(gauge)
The maximum number of security groups allowed for this tenant [Legacy]
openstack.nova.limits.max_server_meta
(gauge)
The maximum allowed service metadata definitions for this tenant [Legacy]
openstack.nova.limits.max_total_cores
(gauge)
The maximum allowed cores for this tenant [Legacy]
openstack.nova.limits.max_total_floating_ips
(gauge)
The maximum allowed floating IPs for this tenant [Legacy]
openstack.nova.limits.max_total_instances
(gauge)
The maximum number of instances allowed for this tenant [Legacy]
openstack.nova.limits.max_total_keypairs
(gauge)
The maximum allowed key pairs allowed for this tenant [Legacy]
openstack.nova.limits.max_total_ram_size
(gauge)
The max allowed RAM size for this tenant in megabytes (MB) [Legacy]
Shown as mebibyte
openstack.nova.limits.total_cores_used
(gauge)
The total cores used by this tenant [Legacy]
openstack.nova.limits.total_floating_ips_used
(gauge)
The total floating IPs used by this tenant [Legacy]
openstack.nova.limits.total_instances_used
(gauge)
The total instances used by this tenant [Legacy]
openstack.nova.limits.total_ram_used
(gauge)
The current RAM used by this tenant in megabytes (MB) [Legacy]
Shown as mebibyte
openstack.nova.limits.total_security_groups_used
(gauge)
The total number of security groups used by this tenant [Legacy]
openstack.nova.local_gb
(gauge)
The size in GB of the ephemeral disk present on this hypervisor host [Legacy]
Shown as gibibyte
openstack.nova.local_gb_used
(gauge)
The size in GB of disk used on this hypervisor host [Legacy]
Shown as gibibyte
openstack.nova.memory_mb
(gauge)
The size in MB of RAM present on this hypervisor host [Legacy]
Shown as mebibyte
openstack.nova.memory_mb_used
(gauge)
The size in MB of RAM used on this hypervisor host [Legacy]
Shown as mebibyte
openstack.nova.quota_set.cores
(gauge)
The number of allowed server cores for each tenant
openstack.nova.quota_set.fixed_ips
(gauge)
The number of allowed fixed IP addresses for each tenant
openstack.nova.quota_set.floating_ips
(gauge)
The number of allowed floating IP addresses for each tenant
openstack.nova.quota_set.injected_file_content_bytes
(gauge)
The number of allowed bytes of content for each injected file
openstack.nova.quota_set.injected_file_path_bytes
(gauge)
The number of allowed bytes for each injected file path
openstack.nova.quota_set.injected_files
(gauge)
The number of allowed injected files for each tenant
openstack.nova.quota_set.instances
(gauge)
The number of allowed servers for each tenant
openstack.nova.quota_set.key_pairs
(gauge)
The number of allowed key pairs for each user
openstack.nova.quota_set.metadata_items
(gauge)
The number of allowed metadata items for each server
openstack.nova.quota_set.ram
(gauge)
The amount of allowed server RAM for each tenant
Shown as megabyte
openstack.nova.quota_set.security_group_rules
(gauge)
The number of allowed rules for each security group
openstack.nova.quota_set.security_groups
(gauge)
The number of allowed security groups for each tenant
openstack.nova.quota_set.server_group_members
(gauge)
The number of allowed members for each server group
openstack.nova.quota_set.server_groups
(gauge)
The number of allowed server groups for each tenant
openstack.nova.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to nova endpoint
Shown as millisecond
openstack.nova.running_vms
(gauge)
Number of running VMs on this hypervisor host [Legacy]
openstack.nova.server.active
(gauge)
If set to 1 server status is active
openstack.nova.server.count
(gauge)
The number of servers in each tenant
openstack.nova.server.cpu0_time
(gauge)
CPU time in nanoseconds of this virtual CPU [Legacy]
Shown as nanosecond
openstack.nova.server.diagnostic.cpu0_time
(gauge)
CPU time in nanoseconds of this virtual CPU [Nova Microversion- default]
Shown as nanosecond
openstack.nova.server.diagnostic.cpu_details.time
(gauge)
CPU Time in nano seconds [Nova Microversion >= 2.48]
Shown as nanosecond
openstack.nova.server.diagnostic.cpu_details.utilisation
(gauge)
CPU utilisation in percents [Nova Microversion >= 2.48]
Shown as percent
openstack.nova.server.diagnostic.disk_details.errors_count
(gauge)
Disk errors [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.disk_details.read_bytes
(gauge)
Disk reads in bytes [Nova Microversion >= 2.48]
Shown as byte
openstack.nova.server.diagnostic.disk_details.read_requests
(gauge)
Read requests [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.disk_details.write_bytes
(gauge)
Disk writes in bytes [Nova Microversion >= 2.48]
Shown as byte
openstack.nova.server.diagnostic.disk_details.write_requests
(gauge)
Write requests [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.memory
(gauge)
The amount of memory in MB provisioned for this server [Nova Microversion- default]
Shown as mebibyte
openstack.nova.server.diagnostic.memory_actual
(gauge)
The amount of memory in MB provisioned for this server [Nova Microversion- default]
Shown as mebibyte
openstack.nova.server.diagnostic.memory_available
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_details.maximum
(gauge)
Amount of memory provisioned for the VM in MiB [Nova Microversion >= 2.48]
Shown as mebibyte
openstack.nova.server.diagnostic.memory_details.used
(gauge)
Amount of memory that is currently used by the guest operating system and its applications in MiB [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.memory_disk_caches
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_hugetlb_pgalloc
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_hugetlb_pgfail
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_last_update
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_major_fault
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_minor_fault
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_rss
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_swap_in
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_swap_out
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_unused
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.memory_usable
(gauge)
[Nova Microversion- default]
openstack.nova.server.diagnostic.nic_details.rx_drop
(gauge)
Received packets dropped [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.rx_errors
(gauge)
Received errors [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.rx_octets
(gauge)
Recieved octects [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.rx_packets
(gauge)
Received packets [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.rx_rate
(gauge)
Recieved rate [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.tx_drop
(gauge)
Transmit dropped packets [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.tx_errors
(gauge)
Transmit errors [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.tx_octets
(gauge)
Transmitted octets [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.tx_packets
(gauge)
Transmit packets [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.nic_details.tx_rate
(gauge)
Transmit rate [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.num_cpus
(gauge)
The number of vCPUs [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.num_disks
(gauge)
The number of disks [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.num_nics
(gauge)
The number of vNICs [Nova Microversion >= 2.48]
openstack.nova.server.diagnostic.rx
(gauge)
Received rate [Nova Microversion- default]
openstack.nova.server.diagnostic.rx_drop
(gauge)
Received packets dropped [Nova Microversion- default]
openstack.nova.server.diagnostic.rx_errors
(gauge)
Received errors [Nova Microversion- default]
openstack.nova.server.diagnostic.rx_packets
(gauge)
Received packets [Nova Microversion- default]
openstack.nova.server.diagnostic.tx
(gauge)
Transmit rate [Nova Microversion- default]
openstack.nova.server.diagnostic.tx_drop
(gauge)
Transmit dropped packets [Nova Microversion- default]
openstack.nova.server.diagnostic.tx_errors
(gauge)
Transmit errors [Nova Microversion- default]
openstack.nova.server.diagnostic.tx_packets
(gauge)
Transmit packets [Nova Microversion- default]
openstack.nova.server.diagnostic.uptime
(gauge)
The amount of time in seconds that the VM has been running [Nova Microversion >= 2.48]
Shown as second
openstack.nova.server.diagnostic.vda_errors
(gauge)
The number of errors seen by the server when accessing a VDA device [Nova Microversion- default]
openstack.nova.server.diagnostic.vda_read
(gauge)
Number of bytes read from a VDA device by this server [Nova Microversion- default]
Shown as byte
openstack.nova.server.diagnostic.vda_read_req
(gauge)
The number of read requests made to a VDA device by this server [Nova Microversion- default]
openstack.nova.server.diagnostic.vda_write
(gauge)
Number of bytes written to a VDA device by this server [Nova Microversion- default]
Shown as byte
openstack.nova.server.diagnostic.vda_write_req
(gauge)
The number of write requests made to a VDA device by this server [Nova Microversion- default]
openstack.nova.server.error
(gauge)
If set to 1 server status is error
openstack.nova.server.flavor.disk
(gauge)
The size of the root disk that was created for this server in GiB
Shown as gibibyte
openstack.nova.server.flavor.ephemeral
(gauge)
The size of the ephemeral disk that was created for this server in GiB
Shown as gibibyte
openstack.nova.server.flavor.os_flv_ext_data_ephemeral
(gauge)
The size of the ephemeral disk that was created
Shown as gigabyte
openstack.nova.server.flavor.ram
(gauge)
The amount of RAM this server flavor has in MiB
Shown as mebibyte
openstack.nova.server.flavor.rxtx_factor
(gauge)
The receive / transmit factor
openstack.nova.server.flavor.swap
(gauge)
The size of a dedicated swap disk that was allocated for this server in MiB
Shown as mebibyte
openstack.nova.server.flavor.vcpus
(gauge)
The number of virtual CPUs that were allocated to the server
openstack.nova.server.hdd_errors
(gauge)
The number of errors seen by the server when accessing an HDD device [Legacy]
openstack.nova.server.hdd_read
(gauge)
Number of bytes read from an HDD device by this server [Legacy]
Shown as byte
openstack.nova.server.hdd_read_req
(gauge)
The number of read requests made to an HDD device by this server [Legacy]
openstack.nova.server.hdd_write
(gauge)
Number of bytes written to an HDD device by this server [Legacy]
Shown as byte
openstack.nova.server.hdd_write_req
(gauge)
The number of write requests made to an HDD device by this server [Legacy]
openstack.nova.server.memory
(gauge)
The amount of memory in MB provisioned for this server [Legacy]
Shown as mebibyte
openstack.nova.server.memory_actual
(gauge)
The amount of memory in MB provisioned for this server [Legacy]
Shown as mebibyte
openstack.nova.server.memory_rss
(gauge)
The amount of memory used by the processes of this server that is not associated with disk pages - such as stack and heap memory [Legacy]
Shown as mebibyte
openstack.nova.server.vda_errors
(gauge)
The number of errors seen by the server when accessing a VDA device [Legacy]
openstack.nova.server.vda_read
(gauge)
Number of bytes read from a VDA device by this server [Legacy]
Shown as byte
openstack.nova.server.vda_read_req
(gauge)
The number of read requests made to a VDA device by this server [Legacy]
openstack.nova.server.vda_write
(gauge)
Number of bytes written to a VDA device by this server [Legacy]
Shown as byte
openstack.nova.server.vda_write_req
(gauge)
The number of write requests made to a VDA device by this server [Legacy]
openstack.nova.service.count
(gauge)
The number of services
openstack.nova.service.up
(gauge)
Whether the service is up
openstack.nova.vcpus
(gauge)
Number of vCPUs available on this hypervisor host [Legacy]
openstack.nova.vcpus_used
(gauge)
Number of vCPUS used on this hypervisor host [Legacy]
openstack.octavia.amphora.count
(gauge)
Number of octavia amphora for each project
openstack.octavia.amphora.stats.active_connections
(gauge)
The currently active amphora connections
openstack.octavia.amphora.stats.bytes_in
(gauge)
The total bytes received
openstack.octavia.amphora.stats.bytes_out
(gauge)
The total bytes sent
openstack.octavia.amphora.stats.request_errors
(gauge)
The total requests that were unable to be fulfilled
openstack.octavia.amphora.stats.total_connections
(gauge)
The total connections handled
openstack.octavia.healthmonitor.admin_state_up
(gauge)
The administrative state of the healthmonitor, which is up or down
openstack.octavia.healthmonitor.count
(gauge)
Number of octavia healthmonitors
openstack.octavia.healthmonitor.delay
(gauge)
The time between sending probes to members
Shown as second
openstack.octavia.healthmonitor.max_retries
(gauge)
The number of successful checks before changing the operating status of the member to ONLINE
openstack.octavia.healthmonitor.max_retries_down
(gauge)
The number of allowed check failures before changing the operating status of the member to ERROR
openstack.octavia.healthmonitor.timeout
(gauge)
The maximum time that a monitor waits to connect before it times out
Shown as second
openstack.octavia.listener.connection_limit
(gauge)
The maximum number of connections permitted for this listener
openstack.octavia.listener.count
(gauge)
Number of octavia listeners
openstack.octavia.listener.stats.active_connections
(gauge)
The currently active listener connections
openstack.octavia.listener.stats.bytes_in
(gauge)
The total bytes received
openstack.octavia.listener.stats.bytes_out
(gauge)
The total bytes sent
openstack.octavia.listener.stats.request_errors
(gauge)
The total requests that were unable to be fulfilled
openstack.octavia.listener.stats.total_connections
(gauge)
The total connections handled
openstack.octavia.listener.timeout_client_data
(gauge)
Frontend client inactivity timeout
Shown as millisecond
openstack.octavia.listener.timeout_member_connect
(gauge)
Backend member connection timeout
Shown as millisecond
openstack.octavia.listener.timeout_member_data
(gauge)
Backend member inactivity timeout
Shown as millisecond
openstack.octavia.listener.timeout_tcp_inspect
(gauge)
Time to wait for additional TCP packets for content inspection
Shown as millisecond
openstack.octavia.loadbalancer.admin_state_up
(gauge)
The administrative state of the loadbalancer, which is up or down
openstack.octavia.loadbalancer.count
(gauge)
Number of octavia loadbalancers
openstack.octavia.loadbalancer.stats.active_connections
(gauge)
The currently active loadbalancer connections
openstack.octavia.loadbalancer.stats.bytes_in
(gauge)
The total bytes received
openstack.octavia.loadbalancer.stats.bytes_out
(gauge)
The total bytes sent
openstack.octavia.loadbalancer.stats.request_errors
(gauge)
The total requests that were unable to be fulfilled
openstack.octavia.loadbalancer.stats.total_connections
(gauge)
The total connections handled
openstack.octavia.pool.admin_state_up
(gauge)
The administrative state of the pool, which is up or down
openstack.octavia.pool.count
(gauge)
Number of octavia pools
openstack.octavia.pool.member.admin_state_up
(gauge)
The administrative state of the pool member, which is up or down
openstack.octavia.pool.member.count
(gauge)
Number of octavia pool members
openstack.octavia.pool.member.weight
(gauge)
The portion of requests or connections it services compared to the other members of the pool
openstack.octavia.quota.count
(gauge)
Number of octavia quotas for each project
openstack.octavia.quota.health_monitor
(gauge)
The configured health monitor quota limit
openstack.octavia.quota.healthmonitor
(gauge)
The configured health monitor quota limit
openstack.octavia.quota.l7policy
(gauge)
The configured l7policy quota limit
openstack.octavia.quota.l7rule
(gauge)
The configured l7rule quota limit
openstack.octavia.quota.listener
(gauge)
The configured listener quota limit
openstack.octavia.quota.load_balancer
(gauge)
The configured load balancer quota limit
openstack.octavia.quota.loadbalancer
(gauge)
The configured load balancer quota limit
openstack.octavia.quota.member
(gauge)
The configured member quota limit
openstack.octavia.quota.pool
(gauge)
The configured pool quota limit
openstack.octavia.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to octavia endpoint
Shown as millisecond
openstack.swift.container.bytes
(gauge)
Number of bytes in a swift container
openstack.swift.container.count
(gauge)
Number of swift containers
openstack.swift.response_time
(gauge)
Duration that an HTTP request takes to complete when making a request to swift endpoint
Shown as millisecond

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: