1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
"""
A simple cluster health alerting module.
"""
from mgr_module import CLIReadCommand, HandleCommandResult, MgrModule, Option
from email.utils import formatdate, make_msgid
from threading import Event
from typing import Any, Optional, Dict, List, TYPE_CHECKING, Union
import json
import smtplib
class Alerts(MgrModule):
MODULE_OPTIONS = [
Option(
name='interval',
type='secs',
default=60,
desc='How frequently to reexamine health status',
runtime=True),
# smtp
Option(
name='smtp_host',
default='',
desc='SMTP server',
runtime=True),
Option(
name='smtp_destination',
default='',
desc='Email address to send alerts to',
runtime=True),
Option(
name='smtp_port',
type='int',
default=465,
desc='SMTP port',
runtime=True),
Option(
name='smtp_ssl',
type='bool',
default=True,
desc='Use SSL to connect to SMTP server',
runtime=True),
Option(
name='smtp_user',
default='',
desc='User to authenticate as',
runtime=True),
Option(
name='smtp_password',
default='',
desc='Password to authenticate with',
runtime=True),
Option(
name='smtp_sender',
default='',
desc='SMTP envelope sender',
runtime=True),
Option(
name='smtp_from_name',
default='Ceph',
desc='Email From: name',
runtime=True)
]
# These are "native" Ceph options that this module cares about.
NATIVE_OPTIONS: List[str] = [
]
def __init__(self, *args: Any, **kwargs: Any) -> None:
super(Alerts, self).__init__(*args, **kwargs)
# set up some members to enable the serve() method and shutdown()
self.run = True
self.event = Event()
# ensure config options members are initialized; see config_notify()
self.config_notify()
self.log.info("Init")
if TYPE_CHECKING:
self.interval = 60
self.smtp_host = ''
self.smtp_destination = ''
self.smtp_port = 0
self.smtp_ssl = True
self.smtp_user = ''
self.smtp_password = ''
self.smtp_sender = ''
self.smtp_from_name = ''
def config_notify(self) -> None:
"""
This method is called whenever one of our config options is changed.
"""
# This is some boilerplate that stores MODULE_OPTIONS in a class
# member, so that, for instance, the 'emphatic' option is always
# available as 'self.emphatic'.
for opt in self.MODULE_OPTIONS:
setattr(self,
opt['name'],
self.get_module_option(opt['name']))
self.log.debug(' mgr option %s = %s',
opt['name'], getattr(self, opt['name']))
# Do the same for the native options.
for opt in self.NATIVE_OPTIONS:
setattr(self,
opt,
self.get_ceph_option(opt))
self.log.debug(' native option %s = %s', opt, getattr(self, opt))
@CLIReadCommand('alerts send')
def send(self) -> HandleCommandResult:
"""
(re)send alerts immediately
"""
status = json.loads(self.get('health')['json'])
self._send_alert(status, {})
return HandleCommandResult()
def _diff(self, last: Dict[str, Any], new: Dict[str, Any]) -> Dict[str, Any]:
d: Dict[str, Any] = {}
for code, alert in new.get('checks', {}).items():
self.log.debug('new code %s alert %s' % (code, alert))
if code not in last.get('checks', {}):
if 'new' not in d:
d['new'] = {}
d['new'][code] = alert
elif (alert['summary'].get('count', 0)
> last['checks'][code]['summary'].get('count', 0)):
if 'updated' not in d:
d['updated'] = {}
d['updated'][code] = alert
for code, alert in last.get('checks', {}).items():
self.log.debug('old code %s alert %s' % (code, alert))
if code not in new.get('checks', {}):
if 'cleared' not in d:
d['cleared'] = {}
d['cleared'][code] = alert
return d
def _send_alert(self, status: Dict[str, Any], diff: Dict[str, Any]) -> None:
checks = {}
if self.smtp_host:
r = self._send_alert_smtp(status, diff)
if r:
for code, alert in r.items():
checks[code] = alert
else:
self.log.warning('Alert is not sent because smtp_host is not configured')
self.set_health_checks(checks)
def serve(self) -> None:
"""
This method is called by the mgr when the module starts and can be
used for any background activity.
"""
self.log.info("Starting")
last_status: Dict[str, Any] = {}
while self.run:
# Do some useful background work here.
new_status = json.loads(self.get('health')['json'])
if new_status != last_status:
self.log.debug('last_status %s' % last_status)
self.log.debug('new_status %s' % new_status)
diff = self._diff(last_status,
new_status)
self.log.debug('diff %s' % diff)
if diff:
self._send_alert(new_status, diff)
last_status = new_status
self.log.debug('Sleeping for %s seconds', self.interval)
self.event.wait(self.interval or 60)
self.event.clear()
def shutdown(self) -> None:
"""
This method is called by the mgr when the module needs to shut
down (i.e., when the serve() function needs to exit).
"""
self.log.info('Stopping')
self.run = False
self.event.set()
# SMTP
def _smtp_format_alert(self, code: str, alert: Dict[str, Any]) -> str:
r = '[{sev}] {code}: {summary}\n'.format(
code=code,
sev=alert['severity'].split('_')[1],
summary=alert['summary']['message'])
for detail in alert['detail']:
r += ' {message}\n'.format(
message=detail['message'])
return r
def _send_alert_smtp(self,
status: Dict[str, Any],
diff: Dict[str, Any]) -> Optional[Dict[str, Any]]:
# message
self.log.debug('_send_alert_smtp')
message = ('From: {from_name} <{sender}>\n'
'Subject: {status}\n'
'To: {target}\n'
'Message-Id: {message_id}\n'
'Date: {date}\n'
'\n'
'{status}\n'.format(
sender=self.smtp_sender,
from_name=self.smtp_from_name,
status=status['status'],
target=self.smtp_destination,
message_id=make_msgid(),
date=formatdate()))
if 'new' in diff:
message += ('\n--- New ---\n')
for code, alert in diff['new'].items():
message += self._smtp_format_alert(code, alert)
if 'updated' in diff:
message += ('\n--- Updated ---\n')
for code, alert in diff['updated'].items():
message += self._smtp_format_alert(code, alert)
if 'cleared' in diff:
message += ('\n--- Cleared ---\n')
for code, alert in diff['cleared'].items():
message += self._smtp_format_alert(code, alert)
message += ('\n\n=== Full health status ===\n')
for code, alert in status['checks'].items():
message += self._smtp_format_alert(code, alert)
self.log.debug('message: %s' % message)
# send
try:
if self.smtp_ssl:
server: Union[smtplib.SMTP_SSL, smtplib.SMTP] = \
smtplib.SMTP_SSL(self.smtp_host, self.smtp_port)
else:
server = smtplib.SMTP(self.smtp_host, self.smtp_port)
if self.smtp_password:
server.login(self.smtp_user, self.smtp_password)
server.sendmail(self.smtp_sender, self.smtp_destination, message)
server.quit()
except Exception as e:
return {
'ALERTS_SMTP_ERROR': {
'severity': 'warning',
'summary': 'unable to send alert email',
'count': 1,
'detail': [str(e)]
}
}
self.log.debug('Sent email to %s' % self.smtp_destination)
return None
|
