egis/papertrail

PaperTrail基础镜像文档

概述

PaperTrail基础镜像是构建与PaperTrail日志管理服务集成应用的底层支撑镜像。该镜像基于轻量级Linux发行版（如Alpine或Debian Slim）构建，预装日志收集与转发工具，提供标准化日志处理基础环境，旨在简化应用与PaperTrail服务的对接流程，降低日志集中管理的配置复杂度。

核心功能与特性

• 预置日志工具链：集成rsyslog/syslog-ng等日志收集工具，支持日志文件监控与系统日志捕获
• PaperTrail兼容配置：内置日志转发模板，支持通过环境变量快速配置PaperTrail服务地址与端口
• 多日志源支持：支持文件日志、标准输出(stdout/stderr)、系统日志等多类型日志采集
• 轻量级设计：基于精简基础镜像构建，最小化镜像体积，减少资源占用
• 可扩展性：预留自定义配置接口，支持通过挂载文件覆盖默认日志规则

适用场景

• 容器化应用需将日志集中转发至PaperTrail进行管理与分析
• 微服务架构中多服务日志统一收集与集中存储
• 开发/测试环境快速搭建日志集成验证环境
• 需要满足合规性要求的应用（如***、***）日志审计场景

使用方法

基本部署示例

通过docker run命令快速启动基础环境：

bash
docker run -d --name papertrail-base \
  -e PAPERTRAIL_HOST=logs.papertrailapp.com \
  -e PAPERTRAIL_PORT=514 \
  -e LOG_LEVEL=info \
  -v /path/to/application/logs:/var/log/app \
  docker.xuanyuan.run/papertrail/base-image:latest

Docker Compose配置

在docker-compose.yml中集成：

yaml
version: '3'
services:
  app:
    image: docker.xuanyuan.run/your-application-image
    depends_on:
      - papertrail
  papertrail:
    image: docker.xuanyuan.run/papertrail/base-image:latest
    environment:
      - PAPERTRAIL_HOST=logs.papertrailapp.com
      - PAPERTRAIL_PORT=514
      - LOG_PATH=/var/log/app
    volumes:
      - /path/to/application/logs:/var/log/app

环境变量配置说明

数据卷挂载

自定义日志规则

如需调整日志采集规则，可通过挂载自定义配置文件实现：

bash
docker run -d --name papertrail-base \
  -e PAPERTRAIL_HOST=logs.papertrailapp.com \
  -e PAPERTRAIL_PORT=514 \
  -v /path/to/custom-rsyslog.conf:/etc/rsyslog.d/99-custom.conf \
  docker.xuanyuan.run/papertrail/base-image:latest

配置参数说明

• 日志转发目标：通过PAPERTRAIL_HOST和PAPERTRAIL_PORT指定PaperTrail服务端点，需从PaperTrail控制台获取专属地址
• 日志文件监控：默认监控LOG_PATH目录下所有.log文件，支持通配符路径配置（如/var/log/app/*.log）
• 系统日志采集：默认开启对容器内/var/log/syslog和/var/log/messages的监控，可通过环境变量DISABLE_SYSLOG=false关闭

注意事项

• 确保PAPERTRAIL_PORT与PaperTrail服务端配置的端口一致（通常为514/UDP或自定义TCP端口）
• 宿主机需开放容器到PaperTrail服务的网络连接（防火墙策略配置）
• 日志文件目录挂载需保证容器内进程对挂载目录有读权限
• 生产环境建议使用固定版本标签（如:1.0.0）而非:latest，避免版本变更风险