Skip to content

[workers-observability] query builder docs #21507

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

Merged
merged 4 commits into from
Apr 9, 2025
Merged

Conversation

rohinlohe
Copy link
Contributor

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

Copy link
Contributor

hyperlint-ai bot commented Apr 8, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated the Workers Observability documentation to include a new Query Builder feature for investigating telemetry data.

  • Added a new page for the Query Builder to help users write structured queries for telemetry data.
  • Introduced an Investigate page that links to the Query Builder.
  • Modified existing logs documentation to reflect updates and clarify information.

Modified Files

  • src/content/docs/workers/observability/logs/index.mdx
  • src/content/docs/workers/observability/logs/workers-logs.mdx

Added Files

  • src/content/docs/workers/observability/investigate/index.mdx
  • src/content/docs/workers/observability/investigate/query-builder.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@rohinlohe rohinlohe force-pushed the rohin/qb-dev-docs branch from ea3ab5b to 6d6e855 Compare April 8, 2025 15:16
@rohinlohe rohinlohe force-pushed the rohin/qb-dev-docs branch from 6d6e855 to 4d92229 Compare April 8, 2025 16:06
@rohinlohe
Copy link
Contributor Author

going to update some of the screenshots

Copy link
Contributor

@ToriLindsay ToriLindsay left a comment

Choose a reason for hiding this comment

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

@rohinlohe Left some suggestions and approved. Feel free to disregard any suggestions that don't make sense with the context. Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you have other near-term plans for the "Investigate" section? Because if it only contains "Query Builder" right now, maybe that can just go up a level and you can remove "Investigate"? I'm just always trying to think of ways to make things less nested and hidden.

@rohinlohe rohinlohe merged commit f8a09b6 into production Apr 9, 2025
11 checks passed
@rohinlohe rohinlohe deleted the rohin/qb-dev-docs branch April 9, 2025 02:45
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* [workers-observability] query builder docs

* fixes

* improved images

* fix links

---------

Co-authored-by: Rohin Lohe <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:workers Related to Workers product size/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants