Skip to content

Commit

Permalink
[Docs] Fix aws-credentials-config link (#13335)
Browse files Browse the repository at this point in the history
* Fix aws-credentials-config link

* Add indentation for aws-credentials-examples.asciidoc
  • Loading branch information
kaiyan-sheng authored Aug 28, 2019
1 parent 2a6c58f commit 0a065f5
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 11 deletions.
8 changes: 5 additions & 3 deletions filebeat/docs/aws-credentials-examples.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
* Use AWS credentials in filebeat configuration
* Use AWS credentials in Filebeat configuration
+
[source,yaml]
----
filebeat.inputs:
Expand All @@ -8,9 +9,9 @@ filebeat.inputs:
secret_access_key: '<secret_access_key>'
session_token: '<session_token>'
----
+
or

+
[source,yaml]
----
filebeat.inputs:
Expand All @@ -22,6 +23,7 @@ filebeat.inputs:
----
* Use shared AWS credentials file
+
[source,yaml]
----
filebeat.inputs:
Expand Down
8 changes: 5 additions & 3 deletions metricbeat/docs/aws-credentials-examples.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
* Use AWS credentials in Metricbeat configuration
+
[source,yaml]
----
metricbeat.modules:
Expand All @@ -9,9 +11,9 @@ metricbeat.modules:
secret_access_key: '<secret_access_key>'
session_token: '<session_token>'
----

+
or

+
[source,yaml]
----
metricbeat.modules:
Expand All @@ -25,7 +27,7 @@ metricbeat.modules:
----
* Use shared AWS credentials file
+
[source,yaml]
----
metricbeat.modules:
Expand Down
6 changes: 4 additions & 2 deletions metricbeat/docs/modules/aws.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This file is generated! See scripts/mage/docs_collector.go
[role="xpack"]
== aws module

:libbeat-xpack-dir: ../../../x-pack/libbeat

This module periodically fetches monitoring metrics from AWS Cloudwatch using
https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html[GetMetricData API] for AWS services.
Note: extra AWS charges on GetMetricData API requests will be generated by this module.
Expand All @@ -18,7 +20,7 @@ The default metricsets are `ec2`, `sqs`, `s3_request`, `s3_daily_storage`, `clou
The `aws` module requires AWS credentials configuration in order to make AWS API calls.
Users can either use `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and/or
`AWS_SESSION_TOKEN`, or use shared AWS credentials file.
Please see <<aws-credentials-config>> for more details.
Please see <<aws-credentials-config,AWS credentials options>> for more details.

This module also accepts optional configuration `regions` to specify which
AWS regions to query metrics from. If the `regions` parameter is not set in the
Expand Down Expand Up @@ -89,7 +91,7 @@ for a list of AWS services that publish metrics to CloudWatch.
dimensions to Amazon CloudWatch every minute.

[id="aws-credentials-config"]
include::../../../../../libbeat/docs/aws-credentials-config.asciidoc
include::{libbeat-xpack-dir}/docs/aws-credentials-config.asciidoc[]


[float]
Expand Down
6 changes: 4 additions & 2 deletions x-pack/metricbeat/module/aws/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:libbeat-xpack-dir: ../../../x-pack/libbeat

This module periodically fetches monitoring metrics from AWS Cloudwatch using
https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html[GetMetricData API] for AWS services.
Note: extra AWS charges on GetMetricData API requests will be generated by this module.
Expand All @@ -10,7 +12,7 @@ The default metricsets are `ec2`, `sqs`, `s3_request`, `s3_daily_storage`, `clou
The `aws` module requires AWS credentials configuration in order to make AWS API calls.
Users can either use `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and/or
`AWS_SESSION_TOKEN`, or use shared AWS credentials file.
Please see <<aws-credentials-config>> for more details.
Please see <<aws-credentials-config,AWS credentials options>> for more details.

This module also accepts optional configuration `regions` to specify which
AWS regions to query metrics from. If the `regions` parameter is not set in the
Expand Down Expand Up @@ -81,4 +83,4 @@ for a list of AWS services that publish metrics to CloudWatch.
dimensions to Amazon CloudWatch every minute.

[id="aws-credentials-config"]
include::../../../../../libbeat/docs/aws-credentials-config.asciidoc
include::{libbeat-xpack-dir}/docs/aws-credentials-config.asciidoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ By default, statistic includes Average, Sum, Count, Maximum and Minimum.
=== Configuration example
To be more focused on `cloudwatch` metricset use cases, the examples below do
not include configurations on AWS credentials.
Please see <<aws-credentials-config>> for more details on setting AWS credentials
Please see <<aws-credentials-config,AWS credentials options>> for more details on setting AWS credentials
in configurations in order for this metricset to make proper AWS API calls.

[source,yaml]
Expand Down

0 comments on commit 0a065f5

Please sign in to comment.