Logtrail 使用与安装指南

Logtrail 使用与安装指南

项目地址:https://gitcode.com/gh_mirrors/lo/logtrail

1. 项目目录结构及介绍

Logtrail 是一个为 Kibana 设计的插件，用于实时查看、分析和搜索来自多个主机的日志事件。基于 Papertrail 风格的界面，它使得日志管理变得既干净又简单。以下是当您下载并解压 Logtrail 的源代码或发布版本时典型的目录结构：

logtrail/
├── package.json      // Node.js 包管理配置文件
├── src/              // 源码目录，包含Kibana插件的主要JavaScript和React组件
│   ├── components/    // UI组件
│   ├── services/      // 后端服务交互逻辑
│   └── ...
├── test/             // 测试文件
├── logtrail.json     // 配置模板或者示例配置文件
├── README.md         // 主要的项目说明文件
├── ...               // 其他依赖和文档文件

注意： 实际部署时，用户通常不需要直接操作这些源码文件，而是通过Kibana插件系统进行安装。

2. 项目的启动文件介绍

Logtrail 本身不直接提供一个独立的“启动文件”，它的运行依赖于 Kibana。安装步骤涉及在 Kibana 中添加这个插件，之后 Kibana 的启动将自动加载 Logtrail 插件。具体来说，安装过程通常包括以下命令（以特定版本为例）：

# 对于 Kibana 7.9.2 版本
/bin/kibana-plugin install https://github.com/sivasamyk/logtrail/releases/download/v0.1.31/logtrail-7.9.2-0.1.31.zip

完成上述命令并在 Kibana 重启之后，Logtrail 就会被激活，并且没有单独的启动脚本去驱动 Logtrail，它是作为 Kibana 运行的一部分存在。

3. 项目的配置文件介绍

Logtrail 的主要配置位于 logtrail.json 文件中，虽然此文件可能默认位于插件安装目录内，如 /plugins/logtrail。用户的实际配置可以根据需要调整，主要涵盖以下几个关键字段：

• default_index: 默认的 Elasticsearch 索引名，用来存储日志数据，默认值通常是 logstash-*。
• default_time_range_in_days: 不指定时间范围时，显示的日志事件将限制在这多少天内，默认为30天。设为0可查看所有历史记录。
• display_timezone: 控制事件查看器中的时间戳显示时区，缺省值是浏览器的本地时区。
• display_timestamp_format: 时间戳的展示格式。
• default_search: 可选，默认的搜索文本，插件启动时即应用该搜索条件。

配置文件示例

假设您的 logtrail.json 如下所示：

{
  "default_index": "myapp-logs-*",
  "default_time_range_in_days": 7,
  "display_timezone": "Asia/Shanghai",
  "display_timestamp_format": "yyyy-MM-dd HH:mm:ss.SSS",
  "default_search": ""
}

这个配置告诉 Logtrail 使用索引 myapp-logs-*，默认查找过去7天内的日志，时间显示为中国上海时区，并且按照特定的时间戳格式呈现。

请注意，具体的配置细节可能会随着 Logtrail 的不同版本有所变化，因此在实际应用前务必参考其最新的文档或源码中提供的README.md。

logtrail Kibana plugin to view, search & live tail log events 项目地址: https://gitcode.com/gh_mirrors/lo/logtrail