-
Notifications
You must be signed in to change notification settings - Fork 16
/
summarisinglogger.txt
603 lines (506 loc) · 19.3 KB
/
summarisinglogger.txt
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
SummarisingLogger
=================
.. note::
Throughout the examples below, mail messages sent using
:mod:`smtplib` are printed to the screen so we can see what's going on:
>>> import smtplib
>>> server = smtplib.SMTP('localhost')
>>> server.sendmail('from@example.com', ['to@example.com'], 'The message')
sending to ['to@example.com'] from 'from@example.com' using ('localhost', 25)
The message
.. currentmodule:: mailinglogger
:class:`SummarisingLogger` is a handler for the python logging
framework that accumulates log entries and sends a single email
containing all the log entries using an SMTP server when its
:meth:`~SummarisingLogger.close` method is called.
This :meth:`~SummarisingLogger.close` method is, by default,
registered as an :mod:`atexit` function so that the summary mail will
get sent regardless of whether an explicit call is made to the
:meth:`SummarisingLogger.close` method.
:class:`SummarisingLogger` handlers can be very useful for batch
processes that are frequently run and where people would like an email
summary of how the batch run went.
They are configured as any other :mod:`logging` handler would be, full
details of which can be found in the `Python core
documentation`__. For the examples below, we'll stick to manually
configuring the logging elements.
__ http://docs.python.org/howto/logging.html#configuring-logging
A :class:`SummarisingLogger` is instantiated as follows:
>>> import logging
>>> from mailinglogger import SummarisingLogger
>>> handler = SummarisingLogger('from@example.com',('to@example.com',))
It can then be added as a handler for any logger as follows:
>>> import logging
>>> logger = logging.getLogger()
>>> logger.addHandler(handler)
.. invisible-code-block: python
logger.setLevel(logging.WARNING)
handler.setLevel(logging.WARNING)
However, when we log a message, nothing appears to happen:
>>> logging.debug('some debugging')
>>> logging.info('some information')
>>> logging.warning('a warning')
>>> logging.error('my message')
This is because the messages have been recorded and will be sent as
a summary when the logging framework is shut down or, by default,
when the script that calls the logging function exits.
If we manually close our log handler, we can see the mail gets sent:
>>> handler.close()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
a warning
my message
<BLANKLINE>
The logging on script exit is done using python's :mod:`atexit`
module. Here's the handler registered above:
>>> print(atexit_handlers)
[<bound method SummarisingLogger.close of <...>>]
.. invisible-code-block: python
atexit_handlers[:] = []
Now, to continue with the examples, just like any other handler, we
can also set the logging level, which will filter out messages logged
below the level set:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',))
>>> logger.addHandler(handler)
>>> handler.setLevel(logging.CRITICAL)
>>> logging.error('an error')
>>> handler.setLevel(logging.WARNING)
>>> logging.warning('a warning')
>>> handler.close()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (WARNING)
To: to@example.com
X-Log-Level: WARNING
X-Mailer: MailingLogger...
<BLANKLINE>
a warning
<BLANKLINE>
As with :class:`MailingLogger`, you can see from the above examples
that :class:`SummarisingLogger` sends mail messages that are correctly
formatted, including ``Date`` and ``Message-ID`` headers.
You will also notice that an ``X-Mailer`` header has been added
specifying that :mod:`mailinglogger` is the sender of the mail.
An ``X-Log-Level`` header has also been added indicating the highest
level message that has been handled by the :class:`SummarisingLogger`.
These headers can be useful for filtering mail
sent by :class:`MailingLogger`. If you wish to filter mail by
environment or other configuration data, the support for adding
:ref:`extra headers <sum_extra_headers>` may be useful.
Avoiding the :mod:`atexit` handler
----------------------------------
.. invisible-code-block: python
atexit_handlers[:] = []
In the event you wish to manually call the
:meth:`~SummarisingLogger.close` method of the handler or use the
logging framework's :func:`~logging.shutdown` functionality rather
than registering an :mod:`atexit` function, you can create a
:class:`SummarisingLogger` and specify that no :mod:`atexit` function
should be registered:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... atexit=False)
>>> logger.addHandler(handler)
Now, we can see that no :mod:`atexit` function has been registered:
>>> print(atexit_handlers)
[]
With this configuration, if an entry is logged, the logging
framework must be manually shut down for the mail to be sent:
>>> logging.error('my message')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
my message
<BLANKLINE>
Because the users of :class:`SummarisingLogger` may not have control
over when or how often the logging handlers they configure are closed,
a :class:`SummarisingLogger` will not raise exceptions and will not
send duplicate emails if closed more than once:
>>> handler.close()
Likewise, messages logged to the handler after it has been closed
will not result in errors but will also not result in emails being
sent:
>>> logging.error('my message')
Controlling the subject line
----------------------------
The subject for the summary mail sent is controlled by the `subject`
parameter to the :class:`SummarisingLogger` parameter.
This can be set to a fixed value:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... subject='My Logging Summary')
>>> logger.addHandler(handler)
>>> logging.error('a message')
>>> handler.close()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: My Logging Summary
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
a message
<BLANKLINE>
It can also be set using any of the substitution variables described
in the :doc:`subjectformatter` documentation, for example:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... subject='[%(hostname)s] %(levelname)s - %(line)s')
>>> logger.setLevel(logging.INFO)
>>> logger.addHandler(handler)
>>> logging.info('a message')
>>> logging.error('an error')
>>> handler.close()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: [host.example.com] ERROR - a message
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
a message
an error
<BLANKLINE>
You'll notice that the ``%(line)`` substitution inserts the first line
of the whole summary mail when used with a :class:`SummarisingLogger`.
You'll also notice that the ``%(levelname)`` substitution inserts the
name of the highest level logged while the :class:`SummarisingLogger`
was active.
If no messages have been handled by the logger, then ``%(levelname)s``
will be the string ``NOTSET``:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... subject='[%(levelname)s] summary')
>>> logger.addHandler(handler)
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: [NOTSET] summary
To: to@example.com
X-Log-Level: NOTSET
X-Mailer: MailingLogger...
<BLANKLINE>
<BLANKLINE>
Formatting messages in the body of the summary email
----------------------------------------------------
You may also be wondering how you control the formatting of the
messages included in the summary email. This is done using the
standard :meth:`~logging.Handler.setFormatter` method of python log
handlers.
Here's an example:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',))
>>> handler.setFormatter(logging.Formatter('%(asctime)s [%(levelname)s] %(message)s'))
>>> logger.addHandler(handler)
To show things working, some entries need to be logged. Here's one at
``2007-01-01 10:00:00``:
..
>>> time.set(2007, 1, 1, 10)
>>> logging.warning('something happened')
Here's another at ``2007-01-01 12:34:56``:
..
>>> time.set(2007, 1, 1, 12, 34, 56)
>>> try:
... raise RuntimeError('badness')
... except:
... logging.error('bad things happened',exc_info=True)
The following shows the mail that would be sent:
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
2007-01-01 10:00:00,000 [WARNING] something happened
2007-01-01 12:34:56,000 [ERROR] bad things happened
Traceback (most recent call last):
...
RuntimeError: badness
<BLANKLINE>
.. _record-and-send-different:
Recording and sending at different levels
-----------------------------------------
In some circumstances, you may want to send a summary email when a
certain log level is reached but, when the summary is sent, you want
the summary to include logging at a lower level. To do this, you would
pass a ``send_level`` to the :class:`SummarisingLogger` constructor:
>>> handler = SummarisingLogger('from@example.com', ('to@example.com',),
... send_level=logging.ERROR)
>>> handler.setFormatter(logging.Formatter('%(asctime)s [%(levelname)s] %(message)s'))
>>> logger.addHandler(handler)
>>> logging.info('An info message')
>>> logging.error('Something bad happened')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: Mon, 01 Jan 2007 12:34:56 -0000
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
2007-01-01 12:34:56,000 [INFO] An info message
2007-01-01 12:34:56,000 [ERROR] Something bad happened
<BLANKLINE>
Limiting the size of emails
---------------------------
All good MTAs will limit the size of message that they will accept. If
your script logs an unexpectedly large number of messages, such as
when something goes catastrophically wrong, this may result in no email
notification being sent.
More commonly, if you're trying to read a summary email on a mobile
device, any more than a hundred lines or so will likely be difficult
to read and may not even render.
To prevent these problems, :class:`SummarisingLogger` allows a limit
on the number of lines that will be included in the summary email.
By default, this is set to 100 messages but can be overridden by passing
the `flood_level` option to the :class:`SummarisingLogger`
constructor:
>>> handler = SummarisingLogger('from@example.com', ('to@example.com',),
... flood_level=2)
>>> handler.setFormatter(logging.Formatter('%(levelname)s - %(message)s'))
>>> logger.addHandler(handler)
>>> logging.info('message 1')
>>> logging.info('message 2')
>>> logging.error('message 3')
>>> logging.info('message 4')
>>> logging.info('message 5')
>>> logging.info('message 6')
>>> logging.info('message 7')
>>> logging.info('message 8')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: Mon, 01 Jan 2007 12:34:56 -0000
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
INFO - message 1
INFO - message 2
CRITICAL - 1 messages not included as flood limit of 2 exceeded
INFO - message 4
INFO - message 5
INFO - message 6
INFO - message 7
INFO - message 8
<BLANKLINE>
The example above shows a few things. Firstly, when messages are
excluded, a ``CRITICAL`` entry is logged with the number of messages
that have been excluded. Secondly, excluded messages still contribute
to the highest level logged used in both the subject and the
``X-Log-Level`` header. Finally, the last 5 messages logged before the
mail is sent are always included as they may well contain useful
information such as a terminal exception or total run time.
Sending empty emails
--------------------
By default, the :class:`SummarisingLogger` handler will always send emails
even if they would have been empty:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',))
>>> logger.addHandler(handler)
>>> logging.error(' ')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
<BLANKLINE>
<BLANKLINE>
Sending empty emails is helpful for batch processes as even if no
activity is logged, the mail itself is an indication that the batch
process did at least run.
However, if you do not want empty entries to be mailed, all you need
to do is supply the `send_empty_entries` parameter:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... send_empty_entries=False)
>>> logger.addHandler(handler)
>>> logging.error(' ')
>>> logging.shutdown()
Specifying the host to send email through
-----------------------------------------
By default, as we've seen above, :class:`SummarisingLogger` uses localhost
to send mails. If you wish to use a specific smtp server to send
mail, this can be done by specifying the `mailhost` parameter to the
:class:`SummarisingLogger` constructor:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... mailhost='smtp.example.com')
>>> logger.addHandler(handler)
>>> logging.error('An Error')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('smtp.example.com', 25)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
An Error
<BLANKLINE>
If the smtp server you wish to use is running on non-standard port,
you can configure :class:`SummarisingLogger` to use this port by specifying
`mailhost` as a tuple containing the smtp server's hostname and the
port on which it is listening:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... mailhost=('smtp.example.com',2500))
>>> logger.addHandler(handler)
>>> logging.error('An Error')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('smtp.example.com', 2500)
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
An Error
<BLANKLINE>
If the smtp server you wish to use requires authentication,
pass the required username and password to the :class:`SummarisingLogger`
constructor:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... username='auser',password='theirpassword')
>>> logger.addHandler(handler)
>>> logging.error('An Error')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
(authenticated using username:'auser' and password:'theirpassword')
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
An Error
<BLANKLINE>
.. warning::
For performance reasons, it's recommended that you don't use SMTP
authentication unless you absolutely need to.
If the smtp server you wish to use requires TLS (Transport Level Security),
pass the required username and password and the secure parameter to the
:class:`SummarisingLogger` constructor. ``secure`` must be either a boolean
or an :class:`ssl.SSLContext` object:
.. invisible-code-block: python
logging.getLogger('').removeHandler(handler)
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... username='auser',password='apassword',
... secure=True)
>>> logger.addHandler(handler)
>>> logging.error('An Error')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
(authenticated using username:'auser' and password:'apassword')
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger...
<BLANKLINE>
An Error
<BLANKLINE>
.. _sum_extra_headers:
Adding extra headers
--------------------
If you wish to add headers for filtering purposes, you can use the
headers parameter:
>>> handler = SummarisingLogger('from@example.com',('to@example.com',),
... headers={'foo':'bar','Baz':'bob'})
>>> logger.addHandler(handler)
Now, when a log message results in an email being send, the email will
be sent with the configured headers:
>>> logging.error('The Error!')
>>> logging.shutdown()
sending to ('to@example.com',) from 'from@example.com' using ('localhost', 25)
Baz: bob
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"
Date: ...
From: from@example.com
MIME-Version: 1.0
Message-ID: <...MailingLogger@...>
Subject: Summary of Log Messages (ERROR)
To: to@example.com
X-Log-Level: ERROR
X-Mailer: MailingLogger ...
foo: bar
<BLANKLINE>
The Error!
<BLANKLINE>