Papertrail CLI 技术文档

1. 安装指南

1.1 安装 Papertrail CLI

Papertrail CLI 是一个用于从 Papertrail 日志管理服务中检索、搜索和实时跟踪日志的命令行工具。你可以通过以下步骤安装它：

$ [sudo] gem install papertrail

1.2 配置 API Token

安装完成后，你需要配置 Papertrail 的 API Token。可以通过以下两种方式配置：

1. 配置文件方式：在 ~/.papertrail.yml 文件中添加你的 API Token。

   token: 123456789012345678901234567890ab
   

   你可以从 Papertrail 的用户配置页面获取这个 Token。

2. 环境变量方式：你也可以通过设置环境变量 PAPERTRAIL_API_TOKEN 来传递 API Token。

   $ export PAPERTRAIL_API_TOKEN='abc123'
   

2. 项目的使用说明

2.1 基本使用

你可以通过以下命令查看 papertrail 的帮助信息：

$ papertrail --help

2.2 实时跟踪日志

使用 -f 或 --follow 参数可以实时跟踪日志，类似于 tail -f 命令：

$ papertrail -f "(www OR db) (nginx OR pgsql) -accepted"

2.3 时间范围搜索

你可以通过 --min-time 和 --max-time 参数指定搜索的时间范围：

$ papertrail --min-time 'yesterday at noon' --max-time 'today at 4am' -g Production

2.4 输出格式

你可以通过 -j 或 --json 参数输出 JSON 格式的日志数据：

$ papertrail -j

2.5 颜色化输出

默认情况下，日志消息的非正文部分会根据程序属性进行颜色化。你可以通过 --color 参数指定颜色化的方式：

$ papertrail --color system

3. 项目 API 使用文档

3.1 搜索日志

你可以使用 papertrail 命令进行日志搜索，支持布尔查询和实时跟踪：

$ papertrail -f "(www OR db) (nginx OR pgsql) -accepted"

3.2 添加/删除系统

Papertrail CLI 还提供了 papertrail-add-system 和 papertrail-remove-system 命令，用于添加或删除系统：

$ papertrail-add-system --help
$ papertrail-remove-system --help

3.3 创建/加入组

你可以使用 papertrail-add-group 和 papertrail-join-group 命令创建新组或将系统加入组：

$ papertrail-add-group --help
$ papertrail-join-group --help

4. 项目安装方式

4.1 通过 RubyGems 安装

你可以通过 RubyGems 安装 Papertrail CLI：

$ [sudo] gem install papertrail

4.2 配置 API Token

安装完成后，配置 API Token 以便使用 Papertrail CLI：

$ echo "token: 123456789012345678901234567890ab" > ~/.papertrail.yml

4.3 验证安装

你可以通过以下命令验证安装是否成功：

$ papertrail --version

如果安装成功，你将看到 Papertrail CLI 的版本信息。

---

通过本文档，你应该能够顺利安装、配置并使用 Papertrail CLI 进行日志管理和搜索。如果你有任何问题，可以参考项目的 GitHub Wiki 或联系 Papertrail 支持团队。