Google Cloud 模块

编辑

这是一个用于 Google Cloud 日志的模块。它支持读取从 Stackdriver 导出到 Google Pub/Sub 主题接收器的审核、VPC 流量和防火墙日志。

运行模块时,它会在后台执行一些任务

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

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

配置模块

编辑

您可以通过在 modules.d/gcp.yml 文件中指定 变量设置 或覆盖命令行中的设置来进一步完善 gcp 模块的行为。

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

变量设置

编辑

每个文件集都有单独的变量设置来配置模块的行为。如果您未指定变量设置,则 gcp 模块将使用默认值。

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

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

audit 文件集设置

编辑
filebeat gcp audit

示例配置

- module: gcp
  audit:
    enabled: true
    var.project_id: my-gcp-project-id
    var.topic: gcp-vpc-audit
    var.subscription_name: filebeat-gcp-audit-sub
    var.credentials_file: ${path.config}/gcp-service-account-xyz.json
    var.keep_original_message: false
var.paths
指定在哪里查找日志文件的基于 glob 的路径数组。此处还支持 Go Glob 支持的所有模式。例如,您可以使用通配符从预定义级别的子目录中获取所有文件:/path/to/log/*/*.log。这将获取 /path/to/log 的子文件夹中的所有 .log 文件。它不会获取 /path/to/log 文件夹本身的日志文件。如果此设置为空,则 Filebeat 将根据您的操作系统选择日志路径。
var.project_id
Google Cloud 项目 ID。
var.topic
Google Cloud Pub/Sub 主题名称。
var.subscription_name
Google Cloud Pub/Sub 主题订阅名称。如果订阅不存在,则会创建它。
var.credentials_file
包含用于订阅的凭据和密钥的 JSON 文件的路径。
var.keep_original_message
用于控制原始消息是否存储在 log.original 字段中的标志。默认为 false,表示不保存原始消息。

vpcflow 文件集设置

编辑

示例配置

- module: gcp
  vpcflow:
    enabled: true
    var.project_id: my-gcp-project-id
    var.topic: gcp-vpc-flowlogs
    var.subscription_name: filebeat-gcp-vpc-flowlogs-sub
    var.credentials_file: ${path.config}/gcp-service-account-xyz.json
    var.keep_original_message: false
var.paths
指定在哪里查找日志文件的基于 glob 的路径数组。此处还支持 Go Glob 支持的所有模式。例如,您可以使用通配符从预定义级别的子目录中获取所有文件:/path/to/log/*/*.log。这将获取 /path/to/log 的子文件夹中的所有 .log 文件。它不会获取 /path/to/log 文件夹本身的日志文件。如果此设置为空,则 Filebeat 将根据您的操作系统选择日志路径。
var.project_id
Google Cloud 项目 ID。
var.topic
Google Cloud Pub/Sub 主题名称。
var.subscription_name
Google Cloud Pub/Sub 主题订阅名称。如果订阅不存在,则会创建它。
var.credentials_file
包含用于订阅的凭据和密钥的 JSON 文件的路径。
var.keep_original_message
用于控制原始消息是否存储在 log.original 字段中的标志。默认为 false,表示不保存原始消息。

firewall 文件集设置

编辑

示例配置

- module: gcp
  firewall:
    enabled: true
    var.project_id: my-gcp-project-id
    var.topic: gcp-vpc-firewall
    var.subscription_name: filebeat-gcp-vpc-firewall-sub
    var.credentials_file: ${path.config}/gcp-service-account-xyz.json
    var.keep_original_message: false
var.paths
指定在哪里查找日志文件的基于 glob 的路径数组。此处还支持 Go Glob 支持的所有模式。例如,您可以使用通配符从预定义级别的子目录中获取所有文件:/path/to/log/*/*.log。这将获取 /path/to/log 的子文件夹中的所有 .log 文件。它不会获取 /path/to/log 文件夹本身的日志文件。如果此设置为空,则 Filebeat 将根据您的操作系统选择日志路径。
var.project_id
Google Cloud 项目 ID。
var.topic
Google Cloud Pub/Sub 主题名称。
var.subscription_name
Google Cloud Pub/Sub 主题订阅名称。如果订阅不存在,则会创建它。
var.credentials_file
包含用于订阅的凭据和密钥的 JSON 文件的路径。
var.keep_original_message
用于控制原始消息是否存储在 log.original 字段中的标志。默认为 false,表示不保存原始消息。

字段

编辑

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