Очередной скучный доклад про логгирование

ОЧЕРЕДНОЙ СКУЧНЫЙ ДОКЛАД
ПРО ЛОГГИРОВАНИЕ
Стас Рудаков

Эпиграф

Невозможно объять необъятное.
Козьма Прутков

Про логгирование, Стас Рудаков

Про что будем говорить?


Про логгирование, там же было написано :)


Про логгирование, там же было написано :)

А именно:
зачем;
как;
проблемы;
очевидные пути решения;
неочевидные пути решения;
open source инструменты.


Что вообще значит “записать в лог”?



сформировать сообщение



по некому событию



и, если это сообщение нас вообще интересует,



записать или отправить его куда-то,



куда имеют доступ заинтересованные лица.


Зачем

Debug
Разбор инцидентов


Зачем

Debug
Сбор статистики
Средне- и долгосрочный мониторинг
Инструмент для службы поддержки пользователей
Аналитика


import logging


Писать логи очень просто
1

import logging

2
3
4
5
6
7

logging . basicConfig (
format = ’ [%( asctime ) s ][%( levelname ) s ][%( name ) s ] %( message ) s ’ ,
stream = sys . stdout ,
level = logging . INFO
)

8
9
10

logger = logging . getLogger ( " meetup . python . minsk " )
logger . info ( " Stas has just started the talk on logging " )


Писать логи очень просто
1

import logging

2
3
4
5
6
7

logging . basicConfig (
format = ’ [%( asctime ) s ][%( levelname ) s ][%( name ) s ] %( message ) s ’ ,
stream = sys . stdout ,
level = logging . INFO
)

8
9
10

1

logger = logging . getLogger ( " meetup . python . minsk " )
logger . info ( " Stas has just started the talk on logging " )

[2014 -01 -31 06:23:27 ,904][ INFO ][ meetup . python . minsk ] Stas has
just started the talk on logging


logging: архитектура на пальцах

и, если это сообщение нас вообще
интересует,

куда имеют доступ
заинтересованные лица.

Конфигурация
1
2
3
4

5
6
7
8
9
10
11
12

13

CFG = {
’ formatters ’: {
’ simple ’: {
’ format ’: ’ %( asctime ) s %(
message ) s ’} ,} ,
’ filters ’: {
’ pwd ’: {
’ () ’: ’ proj . PwdFilter ’ ,
’ foo ’: ’ bar ’ ,} ,} ,
’ handlers ’: {
’ console ’ :{
’ level ’: ’ DEBUG ’ ,
’ class ’: ’ logging . ’
’ StreamHandler ’ ,
’ formatter ’: ’ simple ’} ,


14
15
16

17
18
19
20
21
22
23
24
25
26
27

’ mail_adm ’: {
’ level ’: ’ ERROR ’ ,
’ class ’: ’ proj . ’
’ Admi nEmailHa ndler ’ ,
’ filters ’: [ ’ pwd ’ ]} ,} ,
’ loggers ’: {
’ ’: {
’ handlers ’: [ ’ console ’] ,
’ level ’: ’ INFO ’ ,
’ filters ’: [ ’ pwd ’]} ,
’ django . request ’: {
’ handlers ’: [ ’ mail_adm ’] ,
’ level ’: ’ ERROR ’ ,
’ propagate ’: False ,} ,} ,}
logging . config . dictConfig ( CFG )

tips n tricks: уровни логгирования


CRITICAL = 50
logger.critical(u’проблема, после которой приложение не может
восстановиться без постороннего вмешательства’)


CRITICAL = 50
ERROR = 40
logger.error(u’проблема, из-за которой приложение работает не в
штатном режиме’)


CRITICAL = 50
ERROR = 40
WARNING = 30 # уровень по умолчанию
logger.warning(u’проблема, которая не мешает работе приложения, но
на которую стоит обратить внимание’)


CRITICAL = 50
ERROR = 40
INFO = 20
logger.info(u’обычная запись в лог’)


CRITICAL = 50
ERROR = 40
INFO = 20
logger.info(u’обычная запись в лог’)
DEBUG = 10
logger.debug(u’логи, которые помогли нам при отладке приложения и
которые вряд ли пригодятся в будущем’)

tips n tricks: traceback
1

try :

2

do_ s o me t hi n g_ u n sa f e ()
except Exception as e :
logger . exception ( ’ Unexpected exception ’)
raise

3
4
5


1

try :

2

do_ s o me t hi n g_ u n sa f e ()
except Exception as e :
logger . exception ( ’ Unexpected exception ’)
raise

3
4
5

В лог отправится:
1
2
3
4
5
6
7
8
9

[2014 -01 -29 23:35:04 ,393][ examples ][ ERROR ] Unexpected exception
Traceback ( most recent call last ) :
File " stacktrace1 . py " , line 22 , in < module >
d o_ s o me t hi n g_ u n sa f e ()
File " stacktrace1 . py " , line 18 , in do _ so m e th i ng _ u ns a fe
down_rabbit_hole ()
File " stacktrace1 . py " , line 17 , in down_rabbit_hole
sender = message . sender
AttributeError : ’ NoneType ’ object has no attribute ’ sender ’


1

try :

2

validate_data ( data )
except ValidationError as e :
logger . exception ( ’ Validation failed ’)

3
4

А в лог запишется
1
2
3
4
5
6
7
8
9

[2014 -01 -29 08:33:53 ,439][ examples ][ ERROR ] Validation failed
File " stacktrace2 . py " , line 22 , in validate_data
check_values ( data )
File " stacktrace2 . py " , line 21 , in check_values
raise ValidationError ( ’ security key is missing ’)
ValidationError : security key is missing


1

try :

2

logger . exception ( ’ Validation failed ’)

3
4

А в лог запишется
1
2
3
4
5
6
7
8
9

[2014 -01 -29 08:33:53 ,439][ examples ][ ERROR ] Validation failed

Но разве уровень ERROR нам подходит?

1

try :

2

logger . warning ( ’ Validation failed ’ , exc_info = True )

3
4

Получаем
1
2
3
4
5
6
7
8
9

[2014 -01 -29 08:33:53 ,439][ examples ][ WARNING ] Validation failed


tips n tricks: “ленивое” форматирование
1
2
3

logger . info (
’ Request id =% s message =% r ’ % (100500 , { ’ event ’: ’ meetup ’ })
)


1
2
3

logger . info (
)

Зачем форматировать строку, если мы не знаем, попадет ли она в лог?


1
2
3

logger . info (
)

1
2
3

logger . info (
’ Request id =% s message =% r ’ , 100500 , { ’ event ’: ’ meetup ’}
)


1
2
3

logger . info (
)

1
2
3

logger . info (
’ Request id =% s message =% r ’ , 100500 , { ’ event ’: ’ meetup ’}
)

*args работают, **kwargs не работают


tips n tricks: ротация
в один прекрасный день. . .


в один прекрасный день. . . no space left on device


from logging.handlers import *
1
2
3
4
5

1
2
3
4
5

Rotating Fi l eH a n dl e r (
filename , mode = ’a ’ ,
maxBytes =0 , backupCount =0 ,
encoding = None , delay = False
)
$ ls logs
meetup . log
meetup . log .1
meetup . log .2
meetup . log .3


1
2
3
4
5

1
2
3
4
5

)

1

$ ls logs
meetup . log
meetup . log .1
meetup . log .2
meetup . log .3

1


2
3
4
5

2
3
4
5

T i m e d Ro t a t i n g F i l e H a n d l e r (
filename ,
when = ’h ’ , interval =1 ,
backupCount =0 , encoding = None ,
delay = False , utc = False )
$ ls logs
meetup . log
meetup . log .2014 -01 -31 _17
meetup . log .2014 -01 -31 _18
meetup . log .2014 -01 -31 _19

1
2
3
4
5

1
2
3
4
5

)

1

$ ls logs
meetup . log
meetup . log .1
meetup . log .2
meetup . log .3

1

2
3
4
5

2
3
4
5

T i m e d Ro t a t i n g F i l e H a n d l e r (
filename ,
when = ’h ’ , interval =1 ,
backupCount =0 , encoding = None ,
delay = False , utc = False )
$ ls logs
meetup . log
meetup . log .2014 -01 -31 _17
meetup . log .2014 -01 -31 _18
meetup . log .2014 -01 -31 _19

Если варианты выше не подходят, можно использовать утилиту logrotate и
1

Wa tc he dFi le Ha ndl er ( fname , mode = ’a ’ , encoding = None , delay = False )


Sentry
getsentry.com


Sentry - это. . .
open source
аггрегатор
сообщений об
ошибках,
написанный на
Python +
Django +
Celery,
с клиентами
для многих
языков и
платформ.


Sentry: как подключить
1
2
3

from raven . handlers . logging import SentryHandler
handler = SentryHandler ( ’ http :// public : secret@example . com /1 ’ ,
level = logging . WARNING )


1
2
3

4
5


logger = logging . getLogger ( ’ coffeemaker ’)
logger . addHandler ( handler )


1
2
3

4
5

6
7



logger . warning ( ’ We are running out of milk ’)
logger . error ( ’ Not enough milk for a cappuccino ’)


1
2
3

4
5

6
7



logger . warning ( ’ We are running out of milk ’)
logger . error ( ’ Not enough milk for a cappuccino ’)

HTTP? Cерьезно?

А теперь давайте вспомним, что мы с этими логами собирались делать

Debug


А теперь давайте вспомним, что мы с этими логами собирались делать

Debug
Сбор статистики
Средне- и долгосрочный мониторинг
Инструмент для службы поддержки пользователей
Аналитика


Назад в будущее

Современные вызовы:
хотим убедиться, что логи не были модифицированы злоумышленником
после взлома;
переходим от программ к сложным распределенным системам — хочется
иметь логгирование уровня всей системы, а не отдельных приложений;
быстрый поиск;
метрики.


elasticsearch
elasticsearch.org


elasticsearch - это. . .
распределенный
полнотекстовый
поисковый движок


c RESTful web-интерфейсом,
с документами без схемы
и возможностями аггрегации документов.


Написан на Java
с использованием библиотеки Apache Lucene.
Используется в Mozilla, GitHub и многих других компаниях
(если вам нужно убедить своего менеджера).


Написан на Java
с использованием библиотеки Apache Lucene.
Используется в Mozilla, GitHub и многих других компаниях
(если вам нужно убедить своего менеджера).
Но как связать логгирование и elasticsearch?

logstash
logstash.net


logstash + elasticsearch + kibana = nice web UI


structlog — последний ингридиент

1
2
3
4
5
6

>>> from structlog import get_logger
>>> log = get_logger ()
>>> log = log . bind ( user = ’ anonymous ’ , some_key =23)
>>> log = log . bind ( user = ’ hynek ’ , another_key =42)
>>> log . info ( ’ user . logged_in ’ , happy = True )
some_key =23 user = ’ hynek ’ another_key =42 happy = True event = ’ user .
logged_in ’

http://www.structlog.org/


Что мы не объяли?

Syslog Protocol
Логи в реляционной базе данных
journald
logplex, ﬂuentd
Агенты для сбора логов
Что, собственно, писать в логи.


Выводы

Батарейка logging вполне подходит для 95% случаев1 .

1

По статистике, не стоит доверять 75% статистики

Выводы

Архитектуры систем логгирования похожи как на микро, так и на макро
уровне.

1


Выводы

уровне.
Open source инструменты помогают выжать из логов очень много полезных
свойств.

1


Выводы

уровне.
Open source инструменты помогают выжать из логов очень много полезных
свойств.
Я вас всех порядочно утомил.

1


СПАСИБО ЗА ВНИМАНИЕ. ВОПРОСЫ?

Стас Рудаков
mailto:stas@garage22.net
https://raw.github.com/nott/talks/logging.pdf
http://docs.python.org/3/library/logging.html
http://www.structlog.org/
https://www.getsentry.com/
http://logstash.net/

Очередной скучный доклад про логгирование

More Related Content

What's hot

Viewers also liked

More from Python Meetup

Очередной скучный доклад про логгирование