首页
/ 项目技术文档:remote_syslog

项目技术文档:remote_syslog

2024-12-20 21:26:52作者:贡沫苏Truman

1. 安装指南

安装步骤

  1. 使用以下命令安装 remote_syslog gem:

    $ [sudo] gem install remote_syslog
    
  2. 可选步骤:创建一个 log_files.yml 文件,指定要读取的日志文件路径以及日志发送的目标主机和端口(参考 examples/log_files.yml.example)。这些配置也可以通过命令行参数指定。

自动启动

  1. 将示例的 init 文件复制到系统中:

    $ cp examples/remote_syslog.init.d /etc/init.d/remote_syslog
    $ chmod 755 /etc/init.d/remote_syslog
    
  2. 确保 remote_syslog 在系统启动时自动启动:

    $ sudo update-rc.d remote_syslog defaults
    

    或者手动创建链接:

    $ sudo ln -s /etc/init.d/remote_syslog /etc/rc3.d/S30remote_syslog
    

使用 RVM

如果使用 Ruby 版本管理器(如 RVM),需要在 init 文件中加载 RVM 环境。可以参考 RVM 的 init.d 集成指南 创建一个 wrapper 脚本。

2. 项目使用说明

基本用法

$ remote_syslog [OPTION]... <FILE>...

常用选项

  • -c, --configfile PATH:指定配置文件路径(默认 /etc/log_files.yml
  • -d, --dest-host HOSTNAME:指定目标 syslog 主机名或 IP(默认 logs.papertrailapp.com
  • -p, --dest-port PORT:指定目标 syslog 端口(默认 514
  • -D, --no-detach:不以守护进程方式运行
  • -f, --facility FACILITY:指定设施(默认 user
  • --hostname HOST:指定本地主机名
  • -P, --pid-dir DIRECTORY:已弃用:指定 PID 文件目录
  • --pid-file FILENAME:指定 PID 文件路径(默认 /var/run/remote_syslog.pid
  • --parse-syslog:解析文件为 syslog 格式
  • -s, --severity SEVERITY:指定日志级别(默认 notice
  • --strip-color:去除颜色代码
  • --tls:通过 TLS 连接
  • --tcp:通过 TCP 连接(无 TLS)
  • --new-file-check-interval INTERVAL:检查新文件的时间间隔

示例

  1. 使用配置文件 configs/logs.yml 和端口 12345 发送 /var/log/mysqld.log 的日志:

    $ remote_syslog -c configs/logs.yml -p 12345 /var/log/mysqld.log
    
  2. 不以守护进程方式运行,使用 /etc/log_files.yml 配置文件,PID 文件路径为 /tmp/remote_syslog.pid,发送日志到 a.example.com:514

    $ remote_syslog -D -d a.example.com -f local0 --pid-file /tmp/remote_syslog.pid /var/log/mysqld.log
    

3. 项目API使用文档

配置文件格式

log_files.yml 文件格式如下:

files:
  - /var/log/httpd/access_log
  - /var/log/httpd/error_log
  - /var/log/mysqld.log
  - /var/run/mysqld/mysqld-slow.log
destination:
  host: logs.papertrailapp.com
  port: 12345

高级配置

  1. 覆盖主机名

    hostname: somehostname
    
  2. 验证服务器证书

    ssl_server_cert: syslog.crt
    
  3. 使用客户端证书

    ssl_client_cert_chain: syslog_client.crt
    ssl_client_private_key: syslog_client.key
    
  4. 排除文件

    exclude_files:
      - \.\d$
      - .bz2
      - .gz
    

4. 项目安装方式

安装命令

$ [sudo] gem install remote_syslog

配置文件

默认情况下,remote_syslog 会查找 /etc/log_files.yml 配置文件。可以参考 examples/log_files.yml.example 创建配置文件。

启动命令

$ remote_syslog -c configs/logs.yml -p 12345 /var/log/mysqld.log

自动启动

通过 init 文件或手动启动脚本实现自动启动。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8