Skip to main content

An up-to-date, RFC5424-Compliant syslog handler for the Python logging framework

Project description

Documentation Status

An up-to-date, RFC 5424 compliant syslog handler for the Python logging framework.


  • 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, …).


Python package:

pip install rfc5424-logging-handler


After installing you can use this package like this:

import logging
from rfc5424logging import Rfc5424SysLogHandler

logger = logging.getLogger('syslogtest')

sh = Rfc5424SysLogHandler(address=('', 514))
logger.addHandler(sh)'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=('', 514), msg_as_utf8=False)

For more examples, have a look at the documentation


1.4.3 - 2019/05/19


  • #34 Allow enterprise ID to contain sub-identifiers.


  • #31 Correct handling of failed connection attempt in TCP transport handler.

1.4.2 - 2019/04/08


  • #32 address can now also be a list, making loading settings form a config file possible.


  • Python 3.7 tests and support.

1.4.1 - 2019/02/16


  • #29 Fix AttributeError when using TLS connection.

1.4.0 - 2019/01/30


  • #27 Make it possible to log to streams as an alternate transport.

  • Added API documentation.


  • 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.3.0 - 2018/10/19


  • #23 Add support for TLS/SSL

1.2.1 - 2018/09/21


  • #21 Registered structured data IDs where also suffixed with an enterprise ID.


  • #22 Add utc_timestamp parameter to allow logging in UTC time.

1.1.2 - 2018/02/03


  • #15 When logging to /dev/log with python 2.7, the connection was permanently lost when the local syslog server was restarted.

  • #16 The extra info of a message did not overwrite that of the logging adapter instance.

1.1.1 - 2017/12/08


  • #14 Fixed handling of extra parameter in logging adapter.

1.1.0 - 2017/11/24


  • The msg parameter for the logger handler can now be absent allowing “structured data only” messages.


  • 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.


  • Logstash configuration example for RFC5424.


  • Moved most of the documentation out of the readme file.

1.0.2 - 2017/08/31


1.0.1 - 2017/08/30


  • #12: It’s now possible to send syslog messages as MSG-ANY which suppresses the UTF-8 byte order mark (BOM) when sending messages.

1.0.0 - 2017/05/30


  • #10: Procid, appname and hostname can now be set per message, both with the handler as well as with the adapter

0.2.0 - 2017/01/27


  • Better input handling

  • Better sanitizing of invalid input

0.1.0 - 2017/01/22


  • #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.2 - 2017/01/18


  • #5 Introduced Python 2.7 compatibility

0.0.1 - 2017/01/11

  • Initial release

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rfc5424-logging-handler-1.4.3.tar.gz (16.5 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page