Skip to content

Document BYOC cross-cluster log search - #40205

Merged
AhmedAhmed-DD merged 6 commits into
masterfrom
ahmed/byoc-cross-cluster-search
Sep 29, 2026
Merged

AhmedAhmed-DD merged 6 commits into
masterfrom
ahmed/byoc-cross-cluster-search

Conversation

@AhmedAhmed-DD

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Documents how to search across multiple BYOC Logs clusters in Log Explorer and through the public Logs API

Merge readiness

  • Ready for merge

AI assistance

Used Codex to give me an initial draft and the JSON for the API example

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

Additional notes

@AhmedAhmed-DD
AhmedAhmed-DD requested a review from a team as a code owner September 24, 2026 19:21
@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@domalessi domalessi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Left some feedback inline!

byoc--<CLUSTER_NAME>--<INDEX_NAME>
```

## Cross-cluster search

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Cross-cluster search
## Search across BYOC Logs clusters


## Cross-cluster search

Search multiple BYOC Logs clusters in a single query in the Log Explorer or through the public Logs API. Results from the selected clusters are combined.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Search multiple BYOC Logs clusters in a single query in the Log Explorer or through the public Logs API. Results from the selected clusters are combined.
Use Log Explorer or the public Logs API to search across multiple BYOC Logs clusters with a single query. Results from the selected clusters are combined.


Search multiple BYOC Logs clusters in a single query in the Log Explorer or through the public Logs API. Results from the selected clusters are combined.

### Log Explorer

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Log Explorer
### Use Log Explorer


### Log Explorer

In the [Log Explorer][1] search bar, use `index:` with a parenthesized list of cluster names prefixed with `byoc--` and separated by `OR`. For example, search the `cluster-1` and `cluster-2` clusters:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
In the [Log Explorer][1] search bar, use `index:` with a parenthesized list of cluster names prefixed with `byoc--` and separated by `OR`. For example, search the `cluster-1` and `cluster-2` clusters:
In the [Log Explorer][1] search bar, prefix each cluster name with `byoc--`. Group the names in parentheses after `index:`, separated by `OR`. For example:


Replace `cluster-1` and `cluster-2` with your BYOC Logs cluster names.

### Public API

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Public API
### Use the Logs API


### Public API

Use the same query in the `filter.query` field of a request to the Search logs endpoint (`POST /api/v2/logs/events/search`). For example:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Use the same query in the `filter.query` field of a request to the Search logs endpoint (`POST /api/v2/logs/events/search`). For example:
Send a request to the [Search logs endpoint][1] (`POST /api/v2/logs/events/search`). Set `filter.query` to a query that specifies multiple BYOC Logs clusters. For example:

Comment thread hugo/content/en/byoc-logs/operate/search_logs.md
AhmedAhmed-DD and others added 2 commits September 25, 2026 09:25
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
@maxvp maxvp self-assigned this Sep 25, 2026

@domalessi domalessi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A bit of link clean-up but otherwise looks good!

Comment thread hugo/content/en/byoc-logs/operate/search_logs.md Outdated
Comment thread hugo/content/en/byoc-logs/operate/search_logs.md Outdated
Comment thread hugo/content/en/byoc-logs/operate/search_logs.md Outdated
AhmedAhmed-DD and others added 2 commits September 28, 2026 13:43
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Comment thread hugo/content/en/byoc-logs/operate/search_logs.md Outdated
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: François Massot <francois.massot@gmail.com>
@AhmedAhmed-DD
AhmedAhmed-DD merged commit bf1e4d1 into master Sep 29, 2026
29 of 30 checks passed
@AhmedAhmed-DD
AhmedAhmed-DD deleted the ahmed/byoc-cross-cluster-search branch September 29, 2026 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants