# sag_py_logging_logstash
[![Maintainability][codeclimate-image]][codeclimate-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[](https://snyk.io/test/github/SamhammerAG/sag_py_logging_logstash)
[coveralls-image]:https://coveralls.io/repos/github/SamhammerAG/sag_py_logging_logstash/badge.svg?branch=master
[coveralls-url]:https://coveralls.io/github/SamhammerAG/sag_py_logging_logstash?branch=master
[codeclimate-image]:https://api.codeclimate.com/v1/badges/5e8f1c5bef6aeecd543d/maintainability
[codeclimate-url]:https://codeclimate.com/github/SamhammerAG/sag_py_logging_logstash/maintainability
Python Logstash Async is an asynchronous Python logging handler to submit
log events to a remote Logstash instance.
It based on open source library, see the documentation http://python-logstash-async.readthedocs.io/en/latest/.
In this version transporter is limited to HTTPTransport, according to Logstash intern installation requirements.
Unlike most other Python Logstash logging handlers, this package works asynchronously
by collecting log events from Python's logging subsystem and then transmitting the
collected events in a separate worker thread to Logstash.
This way, the main application (or thread) where the log event occurred, doesn't need to
wait until the submission to the remote Logstash instance succeeded.
This is especially useful for applications like websites or web services or any kind of
request serving API where response times matter.
## Usage
Example::
from logstash_async.handler import AsynchronousLogstashHandler
from logstash_async.formatter import LogstashFormatter
import logging
logstash_handler = AsynchronousLogstashHandler(
host='my_host',
port=123,
username='my_user',
password='my_password',
index_name = 'my_index')
logstash_formatter = LogstashFormatter( extra_prefix='',
extra={'customer': "name", 'ap_environment': "local"})
logstash_handler.setFormatter(logstash_formatter)
logging_handlers = []
logging_handlers.append(logstash_handler)
logging.basicConfig(
level="INFO",
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
handlers=logging_handlers)
logging.getLogger().info("Logging Message", extra = {'new_field':"value"})
### Installation
pip install sag-py-logging-logstash
## How to start developing
### With vscode
Just install vscode with dev containers extension. All required extensions and configurations are prepared automatically.
### With pycharm
* Install latest pycharm
* Install pycharm plugin BlackConnect
* Configure the python interpreter/venv
* pip install requirements-dev.txt
* pip install black[d]
* Ctl+Alt+S => Check Tools => BlackConnect => Trigger when saving changed files
* Ctl+Alt+S => Check Tools => BlackConnect => Trigger on code reformat
* Ctl+Alt+S => Click Tools => BlackConnect => "Load from pyproject.yaml" (ensure line length is 120)
* Ctl+Alt+S => Click Tools => BlackConnect => Configure path to the blackd.exe at the "local instance" config (e.g. C:\Python310\Scripts\blackd.exe)
* Ctl+Alt+S => Click Tools => Actions on save => Reformat code
* Restart pycharm
## How to publish
* Update the version in setup.py and commit your change
* Create a tag with the same version number
* Let github do the rest
## How to test
To avoid publishing to pypi unnecessarily you can do as follows
* Tag your branch however you like
* Use the chosen tag in the requirements.txt-file of the project you want to test this library in, eg. `sag_py_logging_logstash==<your tag>`
* Rebuild/redeploy your project
Raw data
{
"_id": null,
"home_page": "https://github.com/SamhammerAG/sag_py_logging_logstash",
"name": "sag-py-logging-logstash",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "logging, logstash",
"author": "Samhammer AG",
"author_email": "support@samhammer.de",
"download_url": "https://files.pythonhosted.org/packages/78/f4/1e9eef3c15c024e0c7035f91165e2d083fb3d2c89228b0e73edb9901e6b1/sag_py_logging_logstash-3.0.0.tar.gz",
"platform": null,
"description": "# sag_py_logging_logstash\n\n[![Maintainability][codeclimate-image]][codeclimate-url]\n[![Coverage Status][coveralls-image]][coveralls-url]\n[](https://snyk.io/test/github/SamhammerAG/sag_py_logging_logstash)\n\n[coveralls-image]:https://coveralls.io/repos/github/SamhammerAG/sag_py_logging_logstash/badge.svg?branch=master\n[coveralls-url]:https://coveralls.io/github/SamhammerAG/sag_py_logging_logstash?branch=master\n[codeclimate-image]:https://api.codeclimate.com/v1/badges/5e8f1c5bef6aeecd543d/maintainability\n[codeclimate-url]:https://codeclimate.com/github/SamhammerAG/sag_py_logging_logstash/maintainability\n\n\nPython Logstash Async is an asynchronous Python logging handler to submit\nlog events to a remote Logstash instance.\nIt based on open source library, see the documentation http://python-logstash-async.readthedocs.io/en/latest/.\nIn this version transporter is limited to HTTPTransport, according to Logstash intern installation requirements.\n\nUnlike most other Python Logstash logging handlers, this package works asynchronously\nby collecting log events from Python's logging subsystem and then transmitting the\ncollected events in a separate worker thread to Logstash.\nThis way, the main application (or thread) where the log event occurred, doesn't need to\nwait until the submission to the remote Logstash instance succeeded.\n\nThis is especially useful for applications like websites or web services or any kind of\nrequest serving API where response times matter.\n\n## Usage\n\nExample::\n\n from logstash_async.handler import AsynchronousLogstashHandler\n from logstash_async.formatter import LogstashFormatter\n import logging\n\n logstash_handler = AsynchronousLogstashHandler(\n host='my_host',\n port=123,\n username='my_user',\n password='my_password',\n index_name = 'my_index')\n logstash_formatter = LogstashFormatter( extra_prefix='',\n extra={'customer': \"name\", 'ap_environment': \"local\"})\n logstash_handler.setFormatter(logstash_formatter)\n\n logging_handlers = []\n logging_handlers.append(logstash_handler)\n\n logging.basicConfig(\n level=\"INFO\",\n format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',\n handlers=logging_handlers)\n\n logging.getLogger().info(\"Logging Message\", extra = {'new_field':\"value\"})\n\n\n### Installation\npip install sag-py-logging-logstash\n\n## How to start developing\n\n### With vscode\n\nJust install vscode with dev containers extension. All required extensions and configurations are prepared automatically.\n\n### With pycharm\n\n* Install latest pycharm\n* Install pycharm plugin BlackConnect\n* Configure the python interpreter/venv\n* pip install requirements-dev.txt\n* pip install black[d]\n* Ctl+Alt+S => Check Tools => BlackConnect => Trigger when saving changed files\n* Ctl+Alt+S => Check Tools => BlackConnect => Trigger on code reformat\n* Ctl+Alt+S => Click Tools => BlackConnect => \"Load from pyproject.yaml\" (ensure line length is 120)\n* Ctl+Alt+S => Click Tools => BlackConnect => Configure path to the blackd.exe at the \"local instance\" config (e.g. C:\\Python310\\Scripts\\blackd.exe)\n* Ctl+Alt+S => Click Tools => Actions on save => Reformat code\n* Restart pycharm\n\n## How to publish\n* Update the version in setup.py and commit your change\n* Create a tag with the same version number\n* Let github do the rest\n\n## How to test\n\nTo avoid publishing to pypi unnecessarily you can do as follows\n\n* Tag your branch however you like\n* Use the chosen tag in the requirements.txt-file of the project you want to test this library in, eg. `sag_py_logging_logstash==<your tag>`\n* Rebuild/redeploy your project\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python logging logstash handler",
"version": "3.0.0",
"project_urls": {
"Bug Reports": "https://github.com/SamhammerAG/sag_py_logging_logstash/issues",
"Documentation": "https://github.com/SamhammerAG/sag_py_logging_logstash",
"Homepage": "https://github.com/SamhammerAG/sag_py_logging_logstash",
"Source": "https://github.com/SamhammerAG/sag_py_logging_logstash"
},
"split_keywords": [
"logging",
" logstash"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25541b6cb3d1e3df8a2a317f174827a215c14af0d1d7e1085e19de39330c0496",
"md5": "bc4ac97845106b42f519f58209e08cf1",
"sha256": "3c966484cdc8d26cd581ff77aed5493dfe9b717475a6ce472b118f9dbfa56f9a"
},
"downloads": -1,
"filename": "sag_py_logging_logstash-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc4ac97845106b42f519f58209e08cf1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 16945,
"upload_time": "2024-09-18T05:50:14",
"upload_time_iso_8601": "2024-09-18T05:50:14.575659Z",
"url": "https://files.pythonhosted.org/packages/25/54/1b6cb3d1e3df8a2a317f174827a215c14af0d1d7e1085e19de39330c0496/sag_py_logging_logstash-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "78f41e9eef3c15c024e0c7035f91165e2d083fb3d2c89228b0e73edb9901e6b1",
"md5": "9a8224a760a7a83d6f63f6e8c1708b45",
"sha256": "94cdb78e4616fbfea909c955de889babaaf3247e7b3785ee192caff0f2c5831d"
},
"downloads": -1,
"filename": "sag_py_logging_logstash-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9a8224a760a7a83d6f63f6e8c1708b45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 15363,
"upload_time": "2024-09-18T05:50:16",
"upload_time_iso_8601": "2024-09-18T05:50:16.100383Z",
"url": "https://files.pythonhosted.org/packages/78/f4/1e9eef3c15c024e0c7035f91165e2d083fb3d2c89228b0e73edb9901e6b1/sag_py_logging_logstash-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 05:50:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SamhammerAG",
"github_project": "sag_py_logging_logstash",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sag-py-logging-logstash"
}
JSON
