Skip to content

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

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.

Sign up for GitHub

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

Draft
florent-leborgne wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
837b03c
docs: note that CSV reports apply selected ES|QL variable control val…
florent-leborgne Jul 31, 2026
e191e67
docs: move ES|QL variable control export note to Discover how-to (#7632)
florent-leborgne Jul 31, 2026
ba1aa28
docs: split behavior vs failure by audience; drop limitations note (#…
florent-leborgne Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions explore-analyze/discover/try-esql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,11 @@ Variable controls help you make your queries more dynamic instead of having to m

You can add them from your Discover {{esql}} query.

:::{note}
:applies_to: {"stack": "ga 9.5", "serverless": "ga"}
When you generate a [CSV report](/explore-analyze/report-and-share.md#csv-limitations) from a Discover session or a Discover session panel on a dashboard, the exported data reflects the values currently selected in the variable controls. This applies to both immediate and scheduled reports.
:::

:::{include} ../_snippets/variable-control-procedure.md
:::

Expand Down
13 changes: 13 additions & 0 deletions explore-analyze/report-and-share/reporting-troubleshooting-csv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,19 @@ The listing of reports in **Stack Management > Reporting** allows you to inspect
:::


## ES|QL variable control errors [reporting-troubleshooting-csv-esql-variables]

Generating a CSV report from an {{esql}} query that references a [variable control](/explore-analyze/discover/try-esql.md#add-variable-control), such as `?crew_id`, can fail with an error like:

```txt
parsing_exception: Unknown query parameter [crew_id]
```

This occurs on versions where the reporting task didn't pass the selected control values through to the query. It was resolved in 9.5.0 and backported to the 8.19, 9.3.9, and 9.4.4 patch releases, so that reports now run with the values currently selected in the controls.

To work around the error on an earlier version, upgrade to a version that includes the fix, or replace the variable references in the query with fixed values before you export.


## Token expiration [reporting-troubleshooting-csv-token-expired]

A relatively common type of error seen for CSV exports is: `security_exception Root causes: security_exception: token expired`.
Expand Down
Loading