Skip to main content

Python json logger inspired by pino.js

Project description

pino.py

Json natural logger for python inspired by pino.js :evergreen_tree:

PyPI Supported Python Versions Build Status codecov

In building port of pinojs logging library to python :snake:

:warning: This is a in building prototype, it's API is subject to change. A CHANGELOG will be introduced once it's stable enough and publicized. Use it at you own risk, but feel free to reach with an issue.

Basic Example

from pino import pino

logger = pino(
    bindings={"apptype": "prototype", "context": "main"}
)

logger.info("Hello, I just started")
logger.debug({"details": 42}, "Some details that won't be seen")

child_logger = logger.child(context="some_job")
child_logger.info("Job started")
child_logger.info({"duration": 4012}, "Job completed %s", "NOW")

logger.info("Program completed")

Which would output:

{"level": "info", "time": 1587740056952, "message": "Hello, I just started", "host": "SomeHost", "apptype": "prototype", "context": "main", "millidiff": 0}
{"level": "info", "time": 1587740056952, "message": "Job started", "host": "SomeHost", "context": "some_job", "apptype": "prototype", "millidiff": 0}
{"level": "info", "time": 1587740056952, "message": "Job completed NOW", "host": "SomeHost", "duration": 4012, "context": "some_job", "apptype": "prototype", "millidiff": 0}
{"level": "info", "time": 1587740056952, "message": "Program completed", "host": "SomeHost", "apptype": "prototype", "context": "main", "millidiff": 0}

API

pino() constructor arguments

  • bindings: meta attached to the messages by default
  • level: minimal level to output logs, default to info
  • enabled: is logger enabled, default to true
  • millidiff: whether a millidiff is added to message, ms since last message, enabled by default.
  • stream : stream to write logs to, default to sys.stdout
  • dump_function: function to be used to serialise object to JSON, default json.dumps
  • messagekey: key for message entry, default message

pino logger instance

  • log methods: critical, error, warn, info, debug: (extra_bindings?), message, template value

  • .level: access or update current log level

  • child(metas): create a child logger instance with new metas/bindings attached to it. (metas can be provided either as dict or kwargs)

Complex examples

You can see more detailed examples in the examples folder, notably complex.py

Development :hammer_and_wrench:

This library use Poetry for management of the project, it's dependencies, build and else.

You can run test on all supported python version with poetry run task test (which will run tox), or you can run on your current python version with poetry run task pytest.

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

pino-0.6.0.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

pino-0.6.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file pino-0.6.0.tar.gz.

File metadata

  • Download URL: pino-0.6.0.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.6.6 Darwin/19.6.0

File hashes

Hashes for pino-0.6.0.tar.gz
Algorithm Hash digest
SHA256 fa60dcf8a087cd6f191c730744dcc96be9f371aef8b3320c48cbf0ffd1415afd
MD5 671c65adeec52f9d8570a03a2b478436
BLAKE2b-256 887c68bc956e96fdc1e76a3bc0b89deb0ab3fcb2ced2af76fd588ed6ac48e4bb

See more details on using hashes here.

File details

Details for the file pino-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: pino-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.6.6 Darwin/19.6.0

File hashes

Hashes for pino-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6ef45cd03ca082e89f728212c2fa664fb4888a01ae2fd644a83faf17a536c4b
MD5 43f53c0d59de97129e05457778c1c20d
BLAKE2b-256 b0a5e1191ec5d6761f83cc0f91f4f6a446bdd6771a9c0a22a2e96b34fee4cc06

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