ryansteffan/simply_syslog

simply_syslog

一个极其简单的开源syslog服务器，使用Python编写。该服务器旨在与Docker配合使用，提供易于配置、部署和扩展的syslog服务。

核心功能与特性

已支持功能

• UDP syslog支持
• 支持Docker部署
• 高度可配置
• 能处理大量请求

即将推出功能

• TCP支持
• 加密支持

使用场景与适用范围

适用于需要轻量级、可快速部署的syslog服务器场景，尤其适合Docker环境中的日志收集，可满足处理大量syslog请求的需求，支持自定义配置以适应不同的日志处理要求。

使用方法

Docker快速启动指南（推荐）

这是设置服务器的推荐方法。

拉取镜像

bash
docker pull ryansteffan/simply_syslog

运行容器

使用默认配置启动容器：

bash
docker run -d --name simply_syslog --restart always -p 514:514/udp -v /var/lib/docker/volume/simply_syslog:/var/log/simply_syslog/ ryansteffan/simply_syslog

参数说明：

• -d：后台运行容器
• --name simply_syslog：指定容器名称
• --restart always：容器退出时自动重启
• -p 514:514/udp：映射UDP端口514（syslog默认端口）
• -v /var/lib/docker/volume/simply_syslog:/var/log/simply_syslog/：挂载宿主机目录到容器内，用于持久化日志文件

自定义配置

服务器的所有其他配置通过-e标志向容器传递环境变量实现，例如禁用调试日志：

bash
docker run -d --name simply_syslog --restart always -p 514:514/udp -e DEBUG_MESSAGES=False -v /var/lib/docker/volume/simply_syslog:/var/log/simply_syslog/ ryansteffan/simply_syslog

裸机启动指南（不推荐）

虽然Docker是主要部署方式，也可在裸机上运行，但需手动配置后台运行。

前置条件

• 安装Python 3.12（旧版3.x可能兼容，但不支持问题修复）

部署步骤

1. 克隆代码库：

   bash
   git clone https://github.com/TheTurnnip/simply_syslog.git
   

2. 进入服务器目录：

   bash
   cd simply_syslog
   

3. 编辑配置文件（config/config.json），参考配置指南
4. 启动服务器：

   bash
   python3 ./main.py  # Linux/macOS
   # 或 python ./main.py  # Windows
   

配置设置指南

配置参数说明

部分设置详情

• 日志文件要求：服务器需要预先创建日志文件。确保SYSLOG_PATH指定的目录已存在，且目录下有名为syslog.log的文件。

• BUFFER_LIFESPAN：建议设置不超过5秒。过高可能导致日志长时间不写入文件，且断电时可能丢失数据。

• BUFFER_LENGTH：建议值不超过256。过大虽可减少磁盘写入频率，但会增加单次写入时间，需根据网络中设备数量和请求量调整。

漏洞报告

如发现代码漏洞，请通过GitHub仓库的安全部分（https://github.com/TheTurnnip/simply_syslog%EF%BC%89%E6%8A%A5%E5%91%8A%E9%97%AE%E9%A2%98%E3%80%82