# Statistics reporting

openstacksdk can report statistics on individual API requests/responses in several different formats.

Note that metrics will be reported only when corresponding client libraries (statsd for ‘statsd’ reporting, influxdb for influxdb, etc.). If libraries are not available reporting will be silently ignored.

## statsd

statsd can be configured via configuration entries or environment variables.

A global metrics entry defines defaults for all clouds. Each cloud can specify a metrics section to override variables; this may be useful to separate results reported for each cloud.

    metrics:
      statsd:
        host: __statsd_server_host__
        port: __statsd_server_port__
        prefix: __statsd_prefix__ (default 'openstack.api')
    clouds:
      a-cloud:
        auth:
         ...
        metrics:
          statsd:
            prefix: 'openstack.api.a-cloud'

If the STATSD_HOST or STATSD_PORT environment variables are set, they will be taken as the default values (and enable statsd reporting if no other configuration is specified).

## InfluxDB

InfluxDB is supported via configuration in the metrics field. Similar to statsd, each cloud can provide it’s own metrics section to override any global defaults.

    metrics:
      influxdb:
        host: __influxdb_server_host__
        port: __influxdb_server_port__
        use_udp: __True|False__
        username: __influxdb_auth_username__
        password: __influxdb_auth_password__
        database: __influxdb_db_name__
        measurement: __influxdb_measurement_name__
        timeout: __infludb_requests_timeout__
    clouds:
      ..

InfluxDB reporting allows setting additional tags into the metrics based on the selected cloud.

    clouds:
      my_cloud:
        profile: some_profile
        ...
        additional_metric_tags:
          environment: production

## prometheus

The prometheus support does not read from config, and does not run an http service since OpenstackSDK is a library. It is expected that an application that uses OpenstackSDK and wants request stats be collected will pass a prometheus_client.CollectorRegistry to collector_registry.

this page last updated: 2026-01-16 23:06:19

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.