Skip to content

Conversation

estherk15
Copy link
Contributor

@estherk15 estherk15 commented Oct 9, 2025

What does this PR do? What is the motivation?

  • Add a primer on datadog search with a list of syntax references
  • DOCS-7837

Merge instructions

Merge readiness:

  • Ready for merge

@estherk15 estherk15 requested a review from a team as a code owner October 9, 2025 19:47
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Oct 9, 2025
Copy link
Contributor

github-actions bot commented Oct 9, 2025

@estherk15 estherk15 added the editorial review Waiting on a more in-depth review label Oct 9, 2025
Copy link
Contributor

@euzuro euzuro left a comment

Choose a reason for hiding this comment

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

👋 It's great to see this added to the docs! I saw this PR because I was tagged on the related JIRA ticket... I took the liberty to leave a few comments, feel free to ignore me 😄


### Metric-Based Queries

Metric-based queries are designed to retrieve and analyze numerical time series data. They rely on tags and attributes to filter metrics and often combine functions and arithmetic operations to calculate and visualize trends over time (for example, average latency, error rate, or cost over time).
Copy link
Contributor

Choose a reason for hiding this comment

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

❓ Do we say "attributes" for metrics filters? I would have written only tags here, but I am not a metrics expert.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
Metric-based queries are designed to retrieve and analyze numerical time series data. They rely on tags and attributes to filter metrics and often combine functions and arithmetic operations to calculate and visualize trends over time (for example, average latency, error rate, or cost over time).
Metric-based queries are designed to retrieve and analyze numerical time series data. They rely on tags to filter metrics and often combine functions and arithmetic operations to calculate and visualize trends over time (for example, average latency, error rate, or cost over time).

Co-authored-by: Erik Uzureau <[email protected]>
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

Found a few minor things to update. Other than that, this seems like essential reading that will be a great addition to our docs. Great work!


See the index of [Product-Specific Search][1].

## Further Reading
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
## Further Reading
## Further reading

## Understanding Datadog search

Datadog provides a unified way to query data across products using text-based search syntax. All data in Datadog can be explored and filtered through queries, but the syntax and behavior differ depending on the type of data you're working with. There are two primary query formats in Datadog:
- **Metric-based queries**: used in Metrics and Cloud Cost Management (CCM).
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
- **Metric-based queries**: used in Metrics and Cloud Cost Management (CCM).
- **Metric-based queries**: Used in Metrics and Cloud Cost Management (CCM).


Datadog provides a unified way to query data across products using text-based search syntax. All data in Datadog can be explored and filtered through queries, but the syntax and behavior differ depending on the type of data you're working with. There are two primary query formats in Datadog:
- **Metric-based queries**: used in Metrics and Cloud Cost Management (CCM).
- **Event-based queries**: used across most other products, including Logs, APM, RUM, Events, and Security.
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
- **Event-based queries**: used across most other products, including Logs, APM, RUM, Events, and Security.
- **Event-based queries**: Used across most other products, including Logs, APM, RUM, Events, and Security.


## Additional product-specific resources

{{< whatsnext desc="Product-specific search syntax documentation for additional Datadog products:" >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

I would recommend adding your new "Getting Started with Search" page as a further reading to each of these pages

{{< nextlink href="/tests/explorer/search_syntax" >}}Test Optimization Explorer Search Syntax: Search and analyze test execution data{{< /nextlink >}}
{{< /whatsnext >}}

## Further Reading
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
## Further Reading
## Further reading


For more information, see [Advanced Filtering][1].

### Key capabilties
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
### Key capabilties
### Key capabilities


To learn more about querying spans and traces with service, resource, and tag filters, see [Trace Query Syntax][3].

### Key capabilites
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
### Key capabilites
### Key capabilities


Each Datadog product provides its own search syntax, tailored to the type of data it handles. The Product-Specific Search reference highlights the key capabilities and unique operators available in each product, such as log search facets, APM trace filters, or metric aggregation functions. These references help you understand where syntax differs across Datadog products.

See the index of [Product-Specific Search][1].
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
See the index of [Product-Specific Search][1].
Learn more in [Product-Specific Search][1].

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

Labels

Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants