Enhance Datadog API key configuration instructions#36520
Open
litianningdatadog wants to merge 1 commit intomasterfrom
Open
Enhance Datadog API key configuration instructions#36520litianningdatadog wants to merge 1 commit intomasterfrom
litianningdatadog wants to merge 1 commit intomasterfrom
Conversation
Added details about storing the Datadog API key in different formats in AWS Secrets Manager, including JSON support.
1 task
estherk15
approved these changes
May 6, 2026
Contributor
estherk15
left a comment
estherk15
left a comment
There was a problem hiding this comment.
Thanks for the update! Left a few suggestions for formatting, but the PR is approved!
Comment on lines
+78
to
+79
| - Plain string — the secret value is used directly as the API key. | ||
| - JSON object — if the secret value is a JSON object, the extension extracts the `dd_api_key` field and uses its value as the API key. This is useful if you store the Datadog API key alongside other credentials in a single |
Contributor
There was a problem hiding this comment.
Suggested change
| - Plain string — the secret value is used directly as the API key. | |
| - JSON object — if the secret value is a JSON object, the extension extracts the `dd_api_key` field and uses its value as the API key. This is useful if you store the Datadog API key alongside other credentials in a single | |
| - **Plain string**: the secret value is used directly as the API key. | |
| - J**SON object**: if the secret value is a JSON object, the extension extracts the `dd_api_key` field and uses its value as the API key. This is useful if you store the Datadog API key alongside other credentials in a single |
Comment on lines
+84
to
+85
| The field name `dd_api_key` is fixed and cannot be customized. If the secret is not valid JSON or does not contain `dd_api_key`, the extension falls back to using the raw secret string, so existing plain-string secrets continue to work unchanged. | ||
| Note: JSON-formatted secrets require Datadog Lambda Extension v96 or later. |
Contributor
There was a problem hiding this comment.
Suggested change
| The field name `dd_api_key` is fixed and cannot be customized. If the secret is not valid JSON or does not contain `dd_api_key`, the extension falls back to using the raw secret string, so existing plain-string secrets continue to work unchanged. | |
| Note: JSON-formatted secrets require Datadog Lambda Extension v96 or later. | |
| The field name `dd_api_key` is fixed and cannot be customized. If the secret is not valid JSON or does not contain `dd_api_key`, the extension falls back to using the raw secret string. Existing plain-string secrets continue to work unchanged. | |
| **Note**: JSON-formatted secrets require Datadog Lambda Extension v96 or later. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added details about storing the Datadog API key in different formats in AWS Secrets Manager, including JSON support.
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
AI assistance
Additional notes