Skip to content

Commit 275d049

Browse files
alaudazzialaudazzi
committed
Update more aws packages
1 parent 87f22e3 commit 275d049

24 files changed

Lines changed: 158 additions & 174 deletions

‎packages/aws/_dev/build/docs/README.md‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ and reference data when troubleshooting an issue.
88

99
**Extra AWS charges on CloudWatch API requests will be generated by this integration. Check [API Requests](#apirequests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The AWS integration collects two types of data, logs and metrics, across many AWS services.
1414

@@ -20,11 +20,12 @@ by an AWS user or role, and more.
2020
This may include understanding where you're spending the most and why, the volume of storage you're using,
2121
CPU utilization of your instances, and more.
2222

23-
For a complete list of all AWS services and the data streams available for each, see [Reference](#reference).
23+
For a complete list of all AWS services and the data streams available for each, check the [Reference](#reference) documentation.
2424

2525
## API requests
2626

2727
### Overview
28+
2829
The AWS integration uses different AWS API to bootstrap and collect metrics and logs. The following table illustrates which APIs are used by the AWS integration and how.
2930

3031
Each of these APIs may generate extra charges on your AWS Account. Refer to [AWS Pricing](https://aws.amazon.com/pricing) for more information.
@@ -59,6 +60,7 @@ The extra-charges generated by GetMetricData API calls are proportional to the f
5960
* `Tags Filter`. By specifying a tag, you can ensure that no Cloudwatch API call is performed for AWS resources you are not interested in.
6061

6162
### Cross-account observability
63+
6264
The `include_linked_accounts` parameter is used to enable the inclusion of metrics from different accounts linked to a
6365
main monitoring account. By setting this parameter to true, users can gather metrics from multiple AWS accounts that are
6466
linked through the [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).
@@ -71,11 +73,10 @@ This parameter [utilize OwningAccount](https://docs.aws.amazon.com/AmazonCloudWa
7173
For logs, integration supports monitoring log groups from linked accounts when log groups are extracted using `log_group_name_prefix` option.
7274
You can enable `include_linked_accounts_for_prefix_mode` to include log groups from linked accounts. This is disabled by default.
7375

74-
*_Note_:* Users should ensure that the necessary IAM roles and policies are properly set up in order to link the monitoring
75-
account and source accounts together.
76-
Please see [Link monitoring accounts with source accounts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account-Setup.html#CloudWatch-Unified-Cross-Account-Setup-permissions) for more details.
76+
**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.
77+
Refer to [Link monitoring accounts with source accounts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account-Setup.html#CloudWatch-Unified-Cross-Account-Setup-permissions) for more details.
7778

78-
## Requirements
79+
## What do I need to use this integration?
7980

8081
Before using the AWS integration you will need:
8182

@@ -101,7 +102,7 @@ To use access keys as credentials, you need to provide:
101102
* `access_key_id`: The first part of the access key.
102103
* `secret_access_key`: The second part of the access key.
103104

104-
For more details see [AWS Access Keys and Secret Access Keys](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
105+
For more details, refer to [AWS Access Keys and Secret Access Keys](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
105106

106107
#### Use temporary security credentials
107108

@@ -110,7 +111,7 @@ They consist of an access key ID, a secret access key, and a security token, whi
110111
typically returned using `GetSessionToken`.
111112
IAM users with multi-factor authentication (MFA) enabled need to submit an MFA code
112113
while calling `GetSessionToken`.
113-
For more details see [Temporary Security Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html).
114+
For more details, refer to [Temporary Security Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html).
114115

115116
You can use AWS CLI to generate temporary credentials.
116117
For example, you would use `sts get-session-token` if you have MFA enabled:
@@ -133,10 +134,9 @@ This will cause data loss if the configuration is not updated with the new crede
133134

134135
If you use different credentials for different tools or applications, you can use profiles to
135136
configure multiple access keys in the same configuration file.
136-
For more details see [Create Shared Credentials File](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#file-format-creds)
137+
For more details, refer to [Create Shared Credentials File](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#file-format-creds).
137138

138-
Instead of providing the `access_key_id` and `secret_access_key` directly to the integration,
139-
you will provide two advanced options to look up the access keys in the shared credentials file:
139+
Instead of providing the `access_key_id` and `secret_access_key` directly to the integration, you will provide two advanced options to look up the access keys in the shared credentials file:
140140

141141
* `credential_profile_name`: The profile name in shared credentials file.
142142
* `shared_credential_file`: The directory of the shared credentials file.
@@ -154,7 +154,7 @@ An IAM role ARN is an IAM identity that you can create in your AWS account. You
154154
A role does not have standard long-term credentials such as a password or access keys associated with it.
155155
Instead, when you assume a role it provides you with temporary security credentials for your role session.
156156
IAM role ARN can be used to specify which AWS IAM role to assume to generate temporary credentials.
157-
For more details see [AssumeRole API documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
157+
For more details, refer to [AssumeRole API documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
158158

159159
To use an IAM role ARN, you need to provide either a [credential profile](#use-a-shared-credentials-file) or
160160
[access keys](#use-access-keys-directly) along with the `role_arn` advanced option.
@@ -166,7 +166,7 @@ If neither is given, the default credential profile will be used.
166166

167167
#### Use an EC2 instance's IAM Role
168168

169-
When Elastic Agent runs on an EC2 instance that has an IAM role attached via an instance profile, it can automatically authenticate to AWS services using a temporary access key pair and session token provided by the Instance Metadata Service (IMDS). For more details see [IAM roles for Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html).
169+
When Elastic Agent runs on an EC2 instance that has an IAM role attached via an instance profile, it can automatically authenticate to AWS services using a temporary access key pair and session token provided by the Instance Metadata Service (IMDS). For more details, refer to [IAM roles for Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html).
170170

171171
To use the IAM role attached to the EC2 instance, leave all of the following options empty:
172172

@@ -216,16 +216,16 @@ When you configure the integration, you can collect data from as many AWS servic
216216
If you only need to collect data from one AWS service, consider using the individual integration
217217
(for example, to only collect monitoring metrics for EC2, you can configure only the **AWS EC2** integration).
218218

219-
For step-by-step instructions on how to set up an integration, see the
219+
For step-by-step instructions on how to set up an integration, refer to the
220220
{{ url "getting-started-observability" "Getting started" }} guide.
221221

222222
## Debug
223223
### Latency causes missing metrics
224224
Some AWS services send monitoring metrics to CloudWatch with a latency to process larger than the integration collection
225-
period. This will cause data points missing or none get collected by the agent. In this case, please specify a
225+
period. This will cause data points missing or none get collected by the agent. In this case, specify a
226226
latency parameter so collection start time and end time will be shifted by the given latency amount.
227227

228-
In order to check how much the latency is, you can log into the AWS CloudWatch portal. Wait till a new point to
228+
To check how much the latency is, you can log into the AWS CloudWatch portal. Wait till a new point to
229229
show up in AWS CloudWatch and record the current timestamp. Compare the timestamp of this latest data point with the
230230
current timestamp to see what's the difference. This difference can be used as latency.
231231

@@ -236,8 +236,7 @@ we should add a `latency` configuration for `15m` when adding the integration.
236236

237237
## Reference
238238

239-
Below is an overview of the type of data you can collect from each AWS service.
240-
Visit the page for each individual AWS integration to see details about exported fields.
239+
This is an overview of the type of data you can collect from each AWS service:
241240

242241
| Service | Metrics | Logs |
243242
|------------------|:-------:|:-------:|
@@ -269,3 +268,5 @@ Visit the page for each individual AWS integration to see details about exported
269268
| VPN | x | |
270269
| WAF | | x |
271270
| Custom | | x |
271+
272+
Visit the page for each individual AWS integration to get more details about exported fields.

‎packages/aws/_dev/build/docs/kinesis.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ alerts to notify you if something goes wrong, and reference metrics when trouble
99
**IMPORTANT: **Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

1111

12-
## Data streams
12+
## What data does this integration collect?
1313

1414
The Amazon Kinesis integration collects one type of data: metrics.
1515

1616
**Metrics** give you insight into the state of Amazon Kinesis.
1717
Metrics collected by this integration include information about operations related to Amazon Kinesis records, shards, and more. See more details in the [Metrics reference](#metrics-reference).
1818

19-
## Requirements
19+
## What do I need to use this integration?
2020

2121
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
2222
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
@@ -26,7 +26,7 @@ Before using any AWS integration you will need:
2626
* **AWS Credentials** to connect with your AWS account.
2727
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2828

29-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
29+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
3030

3131
## Setup
3232

@@ -44,6 +44,6 @@ For step-by-step instructions on how to set up an integration, see the
4444

4545
**ECS Field Reference**
4646

47-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
47+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
4848

4949
{{fields "kinesis"}}

‎packages/aws/_dev/build/docs/lambda.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For example, you could use this integration to track throttled lambda functions,
88

99
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The AWS Lambda integration collects metrics and logs.
1414

@@ -35,7 +35,7 @@ Important notes:
3535

3636
See more details about [Event Source Mapping Metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics).
3737

38-
## Requirements
38+
## What do I need to use this integration?
3939

4040
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
4141
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
@@ -45,7 +45,7 @@ Before using any AWS integration you will need:
4545
* **AWS Credentials** to connect with your AWS account.
4646
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
4747

48-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
48+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
4949

5050
## Setup
5151

@@ -78,7 +78,7 @@ For more detailed information, refer to the AWS documentation on [Sending Lambda
7878

7979
**ECS Field Reference**
8080

81-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
81+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
8282

8383
{{fields "lambda"}}
8484

‎packages/aws/_dev/build/docs/natgateway.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,23 @@ For example, you could use this integration to view the total number of concurre
88

99
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The AWS NAT gateway integration collects one type of data: metrics.
1414

1515
**Metrics** give you insight into the state of your NAT gateways.
1616
Metrics collected by this integration include the number of connection attempts made through the NAT gateway, the total number of concurrent, active TCP connections through the NAT gateway, the number of times the NAT gateway could not allocate a source port, and more. See more details in the [Metrics reference](#metrics-reference).
1717

18-
## Requirements
18+
## What do I need to use this integration?
1919

20-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
21-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
20+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2221

2322
Before using any AWS integration you will need:
2423

2524
* **AWS Credentials** to connect with your AWS account.
2625
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2726

28-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
27+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
2928

3029
## Setup
3130

@@ -43,6 +42,6 @@ For step-by-step instructions on how to set up an integration, see the
4342

4443
**ECS Field Reference**
4544

46-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
45+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
4746

4847
{{fields "natgateway"}}

‎packages/aws/_dev/build/docs/rds.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,23 @@ For example, you could use this integration to track the latency and throughput
88

99
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The Amazon RDS integration collects one type of data: metrics.
1414

1515
**Metrics** give you insight into the state of Amazon RDS.
1616
Metrics collected by the Amazon RDS integration include database dimensions, the lag between database instances, and more. See more details in the [Metrics reference](#metrics-reference).
1717

18-
## Requirements
18+
## What do I need to use this integration?
1919

20-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
21-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
20+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2221

2322
Before using any AWS integration you will need:
2423

2524
* **AWS Credentials** to connect with your AWS account.
2625
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2726

28-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
27+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
2928

3029
## Setup
3130

@@ -43,6 +42,6 @@ For step-by-step instructions on how to set up an integration, see the
4342

4443
**ECS Field Reference**
4544

46-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
45+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
4746

4847
{{fields "rds"}}

‎packages/aws/_dev/build/docs/redshift.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,23 @@ For example, you could use the data from this integration to track the health st
99

1010
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1111

12-
## Data streams
12+
## What data does this integration collect?
1313

1414
The Amazon Redshift integration collects one type of data: metrics.
1515

1616
**Metrics** give you insight into the state of Amazon Redshift.
1717
Metrics collected by the Amazon Redshift integration include disk read throughput, storage read latency, query latency, and more. See more details in the [Metrics reference](#metrics-reference).
1818

19-
## Requirements
19+
## What do I need to use this integration?
2020

21-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
22-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
21+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2322

2423
Before using any AWS integration you will need:
2524

2625
* **AWS Credentials** to connect with your AWS account.
2726
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2827

29-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
28+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
3029

3130
## Setup
3231

@@ -43,6 +42,6 @@ For step-by-step instructions on how to set up an integration, see the {{ url "g
4342

4443
**ECS Field Reference**
4544

46-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
45+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
4746

4847
{{fields "redshift"}}

0 commit comments

Comments
 (0)