Document PromQL source command in ES|QL editor#5458
Draft
florent-leborgne wants to merge 1 commit intomainfrom
Draft
Document PromQL source command in ES|QL editor#5458florent-leborgne wants to merge 1 commit intomainfrom
florent-leborgne wants to merge 1 commit intomainfrom
Conversation
Add PROMQL to the source commands list and a new section documenting the PROMQL command syntax, parameters, and examples. Marked as preview for both stack 9.4 and serverless. Made-with: Cursor
Contributor
✅ Vale Linting ResultsNo issues found on modified lines! 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
🔍 Preview links for changed docs |
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
1 participant
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
PROMQLto the source commands list on the ES|QL in Kibana page alongsideFROMandTS.index,step,buckets,start,end,scrape_interval), and example queries.previewfor both stack 9.4 and serverless.Closes #4961
Critical availability check needed
In the Kibana codebase, the PROMQL command is currently
hidden: truein production (visible only in test builds). This means the command does not appear in autocomplete or the command list for users. The comment says "TODO: Temporary until making it GA."We must confirm with the ES|QL team when the
hiddenflag will be removed before merging this PR. If it remains hidden for 9.4, this PR should be held until the flag is removed.Additionally, PromQL has seen very active development since the issue was filed (Feb 3), with 13+ PRs merged covering grammar updates, syntax highlighting, validation, pretty-printing, and aggregation support. The documented syntax and parameters reflect the latest code state.
Related Kibana PRs
Coordination needed
A
PROMQLcommand reference page may also be needed in the Elasticsearch reference docs (similar to the existingFROMandTSpages). This should be coordinated with the Elasticsearch reference team.Generative AI disclosure
Tool(s) and model(s) used: claude-4.6-opus-high in Cursor
Made with Cursor