-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Update README.md #20262
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
Update README.md #20262
Conversation
This comment has been minimized.
This comment has been minimized.
|
|
||
| ### Custom query | ||
|
|
||
| Custom Query is used to get specific fields from the database to be used a custom metrics. |
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.
| Custom Query is used to get specific fields from the database to be used a custom metrics. | |
| Custom Query is used to extract specific fields from the database to be used as custom metrics. |
| | `columns` | This is a list representing each column, ordered sequentially from left to right. There are two required pieces of data: <br> a. `type` - This is the submission method (`gauge`, `count`, etc.). <br> b. name - This is the suffix used to form the full metric name. If `type` is `tag`, this column is instead considered as a tag which is applied to every metric collected by this particular query. | | ||
|
|
||
| Optionally use the `tags` parameter to apply a list of tags to each metric collected. | ||
| The **number of columns** Output from the Custom Query should be **equal to to number of metrics variables** in the conf.yaml file shown below. |
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.
| The **number of columns** Output from the Custom Query should be **equal to to number of metrics variables** in the conf.yaml file shown below. | |
| The **number of columns** output from the Custom Query should be equal to to number of metrics variables in the `conf.yaml` file shown below. |
|
This PR does not modify any files shipped with the agent. To help streamline the release process, please consider adding the |
|
/merge |
|
View all feedbacks in Devflow UI.
This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
devflow unqueued this merge request: It did not become mergeable within the expected time |
|
Thanks for the contribution, the Oracle integration has moved to https://github.com/DataDog/datadog-agent/tree/main/pkg/collector/corechecks/oracle and this version is no longer maintained. |
What does this PR do?
Provides additional information about Custom Queries. Adds the key configuration information number of columns from the query should equal the number of custom query metrics in the conf.yaml file
Motivation
This information is not present in the documentation, rather in the example conf.yaml file.
This makes it easy to read from the documentation
Review checklist (to be filled by reviewers)
qa/skip-qalabel if the PR doesn't need to be tested during QA.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged