chore: add Datadog API/APP key creation instructions to datadog_search.py #1172
Conversation
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
Akanshu-2u
approved these changes
Dec 16, 2025
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation in the datadog_search.py script by adding clear instructions on how to obtain Datadog API and APP keys. The changes provide users with a direct link to the official Datadog documentation and inform them about permission requirements for creating API keys.
- Adds a link to Datadog's official documentation for API/APP key creation
- Includes a note about elevated permissions required for API key creation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 2. Set the following environment variables (in a safe way): | ||
| export DD_API_KEY=XXXXX | ||
| export DD_APP_KEY=XXXXX | ||
| See Create API and APP keys here: https://docs.datadoghq.com/account_management/api-app-keys |
There was a problem hiding this comment.
The documentation sentence "See Create API and APP keys here:" is grammatically incomplete. It should either read "See how to create API and APP keys here:" or "Create API and APP keys here:" for better clarity and grammatical correctness.
Suggested change
| See Create API and APP keys here: https://docs.datadoghq.com/account_management/api-app-keys | |
| See how to create API and APP keys here: https://docs.datadoghq.com/account_management/api-app-keys |
ttak-apphelix
approved these changes
Dec 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Below documentation is added to provide clear guidance for future users on how to obtain the necessary credentials.
See Create API and APP keys here: https://docs.datadoghq.com/account_management/api-app-keys
(API key creation requires elevated Datadog permissions—raise a helpdesk ticket or contact a Datadog admin.)