@@ -2,58 +2,74 @@ Alerts module
22=============
33
44The alerts module can send simple alert messages about cluster health
5- via e-mail. In the future, it will support other notification methods
5+ via e-mail. In the future, it will support other notification methods
66as well.
77
88:note: This module is *not * intended to be a robust monitoring
9- solution. The fact that it is run as part of the Ceph cluster
9+ solution. The fact that it is run as part of the Ceph cluster
1010 itself is fundamentally limiting in that a failure of the
11- ceph-mgr daemon prevents alerts from being sent. This module
11+ `` ceph-mgr `` daemon prevents alerts from being sent. This module
1212 can, however, be useful for standalone clusters that exist in
13- environments where existing monitoring infrastructure does not
13+ environments where other monitoring infrastructure does not
1414 exist.
1515
1616Enabling
1717--------
1818
19- The * alerts * module is enabled with: :
19+ Enable the `` alerts `` module by running the following command :
2020
21- ceph mgr module enable alerts
21+ .. prompt :: bash #
22+
23+ ceph mgr module enable alerts
2224
2325Configuration
2426-------------
2527
26- To configure SMTP, all of the following config options must be set
27- (When setting ``mgr/alerts/smtp_destination ``, you can use commas to separate multiple)::
28+ All of the following config options must be set when configuring SMTP. When
29+ setting ``mgr/alerts/smtp_destination ``, specify multiple email addresses by
30+ separating them with commas.
31+
32+ .. prompt :: bash #
33+
34+ ceph config set mgr mgr/alerts/smtp_host *<smtp-server> *
35+ ceph config set mgr mgr/alerts/smtp_destination *<email-address-to-send-to> *
36+ ceph config set mgr mgr/alerts/smtp_sender *<from-email-address> *
37+
38+ The alerts module uses SSL and port 465 by default. These settings can be changed by running commands of the following forms:
2839
29- ceph config set mgr mgr/alerts/smtp_host *<smtp-server>*
30- ceph config set mgr mgr/alerts/smtp_destination *<email-address-to-send-to>*
31- ceph config set mgr mgr/alerts/smtp_sender *<from-email-address>*
40+ .. prompt :: bash #
3241
33- By default, the module will use SSL and port 465. To change that,::
42+ ceph config set mgr mgr/alerts/smtp_ssl false # if not SSL
43+ ceph config set mgr mgr/alerts/smtp_port *<port-number> * # if not 465
3444
35- ceph config set mgr mgr/alerts/smtp_ssl false # if not SSL
36- ceph config set mgr mgr/alerts/smtp_port *<port-number>* # if not 465
45+ To authenticate to the SMTP server, you must set the user and password:
3746
38- To authenticate to the SMTP server, you must set the user and password::
47+ .. prompt :: bash #
3948
40- ceph config set mgr mgr/alerts/smtp_user *<username>*
41- ceph config set mgr mgr/alerts/smtp_password *<password>*
49+ ceph config set mgr mgr/alerts/smtp_user *<username> *
50+ ceph config set mgr mgr/alerts/smtp_password *<password> *
4251
43- By default, the name in the ``From: `` line is simply ``Ceph ``. To
44- change that (e.g., to identify which cluster this is),::
52+ By default, the name in the ``From: `` line is simply ``Ceph ``. To change this
53+ default (that is, to identify which cluster this is), run a command of the
54+ following form:
4555
46- ceph config set mgr mgr/alerts/smtp_from_name 'Ceph Cluster Foo'
56+ .. prompt :: bash #
4757
48- By default, the module will check the cluster health once per minute
49- and, if there is a change, send a message. To change that
50- frequency,::
58+ ceph config set mgr mgr/alerts/smtp_from_name 'Ceph Cluster Foo'
5159
52- ceph config set mgr mgr/alerts/interval *<interval>* # e.g., "5m" for 5 minutes
60+ By default, the alert module checks the cluster health once per minute and
61+ sends a message if there a change to the cluster's health status. Change the
62+ frequency of the alert module's cluster health checks by running a command of the following form:
63+
64+ .. prompt :: bash #
65+
66+ ceph config set mgr mgr/alerts/interval *<interval> * # e.g., "5m" for 5 minutes
5367
5468Commands
5569--------
5670
57- To force an alert to be send immediately,::
71+ To force an alert to be sent immediately, run the following command:
72+
73+ .. prompt :: bash #
5874
59- ceph alerts send
75+ ceph alerts send
0 commit comments