Project JSONkLog
================
The goal of this library is to provide a simple formatter, and handlers for
standard python logging libraries to deal with JSON output in a sort of
"set it and forget it" methodology that python logging currently provides.
Formatters :
++++++++++++
Currently there are two formatters:
* JSONFormatter
* JSONFormatterSimple
Each of the formatters processes the standard python logging messages into JSON
however the "Simple" library provides a limited output including only 3 key elements
and the mysterious 4th element "Extras"
Please note that "extras" as a dictionary requires the content to be nested under
the "extra" key within the dictionary
For examples, please see example_formatter.py within the source tree at:
* http://www.github.com/neogenix/jsonklog/examples
Handlers :
++++++++++
Currently there are two handlers, which require JSONFormatter, or JSONFormatterSimple
to have been used :
* MongoDBHandler
* ElasticSearchHandler
Each of the handlers can process the standard JSON messages from the included JSON
formatting libraries, and can have different destinations specified as follows:
MongoDBHandler :
----------------
This handler speaks MongoDB (using 'pymongo'), and can take the following arguments:
* host - The destination host / ip of the MongoDB server
* port - The destination port of the MongoDB server
* db - The destination database to send messages to
* collection - The destination collection to send messages to
* for more on MongoDB see the following URL: http://www.mongodb.org/
ElasticSearchHandler :
----------------------
This handler speaks ElasticSearch (using 'requests'), and can take the following arguments:
* host - The destination host / ip of the ElasticSearch server
* port - The destination port of the ElasticSearch server
* index - The destination index to send messages to
* doc_type - The destination doc_type to send messages to
* for more on ElasticSearch see the following URL: http://www.elasticsearch.org/
Note :
++++++
To format your JSON into "human readable whatsits" ensure your handler outputs
to stdout, and then pipe through the node-json library ('json'), installed as per:
* npm install -g json
This is not a requirement, but rather what I'm using to do my testing ;)
History
=========
0.15.0 (2012-06-25)
+++++++++++++++++++
* Added additional examples, and moved them to /examples
* Added more documentation
* Reformatted handlers to make them easier to work with
* Made handlers depend on json formatters
0.10.0 (2012-06-19)
+++++++++++++++++++
* Initial release of MongoDBHandler, and ElasticSearchHandler
* Initial documentation around Handlers.
* Example code added for handler.py
0.05.0 (2012-06-14)
+++++++++++++++++++
* Initial release of JSONFormatter, and JSONFormatterSimple
* Initial documentation added
* Example code added for formatter.py
0.01.0 (2012-06-10)
+++++++++++++++++++
* Initial release
Raw data
{
"_id": null,
"home_page": "http://www.github.com/neogenix/jsonklog",
"name": "jsonklog",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "json logging",
"author": "Patrick Ancillotti",
"author_email": "patrick@eefy.net",
"download_url": "https://files.pythonhosted.org/packages/83/c6/8456795bbf9c5ba830b55de0755c19a5f8814966dc33d429f504961b7fc4/jsonklog-0.15.0.tar.gz",
"platform": "UNKNOWN",
"description": "Project JSONkLog\n================\n\nThe goal of this library is to provide a simple formatter, and handlers for\nstandard python logging libraries to deal with JSON output in a sort of\n\"set it and forget it\" methodology that python logging currently provides.\n\nFormatters :\n++++++++++++\n\nCurrently there are two formatters:\n\n * JSONFormatter\n * JSONFormatterSimple\n\nEach of the formatters processes the standard python logging messages into JSON\nhowever the \"Simple\" library provides a limited output including only 3 key elements\nand the mysterious 4th element \"Extras\"\n\nPlease note that \"extras\" as a dictionary requires the content to be nested under\nthe \"extra\" key within the dictionary\n\nFor examples, please see example_formatter.py within the source tree at:\n\n * http://www.github.com/neogenix/jsonklog/examples\n\nHandlers :\n++++++++++\n\nCurrently there are two handlers, which require JSONFormatter, or JSONFormatterSimple\nto have been used :\n\n * MongoDBHandler\n * ElasticSearchHandler\n\nEach of the handlers can process the standard JSON messages from the included JSON\nformatting libraries, and can have different destinations specified as follows:\n\nMongoDBHandler :\n----------------\n\nThis handler speaks MongoDB (using 'pymongo'), and can take the following arguments:\n\n * host - The destination host / ip of the MongoDB server\n * port - The destination port of the MongoDB server\n * db - The destination database to send messages to\n * collection - The destination collection to send messages to\n\n* for more on MongoDB see the following URL: http://www.mongodb.org/\n\nElasticSearchHandler :\n----------------------\n\nThis handler speaks ElasticSearch (using 'requests'), and can take the following arguments:\n\n * host - The destination host / ip of the ElasticSearch server\n * port - The destination port of the ElasticSearch server\n * index - The destination index to send messages to\n * doc_type - The destination doc_type to send messages to\n\n* for more on ElasticSearch see the following URL: http://www.elasticsearch.org/\n\nNote :\n++++++\n\nTo format your JSON into \"human readable whatsits\" ensure your handler outputs\nto stdout, and then pipe through the node-json library ('json'), installed as per:\n\n * npm install -g json\n\nThis is not a requirement, but rather what I'm using to do my testing ;)\n\n\nHistory\n=========\n\n0.15.0 (2012-06-25)\n+++++++++++++++++++\n* Added additional examples, and moved them to /examples\n* Added more documentation\n* Reformatted handlers to make them easier to work with\n* Made handlers depend on json formatters\n\n0.10.0 (2012-06-19)\n+++++++++++++++++++\n* Initial release of MongoDBHandler, and ElasticSearchHandler\n* Initial documentation around Handlers.\n* Example code added for handler.py\n\n0.05.0 (2012-06-14)\n+++++++++++++++++++\n* Initial release of JSONFormatter, and JSONFormatterSimple\n* Initial documentation added\n* Example code added for formatter.py\n\n0.01.0 (2012-06-10)\n+++++++++++++++++++\n* Initial release",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "JSON Logging Library with Python",
"version": "0.15.0",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "http://www.github.com/neogenix/jsonklog"
},
"split_keywords": [
"json",
"logging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "83c68456795bbf9c5ba830b55de0755c19a5f8814966dc33d429f504961b7fc4",
"md5": "9a9632a1d897ebab52327cf47bd3cba6",
"sha256": "86eaaac485663c4c99f02cac6a173df5b1174e1cefd7d6d71c1617591afed86d"
},
"downloads": -1,
"filename": "jsonklog-0.15.0.tar.gz",
"has_sig": false,
"md5_digest": "9a9632a1d897ebab52327cf47bd3cba6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8390,
"upload_time": "2012-06-26T06:52:19",
"upload_time_iso_8601": "2012-06-26T06:52:19.353062Z",
"url": "https://files.pythonhosted.org/packages/83/c6/8456795bbf9c5ba830b55de0755c19a5f8814966dc33d429f504961b7fc4/jsonklog-0.15.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2012-06-26 06:52:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neogenix",
"github_project": "jsonklog",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "jsonklog"
}
JSON
