Document the Rule Query Inspector for threshold rules #6746
Draft
nastasha-solomon wants to merge 4 commits into
Draft
Document the Rule Query Inspector for threshold rules #6746nastasha-solomon wants to merge 4 commits into
nastasha-solomon wants to merge 4 commits into
Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
Contributor
Vale Linting ResultsSummary: 5 suggestions found 💡 Suggestions (5)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Two minor issues found (one typo, one possessive error). Otherwise clear, well-structured, and follows style guide.
- Jargon: Appropriate use of technical terms with context. Elasticsearch, Kibana, and KQL are explained through usage.
- Frontmatter and applies_to: Correct. New page has proper
description,navigation_title,products, andapplies_tometadata. Version gates are properly applied. - Content type fit: The new page functions as a reference/how-to hybrid explaining both what the inspector shows and how to interpret it. Structure fits the troubleshooting use case well with clear sections and practical examples.
- Parent issue satisfaction: Satisfied. The PR fully addresses issue #6555's requirements: explains query anatomy, documents both entry points and their differences (current vs. historical parameters), maps rule configuration to query structure, provides response interpretation guidance, and includes troubleshooting scenarios.
Notes
- The page appropriately uses present tense and active voice throughout.
- The dropdowns for troubleshooting scenarios are an effective pattern for progressive disclosure.
- Code examples are well-annotated with callout numbers.
- The distinction between the two inspector entry points is clearly explained and reinforced throughout.
Generated by Docs review agent for issue #6746 · ● 763.6K
…s.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…reaches.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #6555.
Documents the rule query inspector, a new feature in 9.5 and Serverless that lets users view the Elasticsearch request a rule sends during evaluation. The primary goal is not to explain how to open the inspector (the UI is self-explanatory) but to help users understand what they see: how the query structure maps to their rule configuration, and how to read the response to determine why an alert did or didn't fire.
Why the page lives in
explore-analyze/alerting/alerts/The
queryInspectorhook is part of theRuleTypeinterface — it's a Kibana platform feature, not an Observability-specific one. Placing the reference page in the general Kibana alerting section means it's in the right long-term home when other rule types adopt the inspector. The Observability pages link to it as a cross-reference, which is already a common pattern in the docs. The page clearly notes that in 9.5 and on serverless, only custom threshold rules are supported.Previews
Generative AI disclosure