Logster 项目使用教程
项目地址: https://gitcode.com/gh_mirrors/lo/logster 1. 项目的目录结构及介绍
Logster 项目的目录结构如下：
logster/
├── bin/
├── contrib/
├── docs/
├── logster/
├── tests/
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
└── setup.py
目录结构介绍：
- bin/: 存放可执行文件的目录。
- contrib/: 存放贡献代码的目录。
- docs/: 存放项目文档的目录。
- logster/: 存放 Logster 核心代码的目录。
- tests/: 存放测试代码的目录。
- .gitignore: Git 忽略文件配置。
- .travis.yml: Travis CI 配置文件。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍和使用说明。
- setup.py: 项目安装脚本。
2. 项目的启动文件介绍
Logster 的启动文件是 logster 脚本，位于 bin/ 目录下。该脚本用于读取日志文件并生成指标，支持多种输出方式，如 Graphite、Ganglia、Amazon CloudWatch 等。
启动文件介绍：
- logster: 这是一个 Python 脚本，用于启动 Logster 并解析日志文件。它通过命令行参数指定日志文件路径、解析器和输出方式。
使用示例：
$ sudo /usr/bin/logster --dry-run --output=ganglia SampleLogster /var/log/httpd/access_log
3. 项目的配置文件介绍
Logster 的配置主要通过命令行参数进行，没有独立的配置文件。以下是一些常用的配置选项：
常用配置选项：
- --tailer: 指定日志文件的读取方式，可选值为
logtail和pygtail。默认使用logtail。 - --logtail: 指定
logtail工具的路径，默认路径为/usr/sbin/logtail2。 - --metric-prefix: 为所有发布的指标添加前缀。
- --metric-suffix: 为所有发布的指标添加后缀。
- --parser-help: 打印所选解析器的使用说明和选项。
- --parser-options: 传递给 Logster 解析器的选项。
- --state-dir: 指定存储 tailer 状态文件的目录，默认路径为
/var/run。 - --log-dir: 指定存储 Logster 日志文件的目录，默认路径为
/var/log/logster。 - --log-conf: 指定日志配置文件的路径。
- --output: 指定指标的输出方式，可选值包括
statsd、stdout、cloudwatch、graphite、ganglia、nsca或自定义的 Python 类名。 - --dry-run: 解析日志文件但不发送指标，而是将指标输出到标准输出。
- --debug: 提供更详细的日志输出，用于调试。
配置示例：
$ sudo /usr/bin/logster --tailer=pygtail --metric-prefix=my_prefix --output=graphite --graphite-host=graphite.example.com:2003 SampleLogster /var/log/httpd/access_log
通过以上配置选项，您可以根据实际需求灵活配置 Logster 的行为。