Python formatter for working with Logstash json filters.
Project description
Python logging formatter for creating log entries in a JSON logstash-friendly format.
Supports renaming of python default logging fields to logstash friendly names (e.g: renaming asctime to @timestamp)
LogstashFormatter can receive the following arguments:
fmt, list or tuple containing the fields to include in each entry. Defaults to [“asctime”, “levelname”, “filename”, “funcName”, “msg”, “exc_info”].
datefmt, date format string to be passed to formatTime(). Defaults to ISO8601 time format.
rename, dictionary containing mapping of { key: new_key } to be renamed. Defaults to { “asctime”: “@timestamp” }.
version, version as for the @version attribute used in Logstash. Defaults to “1”.
Sample output
{
"@timestamp": "2016-09-28T16:24:24,799",
"@version": "1",
"exc_info": null,
"filename": "<ipython-input-21-de248ad5b09c>",
"funcName": "<module>",
"levelname": "INFO",
"message": "This is a normal message to be logged"
}
Usage
Add LogstashFormatter as the formatter of your handler, as usual:
self.logger = logging.getLogger()
self.handler = logging.StreamHandler()
self.handler.setFormatter(LogstashFormatter())
self.logger.addHandler(self.handler)
Using in Django
Include logstash formatter in your settings file:
LOGGING = {
'formatters': {
'logstash': {
'()': 'logstash_formatter.LogstashFormatter',
'format': ("asctime", "levelname", "name", "lineno", "message",
"pathname", "module", "funcName", "process",),
'datefmt': '%Y-%m-%dT%H:%M:%S',
'rename': {
'asctime': '@timestamp',
},
'version': '1'
},
}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for logstash-python-formatter-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cfedaa2edfdf85a3396bc3d58668dbdcfbc83b9c7cc4afeb8b79ab798a776c4 |
|
MD5 | 657bbda6805376d147c5389c8d2eba6e |
|
BLAKE2b-256 | 79f84044fd9de88c88e059c3e9751046a476c1e1a42a71faad47e8a6e08e4608 |
Hashes for logstash_python_formatter-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 043e9862183ae9fddba723e7de13e95173cfa7a35def52496b753be87e70b1da |
|
MD5 | ee9401a4365b2cffdeeacd0b9c59b6a5 |
|
BLAKE2b-256 | a86d35f66323cb760515016ff82cc8dc2744fdc490573ac77fee0280500ec055 |