Skip to main content

Ceph

Plugin: go.d.plugin Module: ceph

Overview

This collector monitors the overall health status and performance of your Ceph clusters. It gathers key metrics for the entire cluster, individual Pools, and OSDs.

It collects metrics by periodically issuing HTTP GET requests to the Ceph Manager RESP API:

This collector is only supported on the following platforms:

  • Linux

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

The collector can automatically detect Ceph Manager instances running on:

  • localhost that are listening on port 8443
  • within Docker containers

Note that the Ceph RESP API requires a username and password. While Netdata can automatically detect Ceph Manager instances and create data collection jobs, these jobs will fail unless you provide the necessary credentials.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per cluster

These metrics refer to the entire Ceph cluster.

Labels:

LabelDescription
fsidA unique identifier of the cluster.

Metrics:

MetricDimensionsUnit
ceph.cluster_statusok, err, warnstatus
ceph.cluster_hosts_counthostshosts
ceph.cluster_monitors_countmonitorsmonitors
ceph.cluster_osds_countosdsosds
ceph.cluster_osds_by_status_countup, down, in, outstatus
ceph.cluster_managers_countactive, standbymanagers
ceph.cluster_object_gateways_countobjectgateways
ceph.cluster_iscsi_gateways_countiscsigateways
ceph.cluster_iscsi_gateways_by_status_countup, downgateways
ceph.cluster_physical_capacity_utilizationutilizationpercent
ceph.cluster_physical_capacity_usageavail, usedbytes
ceph.cluster_objects_countobjectsobjects
ceph.cluster_objects_by_status_distributionhealthy, misplaced, degraded, unfoundpercent
ceph.cluster_pools_countpoolspools
ceph.cluster_pgs_countpgspgs
ceph.cluster_pgs_by_status_countclean, working, warning, unknownpgs
ceph.cluster_pgs_per_osd_countper_osdpgs

Per osd

These metrics refer to the Object Storage Daemon (OSD).

Labels:

LabelDescription
fsidA unique identifier of the cluster.
osd_uuidOSD UUID.
osd_nameOSD name.
device_classOSD device class.

Metrics:

MetricDimensionsUnit
ceph.osd_statusup, down, in, outstatus
ceph.osd_space_usageavail, usedbytes
ceph.osd_ioread, writtenbytes/s
ceph.osd_iopsread, writeops/s
ceph.osd_latencycommit, applymilliseconds

Per pool

These metrics refer to the Pool.

Labels:

LabelDescription
fsidA unique identifier of the cluster.
pool_namePool name.

Metrics:

MetricDimensionsUnit
ceph.pool_space_utilizationutilizationpercent
ceph.pool_space_usageavail, usedbytes
ceph.pool_objects_countobjectobjects
ceph.pool_ioread, writtenbytes/s
ceph.pool_iopsread, writeops/s

Alerts

The following alerts are available:

Alert nameOn metricDescription
ceph_cluster_physical_capacity_utilization ceph.cluster_physical_capacity_utilizationCeph cluster ${label:fsid} disk space utilization

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/ceph.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/ceph.conf

Options

The following options can be defined globally: update_every.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlThe URL of the Ceph Manager API.https://127.0.0.1:8443yes
timeoutHTTP request timeout.2no
usernameUsername for basic HTTP authentication.yes
passwordPassword for basic HTTP authentication.yes
proxy_urlProxy URL.no
proxy_usernameUsername for proxy basic HTTP authentication.no
proxy_passwordPassword for proxy basic HTTP authentication.no
methodHTTP request method.GETno
bodyHTTP request body.no
headersHTTP request headers.no
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.nono
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.yesno
tls_caCertification authority that the client uses when verifying the server's certificates.no
tls_certClient TLS certificate.no
tls_keyClient TLS key.no

Examples

Basic

A basic example configuration.

jobs:
- name: local
url: https://127.0.0.1:8443
username: user
password: pass

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

jobs:
- name: local
url: https://127.0.0.1:8443
username: user
password: pass

- name: remote
url: https://192.0.2.1:8443
username: user
password: pass

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the ceph collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m ceph

Getting Logs

If you're encountering problems with the ceph collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep ceph

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep ceph /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep ceph

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.