[not ready] Document grouped view for ES|QL STATS results in Discover#5457
Closed
florent-leborgne wants to merge 3 commits intomainfrom
Closed
[not ready] Document grouped view for ES|QL STATS results in Discover#5457florent-leborgne wants to merge 3 commits intomainfrom
florent-leborgne wants to merge 3 commits intomainfrom
Conversation
Add a new section about the grouped (cascade) view that appears when running STATS ... BY queries with a single BY field. Documents the Group by selector, expandable rows, row actions, and conditions for when the grouped view is available. Made-with: Cursor
Contributor
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
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 |
The actions are accessed via a row action button (three dots menu), not a right-click context menu. Also fixes the icon name to boxes_horizontal to match the docs-builder convention. Made-with: Cursor
Member
Author
|
This will stay as draft for now as the feature isn't fully released yet, only some code has shipped |
florent-leborgne
changed the title
3 tasks
florent-leborgne
added a commit
that referenced
this pull request
Apr 28, 2026
- Note that BUCKET and TBUCKET in BY don't trigger the grouped layout (only single-field grouping or CATEGORIZE), per SUPPORTED_STATS_COMMAND_OPTION_FUNCTIONS in kbn-esql-utils. - Add three screenshot TODO placeholders covering the overview, the CATEGORIZE+SPARKLINE row, and the row actions menu. Carries over the BUCKET/TBUCKET caveat from #5457 so it can be closed as superseded. Made-with: Cursor
Member
Author
|
Superseded by #6190. The new PR covers the same grouped view + Group by selector + row actions you started here, plus:
End-to-end verification done on a local 9.4 snapshot Kibana + Elasticsearch build with a Trial license. Closing this one. The branch you started here ( |
florent-leborgne
added a commit
that referenced
this pull request
May 5, 2026
…S|QL (#6190) ## ⛔ Hold for release **Do not merge before all of the following ship:** - [ ] Stack 9.4.0 GA released. - [ ] Cascade layout LaunchDarkly flag flipped on for production Serverless (target: week of 2026-05-05). Until those gates are met, the cascade layout is invisible on production Serverless and ECH, even though the supporting Kibana code has shipped. ## Summary Documents the ES|QL `CATEGORIZE` UX enhancements that ship in Kibana 9.4 and Serverless preview: - New "View grouped results from a STATS query" section in `explore-analyze/discover/try-esql.md` covering: - The cascade (grouped) layout for ES|QL `STATS BY` queries with a single grouping field. - The `BUCKET`/`TBUCKET` and multi-field exclusion. - The **Group by** selector (with technical preview badge), the results count, and the opt-out path. - `CATEGORIZE` pattern token rendering, with a single-query example. - Grouped row actions (Copy to clipboard, Filter in, Filter out, Open in new tab). - Reciprocal tip on the existing classic-mode pattern analysis page (`explore-analyze/discover/run-pattern-analysis-discover.md`) pointing to the new ES|QL section. Closes #5733. Supersedes #5457 (carries over the BUCKET/TBUCKET caveat as a single-paragraph clarification). ### SPARKLINE deferral `SPARKLINE` was originally part of this PR but has been deferred from 9.4 to 9.5. The combined `CATEGORIZE` + `SPARKLINE` example, the `SAMPLE` scaling tip, and the sparkline screenshot are commented out in the markdown source inside a clearly-marked `RESTORE FOR 9.5` block. The reciprocal tip on the pattern analysis page no longer mentions sparklines. Restore work is tracked in #6215. ## Verification All scenarios still in scope verified on a local 9.4 snapshot Kibana + Elasticsearch build with a Trial license: 1. Single-field `STATS BY` triggers the grouped layout with the **Group by** selector and "N groups" results count. 2. Multi-field `STATS BY` falls back to the flat table. 3. `BUCKET`/`TBUCKET` grouping queries fall back to the flat table. 4. **Group by** → **none** opt-out switches back to flat and restores the regular toolbar. 5. Grouped row actions (Copy / Filter in / Filter out / Open in new tab) all behave as documented. 6. `CATEGORIZE` renders patterns with token highlighting. (`CATEGORIZE` + `SPARKLINE` was also verified on the local snapshot build before the SPARKLINE content was deferred.) ## Source verification Cross-checked against `elastic/kibana` `main` and the `9.4` branch: - Cascade gating (`isCascadedDocumentsVisible`, `SUPPORTED_CASCADE_GROUPING_COUNT = 1`) in `cascaded_documents_provider.tsx`. - Feature flag fallback `true` in `build_services.ts`, set by [`elastic/kibana#260698`](elastic/kibana#260698) and present on the 9.4 branch. - Supported grouping functions list: `SUPPORTED_STATS_COMMAND_OPTION_FUNCTIONS = ['categorize']` in `kbn-esql-utils/src/utils/cascaded_documents_helpers/utils.ts` (this is why BUCKET/TBUCKET don't trigger the cascade). - Row actions and i18n labels in `use_row_header_components.tsx` and `use_table_header_components.tsx`. ## Screenshots One screenshot placeholder is inline in the diff as a commented-out image directive: 1. Overview of the grouped layout (toolbar with the **Group by** button replacing the standard toolbar, "N groups" results count, one expanded row showing underlying documents). The previously-planned `CATEGORIZE` + `SPARKLINE` row screenshot is commented out alongside the SPARKLINE content; it will be restored as part of #6215. ## Note on supersession This PR replaces #6086 (which couldn't be reopened because the branch HEAD has moved past the closed-state ref). The same branch (`docs-issue-5733-categorize-ux`) is reused. #6086 is left closed for history. ## Generative AI disclosure - [x] Yes - drafted with Claude Opus 4.7 in Cursor. --------- Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@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
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
STATS ... BYwith a singleBYfield, not using grouping functions likeBUCKET.Closes #4959
Availability check needed
The cascade/grouped view is gated behind a feature flag (
discover.cascadeLayoutEnabled, which defaults tofalsein the code). We need to confirm:previewrather thanga.Additional PRs merged since the original issue was filed (Feb 3)
The cascade feature has had significant ongoing development since the issue was created:
Related Kibana PRs
Generative AI disclosure
Tool(s) and model(s) used: claude-4.6-opus-high in Cursor
Made with Cursor