Log Courier 项目启动与配置教程

1. 项目目录结构及介绍

Log Courier 项目是一个用于快速、安全地传输和处理日志文件的轻量级工具集。项目目录结构如下：

• .github/：包含与 GitHub Actions 相关的配置文件。
• contrib/：贡献者的脚本和工具。
• docs/：项目文档。
• fact-courier/：与 Fact Courier 相关的文件。
• lc-admin/：Log Courier 的远程管理工具。
• lc-lib/：Log Courier 的库文件。
• lc-tlscert/：TLS 证书工具。
• log-carver/：Log Carver 的相关文件。
• ruby/：Ruby 相关的脚本和文件。
• testing/：测试相关的文件。
• .editorconfig：编辑器配置文件。
• .gitignore：Git 忽略文件。
• .versionrc.js：版本控制配置文件。
• CHANGELOG.md：项目更新日志。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• commitlint.config.js：提交信息格式化配置。
• go.mod：Go 依赖管理文件。
• go.sum：Go 依赖校验文件。
• log-courier.go：Log Courier 的主 Go 文件。
• package-lock.json：npm 依赖锁定文件。
• package.json：npm 配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 log-courier.go 文件来进行的。这个文件是 Log Courier 的主入口点，它负责初始化、配置和启动 Log Courier 服务。

在终端中，您可以通过以下命令来启动 Log Courier：

go run log-courier.go

如果您已经将 Log Courier 编译成了可执行文件，也可以直接运行：

./log-courier

3. 项目的配置文件介绍

Log Courier 的配置通常是通过 YAML 格式的文件进行的。默认情况下，配置文件通常命名为 log-courier.yml。

以下是配置文件的一个基本示例：

general:
  # 设置 Log Courier 监听的地址和端口
  address: 127.0.0.1
  port: 9514

sources:
  - type: file
    # 指定日志文件的路径
    path: /var/log/syslog
    # 设置日志文件的读取权限
    permissions: 0640

destinations:
  - type: logstash
    # 设置 Logstash 服务器的地址和端口
    hosts: ["localhost:5044"]
    # 设置用于传输的 TLS 配置
    tls:
      # 启用 TLS
      enabled: true
      # 服务器证书路径
      cert: /etc/log-courier/tls/server.crt
      # 服务器私钥路径
      key: /etc/log-courier/tls/server.key

在配置文件中，您可以设置 Log Courier 的一般参数，如监听地址和端口，日志文件的路径和权限，以及目的地（如 Logstash）的配置，包括地址、端口和 TLS 配置。

确保配置文件正确无误后，可以通过以下命令启动 Log Courier 并应用配置：

./log-courier -c /path/to/log-courier.yml

替换 /path/to/log-courier.yml 为您的配置文件实际路径。