Skip to content

Commit

Permalink
[AWS] Change include_linked_accounts default value to true (elastic#3…
Browse files Browse the repository at this point in the history
  • Loading branch information
kaiyan-sheng authored Jun 13, 2023
1 parent d359f9e commit 207bd24
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions metricbeat/docs/modules/aws.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ If endpoint is specified, `regions` config becomes required.
The `include_linked_accounts` parameter is used to enable the inclusion of metrics from different accounts linked to a
main monitoring account. By setting this parameter to true, users can gather metrics from multiple AWS accounts that are
linked through the https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html[CloudWatch cross-account observability].
By default, the `include_linked_accounts` parameter is set to false, meaning that only metrics from the main monitoring
account are collected. When set to true, the parameter allows the CloudWatch ListMetrics API to include metrics from
the monitoring account and all linked accounts in the returned data, providing a comprehensive cross-account view.
By default, the `include_linked_accounts` parameter is set to true, meaning that only metrics from the main monitoring
account and all linked accounts are all collected. When set to false, the parameter allows the CloudWatch service to
only retrieve metrics from the monitoring account.

*_Note_:* Users should ensure that the necessary IAM roles and policies are properly set up in order to link the monitoring
account and source accounts together.
Expand Down
6 changes: 3 additions & 3 deletions x-pack/metricbeat/module/aws/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ If endpoint is specified, `regions` config becomes required.
The `include_linked_accounts` parameter is used to enable the inclusion of metrics from different accounts linked to a
main monitoring account. By setting this parameter to true, users can gather metrics from multiple AWS accounts that are
linked through the https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html[CloudWatch cross-account observability].
By default, the `include_linked_accounts` parameter is set to false, meaning that only metrics from the main monitoring
account are collected. When set to true, the parameter allows the CloudWatch ListMetrics API to include metrics from
the monitoring account and all linked accounts in the returned data, providing a comprehensive cross-account view.
By default, the `include_linked_accounts` parameter is set to true, meaning that only metrics from the main monitoring
account and all linked accounts are all collected. When set to false, the parameter allows the CloudWatch service to
only retrieve metrics from the monitoring account.

*_Note_:* Users should ensure that the necessary IAM roles and policies are properly set up in order to link the monitoring
account and source accounts together.
Expand Down
4 changes: 2 additions & 2 deletions x-pack/metricbeat/module/aws/aws.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ type Tag struct {
// ModuleName is the name of this module.
const ModuleName = "aws"

// IncludeLinkedAccountsDefault defines if we should include metrics from linked AWS accounts or not. Default is false.
// IncludeLinkedAccountsDefault defines if we should include metrics from linked AWS accounts or not. Default is true.
// More information about cross-account Cloudwatch monitoring can be found at
// https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html
const IncludeLinkedAccountsDefault = false
const IncludeLinkedAccountsDefault = true

type LabelConstants struct {
AccountIdIdx int
Expand Down

0 comments on commit 207bd24

Please sign in to comment.