Notice

This document is for a development version of Ceph.

Alerts module

The alerts module can send simple alert messages about cluster health via e-mail. In the future, it will support other notification methods as well.

note:

This module is not intended to be a robust monitoring solution. The fact that it is run as part of the Ceph cluster itself is fundamentally limiting in that a failure of the ceph-mgr daemon prevents alerts from being sent. This module can, however, be useful for standalone clusters that exist in environments where other monitoring infrastructure does not exist.

Enabling

Enable the alerts module by running the following command:

ceph mgr module enable alerts

Configuration

All of the following config options must be set when configuring SMTP. When setting mgr/alerts/smtp_destination, specify multiple email addresses by separating them with commas.

ceph config set mgr mgr/alerts/smtp_host *<smtp-server>*
ceph config set mgr mgr/alerts/smtp_destination *<email-address-to-send-to>*
ceph config set mgr mgr/alerts/smtp_sender *<from-email-address>*

The alerts module uses SSL and port 465 by default. These settings can be changed by running commands of the following forms:

ceph config set mgr mgr/alerts/smtp_ssl false   # if not SSL
ceph config set mgr mgr/alerts/smtp_port *<port-number>*  # if not 465

To authenticate to the SMTP server, you must set the user and password:

ceph config set mgr mgr/alerts/smtp_user *<username>*
ceph config set mgr mgr/alerts/smtp_password *<password>*

By default, the name in the From: line is simply Ceph. To change this default (that is, to identify which cluster this is), run a command of the following form:

ceph config set mgr mgr/alerts/smtp_from_name 'Ceph Cluster Foo'

By default, the alert module checks the cluster health once per minute and sends a message if there a change to the cluster’s health status. Change the frequency of the alert module’s cluster health checks by running a command of the following form:

ceph config set mgr mgr/alerts/interval *<interval>*   # e.g., "5m" for 5 minutes

Commands

To force an alert to be sent immediately, run the following command:

ceph alerts send

Brought to you by the Ceph Foundation

The Ceph Documentation is a community resource funded and hosted by the non-profit Ceph Foundation. If you would like to support this and our other efforts, please consider joining now.