Nginx 模块

编辑

nginx 模块解析由 Nginx HTTP 服务器创建的访问日志和错误日志。

ingress_controller 文件集解析由 ingress-nginx 控制器创建的访问日志。日志模式可以在控制器的 文档中找到。

当你运行该模块时,它会在后台执行以下几项任务:

  • 设置日志文件的默认路径(但不用担心,你可以覆盖默认值)
  • 确保每个多行日志事件都作为单个事件发送
  • 使用 Elasticsearch 摄取管道来解析和处理日志行,将数据塑造成适合在 Kibana 中可视化的结构
  • 部署仪表板以可视化日志数据

阅读快速入门以了解如何配置和运行模块。

兼容性

编辑

Nginx 模块已使用 1.10 版本的日志进行了测试。

在 Windows 上,该模块已使用从 Chocolatey 存储库安装的 Nginx 进行了测试。

ingress_controller 文件集已使用 nginx-ingress-controller 的 v0.28.0 和 v0.34.1 版本进行了测试。

配置模块

编辑

你可以通过在 modules.d/nginx.yml 文件中指定 变量设置,或在命令行中覆盖设置,来进一步优化 nginx 模块的行为。

你必须在该模块中至少启用一个文件集。文件集默认情况下处于禁用状态。

以下示例显示如何在 modules.d/nginx.yml 文件中设置路径以覆盖访问日志和错误日志的默认路径

- module: nginx
  access:
    enabled: true
    var.paths: ["/path/to/log/nginx/access.log*"]
  error:
    enabled: true
    var.paths: ["/path/to/log/nginx/error.log*"]

要在命令行中指定相同的设置,你可以使用

-M "nginx.access.var.paths=[/path/to/log/nginx/access.log*]" -M "nginx.error.var.paths=[/path/to/log/nginx/error.log*]"

以下示例显示如何配置 ingress_controller 文件集,该文件集可以在 Kubernetes 环境中用于解析 ingress-nginx 日志

- module: nginx
  ingress_controller:
    enabled: true
    var.paths: ["/path/to/log/nginx/ingress.log"]

变量设置

编辑

每个文件集都有单独的变量设置,用于配置模块的行为。如果你不指定变量设置,nginx 模块将使用默认值。

对于高级用例,你还可以覆盖输入设置。请参阅覆盖输入设置

当你在命令行中指定设置时,请记住在设置前加上模块名称,例如,nginx.access.var.paths 而不是 access.var.paths

access 日志文件集设置

编辑
var.paths
一个基于 glob 的路径数组,用于指定查找日志文件的位置。此处还支持 Go Glob 支持的所有模式。例如,你可以使用通配符从预定义的子目录级别获取所有文件:/path/to/log/*/*.log。这将从 /path/to/log 的子文件夹中获取所有 .log 文件。它不会从 /path/to/log 文件夹本身获取日志文件。如果此设置为空,Filebeat 将根据你的操作系统选择日志路径。

error 日志文件集

编辑
var.paths
一个基于 glob 的路径数组,用于指定查找日志文件的位置。此处还支持 Go Glob 支持的所有模式。例如,你可以使用通配符从预定义的子目录级别获取所有文件:/path/to/log/*/*.log。这将从 /path/to/log 的子文件夹中获取所有 .log 文件。它不会从 /path/to/log 文件夹本身获取日志文件。如果此设置为空,Filebeat 将根据你的操作系统选择日志路径。

ingress_controller 日志文件集

编辑
var.paths
一个基于 glob 的路径数组,用于指定查找日志文件的位置。此处还支持 Go Glob 支持的所有模式。例如,你可以使用通配符从预定义的子目录级别获取所有文件:/path/to/log/*/*.log。这将从 /path/to/log 的子文件夹中获取所有 .log 文件。它不会从 /path/to/log 文件夹本身获取日志文件。如果此设置为空,Filebeat 将根据你的操作系统选择日志路径。

时区支持

编辑

此模块解析不包含时区信息的日志。对于这些日志,Filebeat 会读取本地时区,并在解析时使用它将时间戳转换为 UTC。用于解析的时区包含在 event.timezone 字段中的事件中。

要禁用此转换,可以使用 drop_fields 处理器删除 event.timezone 字段。

如果日志来自时区与本地时区不同的系统或应用程序,则可以使用 add_fields 处理器使用原始时区覆盖 event.timezone 字段。

有关在配置中指定处理器的信息,请参阅处理器

示例仪表板

编辑

此模块附带示例仪表板。例如

kibana nginx

字段

编辑

有关模块中每个字段的描述,请参阅导出的字段部分。