nameko-structlog

Structlog as nameko extension

• Free software: Apache Software License 2.0

Extension for nameko that replaces python logging module with structlog. The idea behind this module is to use JSONRenderer to be able to use advanced log aggregation and analysis tools like Logstash.

Apart from JSONRenderer structlog processor, it's also supported KeyValueRenderer processor.

Installation

To install nameko-structlog, simply use pip.

pip install nameko-structlog

Usage

Add Structlog log level to your nameko config file:

 # config.yml when using JSONRenderer
 STRUCTLOG:
    INCLUDE_WORKER_NAME: ${INCLUDE_WORKER_NAME:true}
    INCLUDE_LOG_TRANSACTON_ID: true
    PROCESSOR_NAME: JSONRenderer
    PROCESSOR_OPTIONS:
      sort_keys: true
    EXTRA_PARAMETERS:
       pin: 1234
       env: dev

LOGGING:
  version: 1
  formatters:
    simple:
      format: "%(message)s"

  handlers:
    console:
      class: logging.StreamHandler
      formatter: simple

  root:
    level: DEBUG
    handlers: [console]
 ...

Option INCLUDE_WORKER_NAME will add or not worker_ctx.call_id to every log entry. Option INCLUDE_LOG_TRANSACTON_ID will group all logs that refer to same nameko entrypoint, with a unique log_transaction_id. Doing so may be useful to follow request/data flow on a log aggregation tool. Option EXTRA_PARAMETERS can contain any keys that you want to appear on every log entry.

Include the StructlogDependency dependency in your service class:

# service.py
from nameko.rpc import rpc

from nameko_structlog import StructlogDependency

class MyService(object):
   name = "demo"

   log = StructlogDependency()

   @rpc
   def my_method(self, name):
      self.log.info(message=f"Your name is {name}", type="greeting")

Run your service, providing the config file:

$ nameko run service --config config.yaml

$ nameko shell --config config.yaml
>>> n.rpc.demo.my_method("Alice")
{"level": "info", "log_transaction_id": "b2cd5506-339e-4e59-9a14-a3cd7548bfe5", "logger": "demo", "env": "dev", message": "Your name is Alice", "pin": "1234", "timestamp": "2020-09-27T11:24:30.379918Z", "type": "greeting"}

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.