Ceph metrics

The OpenTelemetry Collector, when configured with a Prometheus receiver, provides an integration with Ceph to scrape Prometheus metrics. The Collector uses the Prometheus Receiver to fetch metrics from the configured path in the Ceph configuration file. From there, the metrics are processed and exported to Cloud Observability.

To complete the integration, you will:

  • Configure Ceph to use the Prometheus exporter.
  • Configure the Collector to use the Ceph endpoint as a scrape target for the Prometheus receiver.
  • Enable the integration by adding it to a pipeline.

Prerequisites

  • Ceph v13.2.5 or later
  • You’ve configured the Collector to export metric data to Cloud Observability.

Configure Ceph reporting

You need to configure Ceph to use the Prometheus exporter.

  1. Enable Prometheus in Ceph. 
    1

    sudo ceph mgr module enable prometheus

    OR

    1

    docker exec mon1 ceph --cluster ceph mgr module enable prometheus
  2. Configure the Ceph server port and listener address. 
    1
2

    $ sudo ceph config set mgr mgr/prometheus/server_addr 0.0.0.0
$ sudo ceph config set mgr mgr/prometheus/server_port 9283

    By default the module will accept HTTP requests on port 9283 on all IPv4 and IPv6 addresses on the host

  3. Restart the Prometheus manager module for configuration changes to take effect.

For more details about using Ceph with the Prometheus exporter, see the official Ceph documentation.

Configure the Collector receiver

In the Collector configuration file, configure the Prometheus receiver to use the Ceph Prometheus endpoint as a scrape target.

1
2
3
4
5
6
7
8
9

receivers:
  prometheus:
      config:
        scrape_configs:
          - job_name: 'ceph-mgr'
            scrape_interval: 15s
            metrics_path: '/metrics'
            static_configs:
              - targets: ['localhost:9283']

The OpenTelemetry repo’s README provides additional details about Prometheus receiver configuration.

More details about the Prometheus scrape configuration can be found here.

Enable the Collector receiver

Once the Ceph receiver is configured, enable it by adding it to one or more pipelines as described in the Collector configuration documentation.

Validate metrics are reporting to Cloud Observability

You can validate that metrics are reporting to Cloud Observability on the Metrics details page in Settings.

  1. In Cloud Observability, click Settings > Metric details.

  2. Search for Ceph metric names. Search for metric

    See Ceph documentation for a complete list of emitted metrics.

  3. If needed, click on the metric to edit the description and how the units are displayed in Cloud Observability.

Create a dashboard for the metrics

Use the Cloud Observability Terraform Provider to create a dashboard for the metrics.

Additional resources

For a more complete example that’s ready to run, see the Ceph integration in Cloud Observability OpenTelemetry Examples.

See also

Create and manage dashboards

Updated Dec 1, 2022