Improve documentation for custom check in dev env #4116
Merged
Conversation
This file contains 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
ogaca-dd
added
changelog/no-changelog
[deprecated] team/agent-core
remeh
reviewed
Sep 5, 2019
l0k0ms
reviewed
Sep 6, 2019
docs/dev/checks/README.md
Outdated
| @@ -8,6 +8,10 @@ fit for your use case, please [refer to the official documentation][custom-check | |||
| Every check has its own YAML configuration file. The file has one mandatory key, | |||
| `instances` and one optional, `init_config`. | |||
|
|
|||
| Note: If you want to run the custom check inside your development workspace | |||
| (github.com/DataDog/datadog-agent), you need to put `MyCheck.yaml` and | |||
There was a problem hiding this comment.
Suggested change
| (github.com/DataDog/datadog-agent), you need to put `MyCheck.yaml` and | |
| (github.com/DataDog/datadog-agent), you must put `MyCheck.yaml` and |
truthbk
reviewed
Sep 9, 2019
docs/dev/checks/README.md
Outdated
| @@ -8,6 +8,12 @@ fit for your use case, please [refer to the official documentation][custom-check | |||
| Every check has its own YAML configuration file. The file has one mandatory key, | |||
| `instances` and one optional, `init_config`. | |||
|
|
|||
| Note: If you want to run the custom check inside your development workspace | |||
There was a problem hiding this comment.
I feel like that the corollary to this is that the proper location is bin/agent/dist? Wondering if this might mislead people into thinking dropping the checks and config files in dev/dist is enough if they read this quickkly. I would maybe simplify/reorder this message to say:
Note:
If you want to run a custom check inside your development workspace
(github.com/DataDog/datadog-agent), you must put `MyCheck.yaml` and
`MyCheck.py` in the `bin/agent/dist` folder located at the root of the
datadog-agent repository.
Please keep in mind that the `invoke agent.build` task will copy the
contents inside`dev/dist` to `bin/agent/dist` when ran, so you can use
that path if you need alonger-lived location for your custom checks.
Or something along those lines?
remeh
approved these changes
Sep 27, 2019
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.
What does this PR do?
Explain how to use a custom check inside the development environment.