hat-syslog - Syslog server and clients

This component 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.

For more information see:

• hat-syslog documentation
• hat-syslog git repository
• Hat Open homepage

Warning

This project is currently in state of active development. Features, functionality and API are unstable.

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
• Syslog Handler
• Syslog Generator

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.

Runtime requirements

• python >=3.8

Install

Archlinux

hat-syslog is available as AUR package:

$ yay -S hat-syslog

Windows

Windows distribution, with embedded python, is available at GutHub releases.

Python wheel

hat-syslog is available as PyPI project:

$ pip install hat-syslog

Usage

Syslog Server

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

$ hat-syslog-server

For additional details and command line options see Syslog Server.

Syslog Handler

Example python logging configuration:

import logging.conf

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})

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.

License

Copyright 2020-2023 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.