https://github.com/aboehm/pysyslogclient

Syslog client for python (RFC 3164/5424)
https://github.com/aboehm/pysyslogclient

platform-independent rfc3164 rfc5424 syslog-client unix windows

Last synced: 3 days ago
JSON representation

Syslog client for python (RFC 3164/5424)

• Host: GitHub
• URL: https://github.com/aboehm/pysyslogclient
• Owner: aboehm
• License: bsd-2-clause
• Created: 2016-01-22T13:54:24.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-17T11:35:09.000Z (over 7 years ago)
• Last Synced: 2024-11-07T14:52:42.269Z (7 days ago)
• Topics: platform-independent, rfc3164, rfc5424, syslog-client, unix, windows
• Language: Python
• Homepage:
• Size: 14.6 KB
• Stars: 13
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README
  • License: LICENSE

Awesome Lists containing this project

README

        
# pysyslogclient

Syslog client for Python 3 (RFC 3164/5424) for UNIX and Windows

## Description

Syslog client following

* RFC3164 (https://www.ietf.org/rfc/rfc3164.txt)

* RFC5424 (https://www.ietf.org/rfc/rfc5424.txt)

with UNIX and Windows support. TCP and UDP transport is possible.

If TCP is used, on every log message, that is send to the specified server,

and a connection error occured, the message will be dismissed and

a reconnect will be tried for the next message.

## Usage

A small CLI client is implemented in *client.py*. To call it, run

```

python -m pysyslogclient.cli

```

### Startup client 

To setup the client for RFC 5424 over TCP to send to SERVER:PORT:

```

import pysyslogclient

client = pysyslogclient.SyslogClientRFC5424(SERVER, PORT, proto="TCP")

```

or for RFC3164:

```

import SyslogClient

client = pysyslogclient.SyslogClientRFC3164(SERVER, PORT, proto="TCP")

```

### Log a messsage

Log the message "Hello syslog server" with standard severity *INFO* as facility

*USER*. As program name *SyslogClient* the PID of the called python interpreter

is used.

```

client.log("Hello syslog server")

```

To specify more options, call log with more arguments. For example to log a

the message as program *Logger* with PID *1* as facility *SYSTEM* with severity

*EMERGENCY*, call log the following way:

```

client.log("Hello syslog server",

	facility=pysyslogclient.FAC_SYSTEM,

	severity=pysyslogclient.SEV_EMERGENCY,

	program="Logger",

	pid=1)

```

### Shutdown

To disconnect, call

```

client.close()

```