syslog2irc 0.11

Requirements

• Python 3.7+

• irc

• blinker

• syslogmp

Installation

syslog2IRC and its dependencies can be installed via pip:

$ pip install syslog2irc

Configuration

*.*     @host-to-send-log-messages-to-and-this-script-runs-on

*.*     @host-to-send-log-messages-to-and-this-script-runs-on:11514

[irc.server]
host = "irc.server.example"  # optional
port = 6667                  # optional
ssl = false                  # optional
password = "t0ps3cr3t"       # optional
rate_limit = 0.5             # optional; limit of messages per second

[irc.bot]
nickname = "syslog"
realname = "syslog"          # optional

[irc]
channels = [
  { name = "#examplechannel1" },
  { name = "#examplechannel2", password = "zePassword" },
]

[routes]
# routing for syslog messages from the ports on which they are
# received to the IRC channels they should be announced on
514 = [ '#examplechannel1' ]
55514 = [ '#examplechannel2' ]

[routes]
514 = [ '#examplechannel1' ]

[routes]
514 = [ '#examplechannel1', '#examplechannel2' ]
55514 = [ '#examplechannel2' ]

IRC Dummy Mode

If no value for irc.server.host is set (the property is missing or commented out), syslog2IRC will not attempt to connect to an IRC server and start in IRC dummy mode.

In this mode, it will still receive syslog messages, but it will write them to STDOUT. This can be helpful during setup of syslog message reception.

Abort execution by pressing <Control-C>.

Usage

Start syslog2IRC with a configuration file:

$ syslog2irc config.toml

Send some messages to syslog2IRC using your system’s syslog message sender tool (logger, in this example):

$ logger 'Hi there!'
$ logger -p kern.alert 'Whoa!'

Note that each message will appear twice on the console syslog2IRC was started because the handler itself will write it there anyway (so you have a log on what would be sent to IRC).

If receiving syslog messages works and you have been using IRC dummy mode so far, specify an IRC server in the configuration file, then start as above:

$ syslog2irc config.toml

After a moment, you should see that syslog2IRC has connected to the IRC server. The bot should then enter the channel(s) you have configured (see Configuration).

Further Reading

For more information, see RFC 3164, “The BSD syslog Protocol”.

Please note that there is RFC 5424, “The Syslog Protocol”, which obsoletes RFC 3164. syslog2IRC, however, only implements the latter.

Copyright:

2007-2021 Jochen Kupperschmidt

License:

MIT, see LICENSE for details.

Version 0.11

Released 2021-04-21

• Introduced configuration file. Removed the CLI arguments that have been replaced by it.

• Moved configuration of IRC channels to join and ports-to-channels routes to configuration file.

• Provided an actual syslog2irc command.

• Published the package to the Python Package Index to allow installing from there.

• Added support for IRC server password.

• Added support for a rate limit for the IRC connection, i.e. the maximum number of messages per second to send. This can prevent the bot from getting kicked (or even banned) from a channel because of flooding.

• Added Dockerfile.

• Added command line option --version to show syslog2IRC’s version.

Version 0.10

Released 2021-04-20

• Removed support for unsupported Python versions 2.7, 3.3, 3.4, and 3.5.

• Added support for Python 3.7, 3.8, and 3.9.

• Split the single module into several modules inside a namespace package and a start script. Refactored a lot.

• Added type hints.

• Expect channels in routing configuration to be in sets, not lists.

• A custom formatter for syslog messages can be specified.

• Made bot properly disconnect from IRC with a quit message on shutdown.

• Removed handler to request shutdown via IRC private message.

• Require blinker version 1.4.

• Require irc version 19.0.1.

• Require syslogmp version 0.4.

Version 0.9.1

Released 2015-09-09

• Exposed programmatic entry point to pass arguments from Python code rather than the command line.

• Introduced signal to indicate an approved message. Decoupled processor and announcer.

• Wrapped print calls in a slightly higher-level, timestamped logging function.

• Added and improved tests.

• Created manifest template to package all files relevant for distribution.

Version 0.9

Released 2015-09-08

• Adapted to version 0.2 of syslogmp.

• Spread tests to separate modules.

• Added support to connect to IRC servers via SSL (suggested by Jonas Alexandersson).

Version 0.8

Released 2015-08-10

• Dropped support for Python 3.2.

• The syslog message parser was moved into the new ‘syslogmp’ package.

Version 0.7

Released 2014-05-19

Version 0.6

Released 2014-05-15

Version 0.5

Released 2013-07-22

Version 0.2–0.4

unknown

Version 0.1

Released 2007-04-12