Google Cloud module
editGoogle Cloud module
editThis is a module for Google Cloud logs. It supports reading audit, VPC flow, and firewall logs that have been exported from Stackdriver to a Google Pub/Sub topic sink.
When you run the module, it performs a few tasks under the hood:
- Sets the default paths to the log files (but don’t worry, you can override the defaults)
- Makes sure each multiline log event gets sent as a single event
- Uses an Elasticsearch ingest pipeline to parse and process the log lines, shaping the data into a structure suitable for visualizing in Kibana
Read the quick start to learn how to configure and run modules.
Configure the module
editYou can further refine the behavior of the gcp
module by specifying
variable settings in the
modules.d/gcp.yml
file, or overriding settings at the command line.
You must enable at least one fileset in the module. Filesets are disabled by default.
Variable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the gcp
module uses
the defaults.
For advanced use cases, you can also override input settings. See Override input settings.
When you specify a setting at the command line, remember to prefix the
setting with the module name, for example, gcp.audit.var.paths
instead of audit.var.paths
.
audit
fileset settings
editExample config:
- 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
-
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system. -
var.project_id
- Google Cloud project ID.
-
var.topic
- Google Cloud Pub/Sub topic name.
-
var.subscription_name
- Google Cloud Pub/Sub topic subscription name. If the subscription does not exist it will be created.
-
var.credentials_file
- Path to a JSON file containing the credentials and key used to subscribe.
-
var.keep_original_message
-
Flag to control whether the original message is stored in the
log.original
field. Defaults tofalse
, meaning the original message is not saved.
vpcflow
fileset settings
editExample config:
- 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
-
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system. -
var.project_id
- Google Cloud project ID.
-
var.topic
- Google Cloud Pub/Sub topic name.
-
var.subscription_name
- Google Cloud Pub/Sub topic subscription name. If the subscription does not exist it will be created.
-
var.credentials_file
- Path to a JSON file containing the credentials and key used to subscribe.
-
var.keep_original_message
-
Flag to control whether the original message is stored in the
log.original
field. Defaults tofalse
, meaning the original message is not saved.
firewall
fileset settings
editExample config:
- 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
-
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system. -
var.project_id
- Google Cloud project ID.
-
var.topic
- Google Cloud Pub/Sub topic name.
-
var.subscription_name
- Google Cloud Pub/Sub topic subscription name. If the subscription does not exist it will be created.
-
var.credentials_file
- Path to a JSON file containing the credentials and key used to subscribe.
-
var.keep_original_message
-
Flag to control whether the original message is stored in the
log.original
field. Defaults tofalse
, meaning the original message is not saved.
Fields
editFor a description of each field in the module, see the exported fields section.