Skip to main content

A collection of structlog processors for prettier output

Project description

CI Status Code Coverage

A collection of structlog processors for prettier output: a code syntax highlighter, JSON and XML prettifiers, a multiline string printer, and a numeric value rounder.

Installation

First of all, sorry, grandma, but structlog-pretty requires Python 3.

You can just install the library with pip:

pip install structlog-pretty

or, if you want faster prettifying processors:

pip install structlog-pretty[fast]

The downside of the faster processors is that they will build C extensions and they need libxml to be installed.

Usage

Add structlog-pretty processors to your structlog configuration

import structlog
import structlog_pretty

structlog.configure(
    # ...
    processors=[
        structlog.stdlib.add_log_level,
        structlog_pretty.NumericRounder(digits=2, only_fields=['timing'])
        structlog.processors.JSONRenderer(),
    ],
)

A nice example of a processor pipeline for the prettiest logs could be

processors=[
    # ...
    structlog_pretty.JSONPrettifier(['request', 'response']),
    structlog_pretty.XMLPrettifier(['soap_response']),
    structlog_pretty.PathPrettifier(),
    structlog_pretty.SyntaxHighlighter({'request': 'json', 'response': 'json', 'soap_response': 'xml'}),
    structlog_pretty.MultilinePrinter(['request', 'response', 'soap_response']),
    # ...
],

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

structlog_pretty-0.4.3.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

structlog_pretty-0.4.3-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file structlog_pretty-0.4.3.tar.gz.

File metadata

  • Download URL: structlog_pretty-0.4.3.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.25.0

File hashes

Hashes for structlog_pretty-0.4.3.tar.gz
Algorithm Hash digest
SHA256 e5c6a8e98cdacd517a469dbedfe70de33eff5f2537343933024d6e2c0da8711d
MD5 05b90f1db3b4ad7614a2840ac1c807bd
BLAKE2b-256 9e4cfaf8822fa7af8cfe3f7d93bba98db57e1e63be3c87378e7599668436602b

See more details on using hashes here.

File details

Details for the file structlog_pretty-0.4.3-py3-none-any.whl.

File metadata

File hashes

Hashes for structlog_pretty-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 352a2e0a1c59b95ef37da9da6caa7e3b25c34a8d7793fcc910c277eb7584d2bb
MD5 3354d4d5ac4cb85d32a5d9b207be07f7
BLAKE2b-256 2a57d6c3d2b337d3cc35359d072ce821d3991fee0d256ad2b1bd4b9e386cc099

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page