Documentation Grafana Cloud Monitor infrastructure Grafana integrations Integrations reference Ceph

Ceph integration for Grafana Cloud

Ceph uniquely delivers object, block, and file storage in one unified system.

This integration includes 6 useful alerts and 1 pre-built dashboard to help monitor and visualize Ceph metrics.

Before you begin

In order for the Ceph integration to work, you must enable the built-in Prometheus plugin in your Ceph cluster, with the provided command:

Copy

ceph mgr module enable prometheus

Install Ceph integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Ceph and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Ceph metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboard and alerts to your Grafana Cloud instance, and you can start monitoring your Ceph setup.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a single Ceph instance running locally with default ports.

First, manually copy and append the following snippets into your alloy configuration file.

Metrics snippets

alloy Copy

discovery.relabel "metrics_integrations_integrations_ceph" {
	targets = [{
		__address__  = "cephnode1:9283",
		ceph_cluster = "my-cluster",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_ceph" {
	targets    = discovery.relabel.metrics_integrations_integrations_ceph.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/ceph"
}

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your Ceph instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

alloy Copy

discovery.relabel "metrics_integrations_integrations_ceph" {
	targets = [{
		__address__  = "cephnode1:9283",
		ceph_cluster = "my-cluster",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_ceph" {
	targets    = discovery.relabel.metrics_integrations_integrations_ceph.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/ceph"
}

To monitor your Ceph instance, you must use a discovery.relabel component to discover your Ceph Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within each discovery.relabel component:

• __address__: The address to your Ceph Prometheus metrics endpoint.
• instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Ceph instance.
• ceph_cluster: must be the value that identifies the Ceph cluster this instance belongs to.

If you have multiple Ceph servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Grafana Agent static configuration (deprecated)

The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.

Instructions for Grafana Agent static

Dashboards

The Ceph integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

• Ceph - Cluster

Ceph Cluster

Alerts

The Ceph integration includes the following useful alerts:

Metrics

The most important metrics provided by the Ceph integration, which are used on the pre-built dashboard and Prometheus alerts, are as follows:

• ceph_bluestore_commit_lat_count
• ceph_cluster_total_bytes
• ceph_cluster_total_used_bytes
• ceph_filestore_journal_latency_count
• ceph_health_status
• ceph_mds_metadata
• ceph_mon_metadata
• ceph_mon_num_sessions
• ceph_mon_quorum_status
• ceph_osd_apply_latency_ms
• ceph_osd_commit_latency_ms
• ceph_osd_in
• ceph_osd_metadata
• ceph_osd_numpg
• ceph_osd_op_r
• ceph_osd_op_r_latency_count
• ceph_osd_op_r_latency_sum
• ceph_osd_op_r_out_bytes
• ceph_osd_op_w
• ceph_osd_op_w_in_bytes
• ceph_osd_op_w_latency_count
• ceph_osd_op_w_latency_sum
• ceph_osd_recovery_ops
• ceph_osd_up
• ceph_pg_active
• ceph_pg_backfill
• ceph_pg_backfill_toofull
• ceph_pg_clean
• ceph_pg_creating
• ceph_pg_deep
• ceph_pg_degraded
• ceph_pg_down
• ceph_pg_forced_backfill
• ceph_pg_forced_recovery
• ceph_pg_incomplete
• ceph_pg_inconsistent
• ceph_pg_peered
• ceph_pg_peering
• ceph_pg_recovering
• ceph_pg_remapped
• ceph_pg_repair
• ceph_pg_scrubbing
• ceph_pg_stale
• ceph_pg_undersized
• ceph_pg_wait_backfill
• ceph_pool_metadata
• ceph_pool_num_bytes_recovered
• ceph_pool_num_objects_recovered
• ceph_pool_objects
• ceph_pool_quota_bytes
• ceph_pool_quota_objects
• ceph_rgw_metadata
• ceph_unclean_pgs
• up

Changelog

md Copy

# 1.0.0 - February 2024

* Updated mixin:
  - Replace all Angular panels with React based panels.
  - Address lint issues 

# 0.0.6 - September 2023

* Update Grafana Agent configuration snippets to include filtered metrics used in gauge panels

# 0.0.5 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.4 - September 2022

* Update panels descriptions.

# 0.0.3 - April 2022

* Update mixin to latest version:
  - Removes all cluster variable in favor of `ceph_cluster`
  - Removes `node_exporter` based panels
  - Migrates from graph panel to time series panels
  - Removes panel stacking
  - Fixes `CephUnhealthy` alert - spliting into 2 different alerts with Warning and Critical levels
  - Sets default time threshold to 5m on all alerts

# 0.0.2 - October 2021

*  Update all rate queries to use `$__rate_interval`, so they respect the default resolution

# 0.0.1 - August 2021

* Initial release

Cost

By connecting your Ceph instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.