Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions filebeat/docs/modules/aws.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,46 @@ from network interfaces in AWS VPC.
[float]
=== Example dashboard

This module comes with a sample dashboard for `s3access` fileset:
This module comes with several predefined dashboards. For example, here is the
dashboard for `s3access` fileset:

[role="screenshot"]
image::./images/filebeat-aws-s3access-overview.png[]

[float]
==== `s3access` fileset settings
=== Module configuration

Example config:

[source,yaml]
----
- module: aws
s3access:
enabled: true
var.queue_url: https://sqs.us-west-1.amazonaws.com/123/queue-name
var.credential_profile_name: fb-aws
enabled: false

# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue

# Profile name for aws credential
#var.credential_profile_name: fb-aws

elb:
enabled: false

# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue

# Profile name for aws credential
#var.credential_profile_name: fb-aws

vpcflow:
enabled: false

# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue

# Profile name for aws credential
#var.credential_profile_name: fb-aws
----

*`var.queue_url`*::
Expand Down
33 changes: 28 additions & 5 deletions x-pack/filebeat/module/aws/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,46 @@ from network interfaces in AWS VPC.
[float]
=== Example dashboard

This module comes with a sample dashboard for `s3access` fileset:
This module comes with several predefined dashboards. For example, here is the
dashboard for `s3access` fileset:

[role="screenshot"]
image::./images/filebeat-aws-s3access-overview.png[]

[float]
==== `s3access` fileset settings
=== Module configuration

Example config:

[source,yaml]
----
- module: aws
s3access:
enabled: true
var.queue_url: https://sqs.us-west-1.amazonaws.com/123/queue-name
var.credential_profile_name: fb-aws
enabled: false

# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue

# Profile name for aws credential
#var.credential_profile_name: fb-aws

elb:
enabled: false

# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue

# Profile name for aws credential
#var.credential_profile_name: fb-aws

vpcflow:
enabled: false

# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue

# Profile name for aws credential
#var.credential_profile_name: fb-aws
----

*`var.queue_url`*::
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
- key: aws
title: AWS
release: beta
description: >
Module for handling logs from AWS.
fields:
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/elb/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
- name: elb
type: group
release: beta
description: >
Fields for AWS ELB logs.
fields:
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/aws/fields.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/s3access/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
- name: s3access
type: group
release: beta
description: >
Fields for AWS S3 server access logs.
fields:
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/vpcflow/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
- name: vpcflow
type: group
release: beta
description: >
Fields for AWS VPC flow logs.
fields:
Expand Down