Skip to content

docs: note that CSV reports apply selected ES|QL variable control values (#7632) - #7673

Draft
florent-leborgne wants to merge 3 commits into
mainfrom
docs-issue-7632-esql-csv-vars
Draft

docs: note that CSV reports apply selected ES|QL variable control values (#7632)#7673
florent-leborgne wants to merge 3 commits into
mainfrom
docs-issue-7632-esql-csv-vars

Conversation

@florent-leborgne

@florent-leborgne florent-leborgne commented Jul 31, 2026

Copy link
Copy Markdown
Member

Summary

This PR addresses #7632 by documenting how CSV reports interact with {{esql}} variable controls, split by reader need:

  • explore-analyze/discover/try-esql.md (Add variable controls to your Discover queries): a behavior note stating that when you generate a CSV report from a Discover session or a Discover session panel, the exported data reflects the values currently selected in the variable controls (immediate and scheduled reports). This is where users add controls and export, next to the existing stack: ga 9.5+ note on ES|QL CSV export behavior.
  • explore-analyze/report-and-share/reporting-troubleshooting-csv.md: an error-driven troubleshooting section for the Unknown query parameter failure that earlier versions returned, with the resolving versions and a workaround. This is the page a user pastes the error into, alongside sibling sections like Token expiration.

Placement reasoning:

  • The issue suggested the CSV report limitations list and the general ES|QL editor overview (esql-kibana.md). Neither fit: the new behavior isn't a limitation, and the editor overview only links out to the Discover procedure. The two real reader needs are "what gets exported" (behavior → Discover how-to) and "why did it fail" (error → troubleshooting), so the content is placed accordingly.
  • Dashboard side (out of scope): documenting the Generate CSV report action for Discover session panels on the dashboard export page is a broader pre-existing gap, tracked separately in Document exporting individual panels from a dashboard (CSV report from a Discover session panel) #7690.

Sourced from elastic/kibana#277916, which threads resolved ES|QL variable values through the reporting execution path (Discover export and dashboard Discover session panel action) and binds them when the query runs. Backported to 8.19, 9.3.9, and 9.4.4.

Resolves

Closes #7632


AI-generated draft — created with Claude Opus 4.8.
Review all generated content for factual accuracy before merging.

@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No 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.

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.

CSV reports now work for ES|QL queries that use variable controls

1 participant