-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[TEST] Demo changes for incorporate-pr-feedback skill #35261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,11 +33,11 @@ | |
|
|
||
| ## Overview | ||
|
|
||
| This guide walks you through integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. After completing setup, you can enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale: 'Once you have completed setup' — use 'After you complete setup' instead. Also, 'easily' should be removed (Vale: words to avoid).
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale: 'will walk' uses a temporal word. Switch to present tense: "This guide walks you through..." Also, 'Once you have completed setup' → 'After you complete setup' (Vale: use 'After' instead of 'Once'). Also, remove 'easily' — it's a filler word per the style guide. Also, 'to ensure that all your data is collected' — 'ensure' should be avoided or replaced with 'helps ensure'. Consider simplifying: end the sentence at 'configure log forwarding.' |
||
| This guide will walk you through the process of integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. Once you have completed setup, you can easily enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding to ensure that all your data is collected. | ||
|
Check warning on line 36 in content/en/getting_started/integrations/aws.md
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale (multiple): Several issues on this line:
Suggested rewrite: 'This guide walks you through integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. After completing setup, you can enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding.' |
||
|
|
||
| ## Prerequisites | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale: 'Note that' should be replaced with 'Note:' per the Datadog style guide. Also, the additional clause 'and administrative access to your AWS console' is useful context — keep it. |
||
| Before you begin, ensure that you have an [AWS][7] account. The CloudFormation template creates an IAM role and associated policy, allowing Datadog's AWS account to make API calls to your AWS account to collect and push data. Your AWS user must have the following IAM permissions to run the template: | ||
| Before you begin, ensure you have an [AWS][7] account and administrative access to your AWS console. The CloudFormation template creates an IAM role and associated policy, allowing Datadog's AWS account to make API calls to your AWS account to collect and push data. Note that your AWS user must have the following IAM permissions to run the template: | ||
|
Check warning on line 40 in content/en/getting_started/integrations/aws.md
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale: 'Note that' should be replaced with 'Note:' — this is a direct Vale violation per the Datadog style guide. Change to: 'Note: Your AWS user must have the following IAM permissions to run the template:' |
||
|
|
||
| {{% collapse-content title="Required IAM permissions" level="h4" expanded=false id="iam-permissions" %}} | ||
| - cloudformation:CreateStack | ||
|
|
@@ -130,15 +130,21 @@ | |
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Content: The 'Tag filtering' section uses several flagged phrases:
Suggested rewrite: "Use tag-based filtering to control which AWS resources Datadog monitors. Under the Metric Collection tab, add tag filters to include or exclude specific resources and customize your monitoring scope." |
||
| Under the **General** tab on the [AWS integration page][8], you can control the AWS regions where Datadog collects metrics, CloudWatch events, and resources. | ||
|
|
||
| ### Tag filtering | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale (multiple): The new 'Tag filtering' section has several style guide violations:
Suggested rewrite: 'Use tag-based filtering to control which AWS resources Datadog monitors. Add tag filters under the Metric Collection tab to include or exclude specific resources and customize your monitoring scope.' |
||
| You can leverage tag-based filtering to control which AWS resources Datadog monitors. By utilizing tag filters under the **Metric Collection** tab, you can easily include or exclude specific resources. This allows you to fine-tune your monitoring setup to only collect metrics from the resources that matter to your team. | ||
|
Check warning on line 135 in content/en/getting_started/integrations/aws.md
|
||
|
|
||
| ## Send logs | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Style: 'simplest' is a superlative that implies ease — avoid these per the style guide. Change to something more factual: 'This option requires no additional infrastructure.' |
||
| There are two ways to send AWS service logs to Datadog: | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale: 'simplest' — avoid superlatives like 'simplest'. Consider: 'This option requires no additional infrastructure.' |
||
|
|
||
| - [Amazon Data Firehose destination][10]: Recommended for high-volume CloudWatch logs. | ||
| - [Amazon Data Firehose destination][10]: Recommended for high-volume CloudWatch logs. This is the simplest option and requires no additional infrastructure. | ||
| - [Forwarder Lambda function][11]: Required for traces, enhanced metrics, or custom metrics from Lambda functions. Also recommended for logs from S3 or other resources that cannot stream directly to Amazon Data Firehose. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale + Style: Multiple issues in this tip:
|
||
|
|
||
| See [Enable logging for your AWS service][14] for setup instructions. | ||
|
|
||
| **Tip**: If you are currently unsure which method to use, start with the Amazon Data Firehose destination, as it is easier to set up and maintain. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vale + Structure: Several issues with this tip:
|
||
|
|
||
| ### Validation | ||
|
|
||
| Once you have enabled logs, find them in the [Log Explorer][15] using either the `source` or `service` facets from the facet panel, such as this example from S3: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Vale: 'will walk' uses a temporal word ('will'). Revert to present tense: "This guide walks you through..."