An up-to-date, RFC5424-Compliant syslog handler for the Python logging framework
Project description
An up-to-date, RFC 5424 compliant syslog handler for the Python logging framework.
- Free software: BSD License
- Homepage: https://github.com/jobec/rfc5424-logging-handler
- Documentation: http://rfc5424-logging-handler.readthedocs.org/
Features
- RFC 5424 Compliant.
- Python Logging adapter for easier sending of rfc5424 specific fields.
- No need for complicated formatting strings.
- TLS/SSL syslog support.
- Alternate transports like streams (ex. stderr, stdout, file, …).
Installation
Python package:
pip install rfc5424-logging-handler
Usage
After installing you can use this package like this:
import logging from rfc5424logging import Rfc5424SysLogHandler logger = logging.getLogger('syslogtest') logger.setLevel(logging.INFO) sh = Rfc5424SysLogHandler(address=('10.0.0.1', 514)) logger.addHandler(sh) logger.info('This is an interesting message', extra={'msgid': 'some_unique_msgid'})
This will send the following message to the syslog server:
<14>1 2020-01-01T05:10:20.841485+01:00 myserver syslogtest 5252 some_unique_msgid - \xef\xbb\xbfThis is an interesting message
Note the UTF8 Byte order mark (BOM) preceding the message. While required by RFC 5424 section 6.4 if the message is known to be UTF-8 encoded, there are still syslog receivers that cannot handle it. To bypass this limitation, when initializing the handler Class, set the msg_as_utf8 parameter to False like this:
sh = Rfc5424SysLogHandler(address=('10.0.0.1', 514), msg_as_utf8=False)
For more examples, have a look at the documentation
Changelog
1.4.3 - 2019/05/19
Changed
- #34 Allow enterprise ID to contain sub-identifiers.
Fixed
- #31 Correct handling of failed connection attempt in TCP transport handler.
1.4.2 - 2019/04/08
Changed
- #32 address can now also be a list, making loading settings form a config file possible.
Added
- Python 3.7 tests and support.
1.4.0 - 2019/01/30
Added
- #27 Make it possible to log to streams as an alternate transport.
- Added API documentation.
Changed
- Syslog facilities and framing options have moved from the RfcSysLogHandler class to module level variables. You may have to adjust your references to them.
1.2.1 - 2018/09/21
Fixed
- #21 Registered structured data IDs where also suffixed with an enterprise ID.
Added
- #22 Add utc_timestamp parameter to allow logging in UTC time.
1.1.2 - 2018/02/03
Fixed
1.1.0 - 2017/11/24
Added
- The msg parameter for the logger handler can now be absent allowing “structured data only” messages.
Fixed
- Correct the automatic value of the hostname when the value is anything other then NILVALUE
- The syslog message is now empty in conformance with RFC5424 when it’s value is None or an empty string.
1.0.3 - 2017/10/08
No functional changes. Only documentation was changed.
Added
- Logstash configuration example for RFC5424.
Changed
- Moved most of the documentation out of the readme file.
1.0.1 - 2017/08/30
Added
1.0.0 - 2017/05/30
Changed
- #10: Procid, appname and hostname can now be set per message, both with the handler as well as with the adapter
Note
This release has a slight change in behaviour. Setting one of the appnama, hostname of procid message to None or an empty string will cause it to be filled in automatically. Previously, setting it to an empty string caused it to be set to NILVALUE (a - ). You now need to set it explicilty to NILVALUE if you want to omit it from the message.
0.1.0 - 2017/01/22
Added
- #4: Adapter class to make it easier to log message IDs or structured data
- Logging of EMERGENCY, ALERT and NOTICE syslog levels by using the adapter class
- Extensive test suite
0.0.1 - 2017/01/11
- Initial release
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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size rfc5424_logging_handler-1.4.3-py2.py3-none-any.whl (15.2 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size rfc5424-logging-handler-1.4.3.tar.gz (16.5 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for rfc5424_logging_handler-1.4.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaba528e47fba3e2845d52d559885cbc27a37db42a9d265ea539b3b4452d3057 |
|
MD5 | 572376ae7f3654d3e8068f9f5c516f75 |
|
BLAKE2-256 | c545c4393bb4cff2c5ad9bd836139cb9e4b6c39e787ef8a0e0a3b85a942b6581 |
Hashes for rfc5424-logging-handler-1.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ae14073ef6d76d0c730ad6b6e3aeece841a6d413672d282876c0506dc097257 |
|
MD5 | 3811066b34382c8253348c415a3e7734 |
|
BLAKE2-256 | 038709dc32f7297408202b20aff1f68739330105307d3464c6e4d1d197e52810 |