Skip to content
Prev Previous commit
Next Next commit
align with guidelines in #3433
update generated docs
  • Loading branch information
colleenmcginnis committed Jun 6, 2022
commit c0abc2da35480076da3ea4110ea4fdcaad6718ad
4 changes: 2 additions & 2 deletions packages/aws/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use the AWS integration to collect metrics and logs across many AWS services man
Visualize that data in Kibana, create alerts to notify you if something goes wrong,
and reference data when troubleshooting an issue.

## Data types
## Data streams

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

Expand All @@ -17,7 +17,7 @@ by an AWS user or role, and more.
**Metrics** give you insight into the state of your AWS usage.
This may include understanding where you're spending the most and why, the volume of storage you're using, and more.

For a complete list of all AWS services and the data types available for each, see [Reference](#reference).
For a complete list of all AWS services and the data streams available for each, see [Reference](#reference).

## Requirements

Expand Down
18 changes: 8 additions & 10 deletions packages/aws/_dev/build/docs/cloudfront.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

The AWS CloudFront integration allows you to monitor your [AWS CloudFront](https://aws.amazon.com/cloudfront/) usage.

Use the AWS CloudFront integration to collect and parse logs related to content delivery via CloudFront.
Visualize that data in Kibana, create alerts to notify you if something goes wrong,
Use the AWS CloudFront integration to collect and parse logs related to content delivery.
Then visualize that data in Kibana, create alerts to notify you if something goes wrong,
and reference logs when troubleshooting an issue.

For example, if you wanted to know when there are more than 25 failed requests for a single
piece of content in a given time period, you could search the logs for that time period, find all
requests for that unique piece of content, and filter by response type.
Then you could troubleshoot the issue by looking at additional context in the logs like the
number of _unique_ users (by IP address) who experienced the issue, where the request is coming from,
or whether there are patterns related to the operating system or browser used when the request failed.
For example, you could use the data from this integration to know when there are more than some number of failed requests
for a single piece of content in a given time period. You could also use the data to troubleshoot the underlying issue by
looking at additional context in the logs like the number of unique users (by IP address) who experienced the issue,
the source of the request, and more.

## Data types
## Data streams

The AWS CloudFront integration collects one type of data: logs.

Expand Down Expand Up @@ -43,7 +41,7 @@ For step-by-step instructions on how to set up an integration, see the

## Logs reference

The `cloudfront` dataset collects standard logs (also called access logs) from AWS CloudFront.
The `cloudfront` data stream collects standard logs (also called access logs) from AWS CloudFront.
CloudFront standard logs provide detailed records about every request that’s made to a distribution.

{{fields "cloudfront_logs"}}
Expand Down
4 changes: 2 additions & 2 deletions packages/aws/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use the AWS integration to collect metrics and logs across many AWS services man
Visualize that data in Kibana, create alerts to notify you if something goes wrong,
and reference data when troubleshooting an issue.

## Data types
## Data streams

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

Expand All @@ -17,7 +17,7 @@ by an AWS user or role, and more.
**Metrics** give you insight into the state of your AWS usage.
This may include understanding where you're spending the most and why, the volume of storage you're using, and more.

For a complete list of all AWS services and the data types available for each, see [Reference](#reference).
For a complete list of all AWS services and the data streams available for each, see [Reference](#reference).

## Requirements

Expand Down
18 changes: 8 additions & 10 deletions packages/aws/docs/cloudfront.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

The AWS CloudFront integration allows you to monitor your [AWS CloudFront](https://aws.amazon.com/cloudfront/) usage.

Use the AWS CloudFront integration to collect and parse logs related to content delivery via CloudFront.
Visualize that data in Kibana, create alerts to notify you if something goes wrong,
Use the AWS CloudFront integration to collect and parse logs related to content delivery.
Then visualize that data in Kibana, create alerts to notify you if something goes wrong,
and reference logs when troubleshooting an issue.

For example, if you wanted to know when there are more than 25 failed requests for a single
piece of content in a given time period, you could search the logs for that time period, find all
requests for that unique piece of content, and filter by response type.
Then you could troubleshoot the issue by looking at additional context in the logs like the
number of _unique_ users (by IP address) who experienced the issue, where the request is coming from,
or whether there are patterns related to the operating system or browser used when the request failed.
For example, you could use the data from this integration to know when there are more than some number of failed requests
for a single piece of content in a given time period. You could also use the data to troubleshoot the underlying issue by
looking at additional context in the logs like the number of unique users (by IP address) who experienced the issue,
the source of the request, and more.

## Data types
## Data streams

The AWS CloudFront integration collects one type of data: logs.

Expand Down Expand Up @@ -43,7 +41,7 @@ For step-by-step instructions on how to set up an integration, see the

## Logs reference

The `cloudfront` dataset collects standard logs (also called access logs) from AWS CloudFront.
The `cloudfront` data stream collects standard logs (also called access logs) from AWS CloudFront.
CloudFront standard logs provide detailed records about every request that’s made to a distribution.

**Exported fields**
Expand Down