Skip to content

[Elasticsearch]: Docs table and query analytics dashboard#18905

Merged
consulthys merged 2 commits into
mainfrom
consulthys/fix-elasticsearch-querylog-docs-table
May 9, 2026
Merged

[Elasticsearch]: Docs table and query analytics dashboard#18905
consulthys merged 2 commits into
mainfrom
consulthys/fix-elasticsearch-querylog-docs-table

Conversation

@consulthys
Copy link
Copy Markdown
Contributor

@consulthys consulthys commented May 9, 2026

Summary

Relates to #13374

Follow-up fixes for the Elasticsearch integration querylog work (integrations#18859):

  1. Exported fields docs — Pipe characters in ES|QL broke Markdown table columns in the generated field reference.
  2. Query analytics dashboard — After stripping newer-Kibana-only dashboard attributes for CI compatibility (sections, etc.), some panels kept section-relative grid coordinates (y: 0 / y: 2) and appeared at the top of the dashboard instead of the bottom. The Historical queries panel used a discover_session embeddable tied to a Discover tab id that is not portable with the package, which triggered “The Discover session tab saved with this panel no longer exists” after install.

Changes

Documentation

  • Replace ES|QL with ES|QL in data_stream/querylog/fields/fields.yml descriptions (renders as ES|QL without splitting Markdown table cells).
  • Regenerate docs/README.md via elastic-package build.

Query analytics dashboard (kibana/dashboard/elasticsearch-query-analytics-dashboard.json)

  • Replace discover_session with a search embeddable (panelRefName: savedObjectRef) so Historical queries uses the packaged saved search elasticsearch-5df8f5ab-0459-4c89-95b4-3b3d235386bd instead of an ephemeral Discover session id.
  • Move remote-cluster Lens panels and Coordinating clusters / Remote aliases controls to bottom grid rows (y 91+ / 93+) so layout matches the intended order below the main charts.

Testing

  • elastic-package check (lint + package build / README render)

cc @elastic/stack-monitoring

…tables

Pipe characters in descriptions broke the exported-fields Markdown table.
Use HTML entity | for the separator so cells stay aligned while still
rendering as ES|QL.

Co-authored-by: Cursor <cursoragent@cursor.com>
@consulthys consulthys requested a review from a team as a code owner May 9, 2026 04:06
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)
File Line Rule Message
packages/elasticsearch/docs/README.md 308 Elastic.WordChoice Consider using 'select, press, visits' instead of 'hit', unless the term is in the UI.

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.

…h panel

- Replace discover_session embeddable with saved search panel (fixes missing
  Discover session tab after package install).
- Move remote-cluster section panels and controls to bottom grid rows after
  section metadata was removed for older Kibana compatibility.

Co-authored-by: Cursor <cursoragent@cursor.com>
@consulthys consulthys changed the title fix(elasticsearch): escape ES|QL in querylog exported-fields table fix(elasticsearch): querylog field docs table and query analytics dashboard May 9, 2026
@consulthys consulthys requested a review from pickypg May 9, 2026 04:33
@consulthys consulthys changed the title fix(elasticsearch): querylog field docs table and query analytics dashboard [Elasticsearch]: Docs table and query analytics dashboard May 9, 2026
@consulthys consulthys added Integration:elasticsearch Elasticsearch Feature:Stack Monitoring Stack Monitoring Feature Team:Stack Monitoring Stack Monitoring team [elastic/stack-monitoring] labels May 9, 2026
@consulthys consulthys self-assigned this May 9, 2026
@consulthys consulthys enabled auto-merge (squash) May 9, 2026 04:53
@elastic-vault-github-plugin-prod
Copy link
Copy Markdown

🚀 Benchmarks report

Package elasticsearch 👍(2) 💚(1) 💔(3)

Expand to view
Data stream Previous EPS New EPS Diff (%) Result
audit 3412.97 1078.75 -2334.22 (-68.39%) 💔
deprecation 6024.1 4854.37 -1169.73 (-19.42%) 💔
slowlog 8064.52 5208.33 -2856.19 (-35.42%) 💔

To see the full report comment with /test benchmark fullreport

@elasticmachine
Copy link
Copy Markdown

💚 Build Succeeded

cc @consulthys

@consulthys consulthys merged commit a46e492 into main May 9, 2026
12 checks passed
@consulthys consulthys deleted the consulthys/fix-elasticsearch-querylog-docs-table branch May 9, 2026 05:27
@consulthys consulthys linked an issue May 9, 2026 that may be closed by this pull request
@elastic-vault-github-plugin-prod
Copy link
Copy Markdown

Package elasticsearch - 1.21.1 containing this change is available at https://epr.elastic.co/package/elasticsearch/1.21.1/

@andrewkroh andrewkroh added dashboard Relates to a Kibana dashboard bug, enhancement, or modification. documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. labels May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dashboard Relates to a Kibana dashboard bug, enhancement, or modification. documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Feature:Stack Monitoring Stack Monitoring Feature Integration:elasticsearch Elasticsearch Team:Stack Monitoring Stack Monitoring team [elastic/stack-monitoring]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Elasticsearch]: Create new file set for querylog

4 participants