Skip to main content

Simple log formatter for Logstash-compatible JSON output

Project description

Build Status codecov Current version at PyPI

This is a fork of simple_json_logger, extracting the formatter into it’s own project.

It formats the Python logging.Record into a JSON suitable for indexing engines like Logstash and AWS CloudWatch Logs.

Installation

pip install simple_json_log_formatter

Usage

Simply set the formatter in a log handler and add it to the current logger.

For example, to print the JSON logs to the current stream, set up the logger with the following:

import json, logging
from simple_json_log_formatter import SimpleJsonFormatter
handler = logging.StreamHandler()
handler.setFormatter(SimpleJsonFormatter(json.dumps))
logging.getLogger().addHandler(handler)
logging.getLogger().setLevel(logging.INFO)

And then simply call logging.info('TEST'). It should print something like this:

{"timestamp": "2017-09-08T17:01:26.408975", "line_number": 1, "function": "<module>", "module": "<input>", "level": "INFO", "path": "<input>", "msg": "TEST"}

Testing

python setup.py test

Compatibility

Python versions 2.7 and 3.4+ are supported.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

simple_json_log_formatter-0.5.5-py2.py3-none-any.whl (3.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file simple_json_log_formatter-0.5.5-py2.py3-none-any.whl.

File metadata

  • Download URL: simple_json_log_formatter-0.5.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for simple_json_log_formatter-0.5.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ae776eb7a7895618d8c539e975f1ad4bc283266cfa9257984336a3686d446a3b
MD5 00569e13e802852e994f8987fd578d17
BLAKE2b-256 f6905926949eea96725821e5ae78308dd7063fd231376e00367a97afa695cc7f

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