Skip to content

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #20262

wants to merge 1 commit into from

Conversation

srinibddog
Copy link

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)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • [x ] Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented May 12, 2025

Datadog Summary

✅ Code Quality    ✅ Code Security    ❌ Dependencies


Was this helpful? Give us feedback!

@@ -369,6 +369,7 @@ To connect to Oracle through TCPS (TCP with SSL), uncomment the `protocol` confi

### Custom query

Custom Query is used to get specific fields from the database to be used a custom metrics.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@@ -377,6 +378,7 @@ Providing custom queries is also supported. Each query must have two parameters:
| `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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants