Code Monkey home page Code Monkey logo

logbook-logstash's Introduction

logbook-logstash

JSON logs with logstash format for logbook

This library is provided to allow logbook logging to output log data as json objects ready to be shipped out to logstash.

This project is a fork of exoscale/python-logstash-formatter

Installing

Pip:

$ pip install logbook-logstash

Pypi:

https://pypi.python.org/pypi/logbook-logstash

Manual:

$ python setup.py install

Usage

Json outputs are provided by the LogstashFormatter logging formatter, for instance:

import sys

import logbook_logstash
from logbook import Logger, StreamHandler


log = Logger('testlog')

handler = StreamHandler(sys.stdout)
handler.formatter = logbook_logstash.LogstashFormatter()
handler.push_application()

log.info('My test')

You can provide extra variables, and show the exception traceback.

log.info({"account": 123, "ip": "172.20.19.18"})
log.info("classic message for account: %s", account, extra={"account": account})

h = {}
try:
    h['key']
except:
    log.info("something unexpected happened", exc_info=True)

Sample output

The following keys will be found in the output JSON:

  • @source_host: source hostname for the log
  • @timestamp: ISO 8601 timestamp
  • @message: short message for this log
  • @fields: all extra fields
{
  "@fields": {
      "account": "pyr",
      "args": [],
      "created": 1367480388.013037,
      "exception": [
          "Traceback (most recent call last):\n",
          "  File \"toto.py\", line 16, in <module>\n    k['unknown']\n",
          "KeyError: 'unknown'\n"
      ],
      "filename": "toto.py",
      "funcName": "<module>",
      "levelname": "WARNING",
      "levelno": 30,
      "lineno": 18,
      "module": "toto",
      "msecs": 13.036966323852539,
      "name": "root",
      "pathname": "toto.py",
      "process": 1819,
      "processName": "MainProcess",
      "relativeCreated": 18.002986907958984,
      "thread": 140060726359808,
      "threadName": "MainThread"
  },
  "@message": "TOTO",
  "@source_host": "phoenix.spootnik.org",
  "@timestamp": "2013-05-02T09:39:48.013158"
}

Tests

This project has basic tests, and uses the pytest library. Just execute the following commands in the project root.

$ pip install -r dev-requirements.txt
$ py.test

logbook-logstash's People

Contributors

pyr avatar robyoung avatar joekiller avatar romabysen avatar avaldi avatar brutasse avatar jtratner avatar

Watchers

James Cloos avatar Mira Hedl avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.