.. |syslog-server-video| replace:: https://user-images.githubusercontent.com/26526989/237474681-83b9d74a-f95d-4032-a279-12252d052bc9.mp4

.. _Syslog Server: https://hat-syslog.hat-open.com/server.html .. _Syslog Handler: https://hat-syslog.hat-open.com/handler.html .. _Syslog Generator: https://hat-syslog.hat-open.com/generator.html

.. _online documentation: https://hat-syslog.hat-open.com .. _git repository: https://github.com/hat-open/hat-syslog.git

.. _RFC 5425: https://tools.ietf.org/html/rfc5425 .. _RFC 5426: https://tools.ietf.org/html/rfc5426 .. _RFC 6587: https://tools.ietf.org/html/rfc6587

.. _AUR package: https://aur.archlinux.org/packages/hat-syslog .. _GitHub releases: https://github.com/hat-open/hat-syslog/releases .. _PyPI project: https://pypi.org/project/hat-syslog .. _Docker image: https://hub.docker.com/r/bozokopic/hat-syslog

.. _pydoit: https://pydoit.org

.. _Hat Open: https://hat-open.com .. _Končar Digital: https://www.koncar.hr/en

hat-syslog - Syslog Server and tools

|syslog-server-video|

About

hat-syslog provides server/client tooling based on Syslog logging protocol as defined by RFC 5425, RFC 5426 and RFC 6587_.

This project includes implementations of:

• Syslog Server_

  Central concentrator for syslog messages with web interface for real time monitoring and filtering of log messages.

• Syslog Handler_

  Implementation of Python's standard library logging.Handler based on dedicated background logging thread.

• Syslog Generator_

  Simple testing tool responsible for generating syslog messages.

For more information see:

• online documentation_
• git repository_

Runtime requirements

• python >=3.10

Install

Debian ''''''

WIP

Archlinux '''''''''

hat-syslog is available as AUR package_::

$ yay -S hat-syslog

Windows '''''''

Windows distribution, with embedded python, is available at GitHub releases_.

Python wheel ''''''''''''

hat-syslog is available as PyPI project_::

$ pip install hat-syslog

Docker ''''''

Syslog Server is available as Docker image_::

$ mkdir -p ~/.local/share/hat
$ docker run -p 6514:6514/tcp \
             -p 6514:6514/udp \
             -p 23020:23020 \
             -v $(cd; pwd)/.local/share/hat:/hat-syslog \
             bozokopic/hat-syslog

Usage

Syslog Server '''''''''''''

Command hat-syslog-server is used for running new Syslog Server instance::

$ hat-syslog-server

Once server is running, web UI is available at <http://127.0.0.1:23020>_.

For additional details and command line options see Syslog Server_.

Syslog Handler ''''''''''''''

Example python logging configuration:

.. code:: python

import logging.config

logging.config.dictConfig({
    'version': 1,
    'formatters': {
        'default': {}},
    'handlers': {
        'syslog': {
            'class': 'hat.syslog.handler.SyslogHandler',
            'host': '127.0.0.1',
            'port': 6514,
            'comm_type': 'TCP',
            'level': 'DEBUG',
            'formatter': 'default'}},
    'root': {
        'level': 'INFO',
        'handlers': ['syslog']},
    'disable_existing_loggers': False})

logger = logging.getLogger(__name__)
logger.info('spam')

For additional details see Syslog Handler_.

Syslog Generator ''''''''''''''''

Command hat-syslog-generator is used for running Syslog Generator::

$ hat-syslog-generator

For additional details and command line options see Syslog Generator_.

Development requirements

• python >=3.10
• nodejs >=7

Build

To install editable installation, together with python development dependencies, run::

$ pip install --group dev -e .

Build tool used for hat-syslog is pydoit_. For listing available doit tasks, use::

$ doit list

Default task::

$ doit

creates wheel package inside build directory.

Hat Open

hat-syslog is part of Hat Open_ project - open-source framework of tools and libraries for developing applications used for remote monitoring, control and management of intelligent electronic devices such as IoT devices, PLCs, industrial automation or home automation systems.

Development of Hat Open and associated repositories is sponsored by Končar Digital_.

License

Copyright 2020-2026 Hat Open AUTHORS

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.