Logging Rethought 2: The Actions of Frank Taylor Jr. (PyCon Australia 2019)

Logging Rethought 2 The Actions of Frank Taylor Jr. markusholtermann.eu
• gitlab.com/MarkusH • github.com/MarkusH • @m_holtermann

Hi, I’m Markus Holtermann • Engineer at • Django Core
Contributor

@m_holtermann The Problem(s) We’re Facing

@m_holtermann The Current State Of Logging

import logging logger = logging.getLogger(__name__) logger.error( "Login failed because the
" "connection to the authentication " "provider %s timed out.", provider_name )

[2019-04-01T10:47:04.139+00:00] [ERROR] [srv01] Login failed because the connection to the
authentication provider google timed out.

@m_holtermann Our Logging Is Broken

@m_holtermann What IP and host did the server try to
connect to?

@m_holtermann What was the timeout limit at the time?

@m_holtermann How many other attempts were made to talk to
that authentication provider?

@m_holtermann Where other outgoing connections affected by timeout errors as
well?

@m_holtermann Were other servers affected by the same problem as
well?

@m_holtermann Adding Structure To Our Logs

import structlog logger = structlog.get_logger("structlog") logger.error( "auth_provider_failed", provider_name=provider_name, provider_ip=provider_ip, timeout=timeout,
)

2019-04-01 10:47:04.139 [error ] auth_provider_failed provider_ip='8.8.8.8' provider_name='google' server='srv01' timeout=5

{ "event": "auth_provider_failed", "timestamp": 1554115624.139, "level": "error", "provider_name": "google", "provider_ip":
"8.8.8.8", "timeout": 5 }

WYSIWYU What You See Is What You Understand

@m_holtermann

@m_holtermann A Picture Says More Than A Thousand Words

@m_holtermann

@m_holtermann Tracing Events

import uuid, structlog logger = structlog.get_logger("structlog") def structlog_middleware(get_response): def _inner(request):
request.trace_id = ( request.META.get("HTTP_X_TRACE_ID") or str(uuid.uuid4()) ) log = logger.new(trace_id=request.trace_id) return get_response(request) return _inner

import structlog logger = structlog.get_logger("structlog") def structlog_user_middleware(get_response): def _inner(request): if
request.user.is_authenticated: logger.bind(user_id=request.user.pk) return get_response(request) return _inner

@m_holtermann Logging For European Users

@m_holtermann Never log any secrets. EVER!

@m_holtermann Ensure your log data store is secured and not
world- readable! NO, REALLY!

@m_holtermann Explicitly log whatever should end up in logs.

# DO logger.error("some_event", foo="bar", lorem="ipsum") # DON'T DO logger.error("some_event", **some_object.__dict__)

@m_holtermann Who the heck is Frank Taylor Jr.?

@m_holtermann Frank William Abagnale Jr.!

@m_holtermann Demo

Demo Example gitlab.com/MarkusH/django-structlog

@m_holtermann

Example gitlab.com/MarkusH/django-structlog

@m_holtermann Thank you!

Logging Rethought 2: The Actions of Frank Taylor Jr. (PyCon Australia 2019)

Logging Rethought 2: The Actions of Frank Taylor Jr. (PyCon Australia 2019)

More Decks by Markus H

Other Decks in Technology

Featured

Transcript