admiralobvious/tinysyslog

tinysyslog - 轻量级Syslog服务器

镜像概述和主要用途

tinysyslog是一个轻量级、简单的Syslog服务器，专注于日志轮转功能。该工具旨在提供易于部署和使用的日志收集解决方案，仅接收符合RFC 5424格式的日志，并支持将日志输出到自动轮转的文件、标准输出/错误流（适用于Docker环境）或Elasticsearch。基于Go语言开发，依赖https://github.com/mcuadros/go-syslog%E5%92%8Chttps://github.com/natefinch/lumberjack%E5%BA%93%E5%AE%9E%E7%8E%B0%E6%A0%B8%E5%BF%83%E5%8A%9F%E8%83%BD%E3%80%82

核心功能与特性

• 轻量级设计：资源占用低，部署简单，适合嵌入式环境和容器化场景
• RFC 5424合规：仅接收和处理符合RFC 5424标准格式的Syslog日志
• 日志轮转机制：支持按文件大小、保留时间和备份数量自动轮转日志文件
• 多输出接收器：可同时将日志发送到多个目标：
  • 控制台（stdout/stderr）
  • 文件系统（带轮转功能）
  • Elasticsearch（支持多种认证方式）
• 日志处理能力：
  • 日志过滤（基于正则表达式）
  • 日志转换（文本/JSON格式转换）
• 多协议支持：可配置TCP或UDP协议，默认同时支持两者

使用场景与适用范围

• Docker环境日志收集：输出到stdout/stderr，便于Docker日志驱动收集和处理
• 小型服务器日志管理：轻量级替代复杂日志系统，适用于资源受限环境
• 开发/测试环境：快速部署，用于调试应用程序Syslog输出
• 边缘设备日志聚合：低资源占用特性适合嵌入式或边缘计算场景
• Elasticsearch集成：需要将Syslog日志集中存储和分析的场景

使用方法

本地快速启动

shell
git clone https://github.com/alexferl/tinysyslog.git
cd tinysyslog
make run

服务启动成功后，将显示以下日志：

shell
2023-08-30T18:38:09-04:00 INF server.go:52 > tinysyslog starting
2023-08-30T18:38:09-04:00 INF server.go:63 > tinysyslog listening on 127.0.0.1:5140

测试日志接收：

shell
nc -w0 -u 127.0.0.1 5140 <<< '<165>1 2016-01-01T12:01:21Z hostname appname 1234 ID47 [exampleSDID@32473 iut="9" eventSource="test" eventID="123"] message'

成功接收后，终端将输出：

shell
Jan  1 12:01:21 hostname appname[1234]: message

Docker部署

基本部署

拉取镜像：

shell
docker pull admiralobvious/tinysyslog

启动容器：

shell
docker run --rm --name tinysyslog -p 5140:5140/udp -d admiralobvious/tinysyslog

测试日志发送：

shell
nc -w0 -u 127.0.0.1 5140 <<< '<165>1 2016-01-01T12:01:21Z hostname appname 1234 ID47 [exampleSDID@32473 iut="9" eventSource="test" eventID="123"] message'

验证日志接收：

shell
docker logs tinysyslog

预期输出：

shell
2023-08-30T22:46:06Z INF build/server.go:52 > tinysyslog starting
2023-08-30T22:46:06Z INF build/server.go:63 > tinysyslog listening on 0.0.0.0:5140
Jan  1 12:01:21 hostname appname[1234]: message

Docker Compose示例

yaml
version: '3.8'
services:
  tinysyslog:
    image: admiralobvious/tinysyslog
    container_name: tinysyslog
    ports:
      - "5140:5140/udp"
      - "5140:5140/tcp"  # 如需TCP支持
    volumes:
      - ./syslog-logs:/app  # 持久化日志文件
    command:
      --bind-addr 0.0.0.0:5140
      --sinks filesystem,console
      --sink-filesystem-filename /app/syslog.log
      --sink-filesystem-max-size 50  # 50MB后轮转
      --sink-filesystem-max-backups 5
      --log-level INFO

Kubernetes部署

应用部署清单：

shell
kubectl apply -f kubernetes/tinysyslog.yaml

验证Pod状态：

shell
kubectl get pods | grep tinysyslog

预期输出：

shell
tinysyslog-6c85886f65-q9cxw          1/1       Running   0          1m

查看启动日志：

shell
kubectl logs tinysyslog-6c85886f65-q9cxw

应用可通过服务名tinysyslog:5140发送日志到该服务。

配置说明

tinysyslog通过命令行参数进行配置，支持多种运行时参数调整。以下是主要配置参数说明：

基本配置

网络配置

日志处理配置

接收器配置

控制台接收器

文件系统接收器

Elasticsearch接收器

接收器选择