Skip to content

Adding API Key Link To Line 53, 106, and 258 #507

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 27, 2021
Merged

Adding API Key Link To Line 53, 106, and 258 #507

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
096edf7
Adding API Key Link To Line 53, 106, and 258
nikkiicole Oct 27, 2021
d1efd5b
Update aws/logs_monitoring/README.md
nikkiicole Oct 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions aws/logs_monitoring/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Install the Forwarder using the Terraform resource [aws_cloudformation_stack](ht

Datadog recommends creating two separate Terraform configurations:

- Use the first one to store the Datadog API key in the AWS Secrets Manager, and note down the secrets ARN from the output of apply.
- Use the first one to store the [Datadog API key](https://app.datadoghq.com/organization-settings/api-keys) in the AWS Secrets Manager, and note down the secrets ARN from the output of apply.
- Then create another configuration for the forwarder and supply the secrets ARN through the `DdApiKeySecretArn` parameter.

Separating the configurations of the API key and the forwarder means that you don't need to provide the Datadog API key when updating the forwarder.
Expand Down Expand Up @@ -103,7 +103,7 @@ resource "aws_cloudformation_stack" "datadog_forwarder" {
If you can't install the Forwarder using the provided CloudFormation template, you can install the Forwarder manually following the steps below. Feel free to open an issue or pull request to let us know if there is anything we can improve to make the template work for you.

1. Create a Python 3.7 Lambda function using `aws-dd-forwarder-<VERSION>.zip` from the latest [releases](https://github.com/DataDog/datadog-serverless-functions/releases).
2. Save your Datadog API key in AWS Secrets Manager, set environment variable `DD_API_KEY_SECRET_ARN` with the secret ARN on the Lambda function, and add the `secretsmanager:GetSecretValue` permission to the Lambda execution role.
2. Save your [Datadog API key](https://app.datadoghq.com/organization-settings/api-keys) in AWS Secrets Manager, set environment variable `DD_API_KEY_SECRET_ARN` with the secret ARN on the Lambda function, and add the `secretsmanager:GetSecretValue` permission to the Lambda execution role.
3. If you need to forward logs from S3 buckets, add the `s3:GetObject` permission to the Lambda execution role.
4. Set the environment variable `DD_ENHANCED_METRICS` to `false` on the Forwarder. This stops the Forwarder from generating enhanced metrics itself, but it will still forward custom metrics from other lambdas.
5. Some AWS accounts are configured such that triggers will not automatically create resoucrce-based policies allowing Cloudwatch log groups to invoke the forwarder.
Expand Down Expand Up @@ -255,7 +255,7 @@ The Datadog Forwarder is signed by Datadog. If you would like to verify the inte
### Required

`DdApiKey`
: Your Datadog API Key. This can be found in Datadog, under Integrations > APIs > API Keys. The API Key will be stored in AWS Secrets Manager. If you already have Datadog API Key stored in Secrets Manager, use `DdApiKeySecretArn` instead.
: Your [Datadog API key](https://app.datadoghq.com/organization-settings/api-keys). This can be found in Datadog, Organization Settings > API Keys. The API Key is stored in AWS Secrets Manager. If you already have a Datadog API Key stored in Secrets Manager, use `DdApiKeySecretArn` instead.

`DdApiKeySecretArn`
: The ARN of the secret storing the Datadog API key, if you already have it stored in Secrets Manager. You must store the secret as a plaintext, rather than a key-value pair.
Expand Down