AWS CloudWatch input
editAWS CloudWatch input
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
awscloudwatch input can be used to retrieve all logs from all log streams in a
specific log group. filterLogEvents AWS API is used to list log events from
the specified log group. Amazon CloudWatch Logs can be used to store log files
from Amazon Elastic Compute Cloud(EC2), AWS CloudTrail, Route53, and other sources.
A log group is a group of log streams that share the same retention, monitoring, and access control settings. You can define log groups and specify which streams to put into each group. There is no limit on the number of log streams that can belong to one log group.
A log stream is a sequence of log events that share the same source. Each separate source of logs in CloudWatch Logs makes up a separate log stream.
filebeat.inputs: - type: awscloudwatch log_group_arn: arn:aws:logs:us-east-1:428152502467:log-group:test:* scan_frequency: 1m credential_profile_name: elastic-beats start_position: beginning
The awscloudwatch input supports the following configuration options plus the
Common options described later.
log_group_arn
editARN of the log group to collect logs from.
log_group_name
editName of the log group to collect logs from. Note: region_name is required when log_group_name is given.
region_name
editRegion that the specified log group belongs to.
log_streams
editA list of strings of log streams names that Filebeat collect log events from.
log_stream_prefix
editA string to filter the results to include only log events from log streams that have names starting with this prefix.
start_position
editstart_position allows user to specify if this input should read log files from
the beginning or from the end.
-
beginning: reads from the beginning of the log group (default). -
end: read only new messages from current time minusscan_frequencygoing forward
For example, with scan_frequency equals to 30s and current timestamp is
2020-06-24 12:00:00:
-
with
start_position = beginning:- first iteration: startTime=0, endTime=2020-06-24 12:00:00
- second iteration: startTime=2020-06-24 12:00:00, endTime=2020-06-24 12:00:30
-
with
start_position = end:- first iteration: startTime=2020-06-24 11:59:30, endTime=2020-06-24 12:00:00
- second iteration: startTime=2020-06-24 12:00:00, endTime=2020-06-24 12:00:30
scan_frequency
editThis config parameter sets how often Filebeat checks for new log events from the
specified log group. Default scan_frequency is 1 minute, which means Filebeat
will sleep for 1 minute before querying for new logs again.
api_timeout
editThe maximum duration of AWS API can take. If it exceeds the timeout, AWS API will be interrupted. The default AWS API timeout for a message is 120 seconds. The minimum is 0 seconds.
api_sleep
editThis is used to sleep between AWS FilterLogEvents API calls inside the same
collection period. FilterLogEvents API has a quota of 5 transactions per
second (TPS)/account/Region. By default, api_sleep is 200 ms. This value should
only be adjusted when there are multiple Filebeats or multiple Filebeat inputs
collecting logs from the same region and AWS account.
aws credentials
editIn order to make AWS API calls, awscloudwatch input requires AWS credentials.
Please see AWS credentials options for more details.
AWS Permissions
editSpecific AWS permissions are required for IAM user to access awscloudwatch:
logs:FilterLogEvents
Common options
editThe following configuration options are supported by all inputs.
enabled
editUse the enabled option to enable and disable inputs. By default, enabled is
set to true.
tags
editA list of tags that Filebeat includes in the tags field of each published
event. Tags make it easy to select specific events in Kibana or apply
conditional filtering in Logstash. These tags will be appended to the list of
tags specified in the general configuration.
Example:
filebeat.inputs: - type: awscloudwatch . . . tags: ["json"]
fields
editOptional fields that you can specify to add additional information to the
output. For example, you might add fields that you can use for filtering log
data. Fields can be scalar values, arrays, dictionaries, or any nested
combination of these. By default, the fields that you specify here will be
grouped under a fields sub-dictionary in the output document. To store the
custom fields as top-level fields, set the fields_under_root option to true.
If a duplicate field is declared in the general configuration, then its value
will be overwritten by the value declared here.
filebeat.inputs:
- type: awscloudwatch
. . .
fields:
app_id: query_engine_12
fields_under_root
editIf this option is set to true, the custom
fields are stored as top-level fields in
the output document instead of being grouped under a fields sub-dictionary. If
the custom field names conflict with other field names added by Filebeat,
then the custom fields overwrite the other fields.
processors
editA list of processors to apply to the input data.
See Processors for information about specifying processors in your config.
pipeline
editThe Ingest Node pipeline ID to set for the events generated by this input.
The pipeline ID can also be configured in the Elasticsearch output, but this option usually results in simpler configuration files. If the pipeline is configured both in the input and output, the option from the input is used.
keep_null
editIf this option is set to true, fields with null values will be published in
the output document. By default, keep_null is set to false.
index
editIf present, this formatted string overrides the index for events from this input
(for elasticsearch outputs), or sets the raw_index field of the event’s
metadata (for other outputs). This string can only refer to the agent name and
version and the event timestamp; for access to dynamic fields, use
output.elasticsearch.index or a processor.
Example value: "%{[agent.name]}-myindex-%{+yyyy.MM.dd}" might
expand to "filebeat-myindex-2019.11.01".
publisher_pipeline.disable_host
editBy default, all events contain host.name. This option can be set to true to
disable the addition of this field to all events. The default value is false.