[Web & messaging OTel] Regenerate OTel dashboards with adHocDataViews - #20378
Conversation
Recompile the committed Kibana dashboards for iis_otel, traefik_otel, apache_tomcat_otel, haproxy_otel, activemq_otel and ibmmq_otel with the Elastic fork of the dashboard compiler so every ES|QL Lens layer gains a populated adHocDataViews, internalReferences and per-layer index. This fixes the broken "Explore in Discover" action on Kibana 9.3+ (elastic/obs-integration-team#1014). The only intended JSON change is those additions (plus an occasional benign legendPosition). iis_otel is JSON-only (its _dev YAML is left untouched) so the pinned CI dashboard compiler does not recompile empty adHocDataViews and fail CI. Bumps each package's patch version and adds a bugfix changelog entry (PR link placeholder to be replaced once the PR number is known).
✅ 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. |
|
✅ All changelog entries have the correct PR link. |
💚 Build Succeeded
|
There was a problem hiding this comment.
Pull request overview
Regenerates compiled Kibana dashboard saved-object JSON for several web & messaging OpenTelemetry asset packages so ES|QL Lens layers include populated adHocDataViews, internalReferences, and per-layer index (to restore “Explore in Discover” behavior on newer Kibana versions). Also bumps each affected package’s patch version and records the change in changelog.yml.
Changes:
- Patch-version bumps in affected package
manifest.ymlfiles. - Regenerated dashboard JSON assets to include
adHocDataViews/internalReferences/ per-layerindexmetadata. - Added
bugfixchangelog entries referencing the regeneration.
Reviewed changes
Copilot reviewed 33 out of 35 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/traefik_otel/manifest.yml | Patch version bump to ship regenerated dashboards. |
| packages/traefik_otel/kibana/dashboard/traefik_otel-tls-config.json | Regenerated compiled dashboard JSON with populated ES |
| packages/traefik_otel/kibana/dashboard/traefik_otel-services.json | Regenerated compiled dashboard JSON with populated ES |
| packages/traefik_otel/kibana/dashboard/traefik_otel-process.json | Regenerated compiled dashboard JSON with populated ES |
| packages/traefik_otel/kibana/dashboard/traefik_otel-overview.json | Regenerated compiled dashboard JSON with populated ES |
| packages/traefik_otel/changelog.yml | Adds bugfix changelog entry for dashboard regeneration. |
| packages/iis_otel/manifest.yml | Patch version bump to ship regenerated dashboards. |
| packages/iis_otel/changelog.yml | Adds bugfix changelog entry for dashboard regeneration. |
| packages/ibmmq_otel/manifest.yml | Patch version bump to ship regenerated dashboards. |
| packages/ibmmq_otel/kibana/dashboard/ibmmq_otel-overview.json | Regenerated compiled dashboard JSON with populated ES |
| packages/ibmmq_otel/kibana/dashboard/ibmmq_otel-error-analysis.json | Regenerated compiled dashboard JSON with populated ES |
| packages/ibmmq_otel/changelog.yml | Adds bugfix changelog entry for dashboard regeneration. |
| packages/haproxy_otel/manifest.yml | Patch version bump to ship regenerated dashboards. |
| packages/haproxy_otel/kibana/dashboard/haproxy_otel-server.json | Regenerated compiled dashboard JSON with populated ES |
| packages/haproxy_otel/kibana/dashboard/haproxy_otel-overview.json | Regenerated compiled dashboard JSON with populated ES |
| packages/haproxy_otel/kibana/dashboard/haproxy_otel-frontend.json | Regenerated compiled dashboard JSON with populated ES |
| packages/haproxy_otel/kibana/dashboard/haproxy_otel-backend.json | Regenerated compiled dashboard JSON with populated ES |
| packages/haproxy_otel/changelog.yml | Adds bugfix changelog entry for dashboard regeneration. |
| packages/apache_tomcat_otel/manifest.yml | Patch version bump to ship regenerated dashboards. |
| packages/apache_tomcat_otel/kibana/dashboard/apache_tomcat_otel-thread-pool-connections.json | Regenerated compiled dashboard JSON with populated ES |
| packages/apache_tomcat_otel/kibana/dashboard/apache_tomcat_otel-request-processing.json | Regenerated compiled dashboard JSON with populated ES |
| packages/apache_tomcat_otel/changelog.yml | Adds bugfix changelog entry for dashboard regeneration. |
| packages/activemq_otel/manifest.yml | Patch version bump to ship regenerated dashboards. |
| packages/activemq_otel/kibana/dashboard/activemq_otel-overview.json | Regenerated compiled dashboard JSON with populated ES |
| packages/activemq_otel/kibana/dashboard/activemq_otel-destinations.json | Regenerated compiled dashboard JSON with populated ES |
| packages/activemq_otel/kibana/dashboard/activemq_otel-broker-health.json | Regenerated compiled dashboard JSON with populated ES |
| packages/activemq_otel/changelog.yml | Adds bugfix changelog entry for dashboard regeneration. |
Suppressed comments (1)
packages/haproxy_otel/kibana/dashboard/haproxy_otel-overview.json:123
- The PR description states the only intentional diffs in compiled dashboards are additions of
adHocDataViews,internalReferences, and per-layerindex(plus occasionallegendPosition). In this dashboard, the compiled Lens state also changeslayerIdvalues (e.g.state.visualization.layerIdhere) and the dashboardattributes.descriptiontext (line 4), which goes beyond the described/checked scope. Please either update the PR description/checklist to acknowledge these additional diffs and confirm they’re expected/benign, or regenerate in a way that preserves stable layer IDs if that’s required.
"visualization": {
"layerId": "737d5f1c-e4b5-bced-df13-f856e5fa3136",
"layerType": "data",
"metricAccessor": "add1b5db-6cde-6603-e764-93623cd42282",
"showBar": false,
"applyColorTo": "background"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Tick the box to add this pull request to the merge queue (same as
|
|
Package activemq_otel - 0.3.1 containing this change is available at https://epr.elastic.co/package/activemq_otel/0.3.1/ |
|
Package apache_tomcat_otel - 0.3.1 containing this change is available at https://epr.elastic.co/package/apache_tomcat_otel/0.3.1/ |
|
Package haproxy_otel - 0.3.1 containing this change is available at https://epr.elastic.co/package/haproxy_otel/0.3.1/ |
|
Package ibmmq_otel - 0.3.1 containing this change is available at https://epr.elastic.co/package/ibmmq_otel/0.3.1/ |
|
Package iis_otel - 0.5.1 containing this change is available at https://epr.elastic.co/package/iis_otel/0.5.1/ |
|
Package traefik_otel - 0.3.1 containing this change is available at https://epr.elastic.co/package/traefik_otel/0.3.1/ |
Proposed commit message
Regenerate the compiled Kibana dashboards for six OTel packages (
iis_otel,traefik_otel,apache_tomcat_otel,haproxy_otel,activemq_otel,ibmmq_otel) by recompiling their YAML sources with the Elastic fork of the dashboard compiler (elastic/kb-yaml-to-lens, which addsadHocDataViewsto compiled objects).adHocDataViews,internalReferences, and per-layerindex. No queries, titles, visualization types, dimensions, filters, controls, or layout change — the only intentional diff is those additions (plus an occasional benignlegendPosition).kb-dashboard-cli==0.4.1) emitted"adHocDataViews": {}and omitted the per-layerindex/internalReferences. On Kibana 9.3+ this breaks the panel "Explore in Discover" action (elastic/obs-integration-team#1014). Repopulating those fields restores it.iis_otelis JSON-only: its_devYAML source is intentionally left unchanged so the pinnedvalidate-dashboardsCI compiler does not recompile emptyadHocDataViewsand fail CI; only its compiled JSON is updated.Each package gets a patch version bump and a
bugfixchangelog entry.Checklist
changelog.ymlfile.Author's Checklist
adHocDataViews,internalReferences, and per-layerindex(plus occasionallegendPosition) — no query/title/viz-type/layout drift.iis_otelis intentionally JSON-only (its_dev/shared/kibanaYAML is unchanged) so the pinned dashboard-compiler CI check stays green.How to test this PR locally
Executed by the author on a Kibana 9.5 stack (issue #1014 reproduces on 9.3+):
main, and every ES|QL panel now has a populatedadHocDataViews:iis_otel— 2 dashboards / 34 ES|QL panels / 34 with adHocDataViewstraefik_otel— 4 / 37 / 37apache_tomcat_otel— 6 / 104 / 104haproxy_otel— 4 / 41 / 41activemq_otel— 3 / 36 / 36ibmmq_otel— 4 / 64 / 64traefik_otel(with sample data ingested so panels render): on themainbuild the panel menu exposed no "Explore in Discover" and the dashboard JSON had emptyadHocDataViews; on this build "Explore in Discover" appears, opens Discover with the panel's ES|QL query / index pattern / columns / time range preserved, and noCannot read properties of undefined (reading 'id')(Prepare requested resources visualizations for Kubernetes Observability #1014) console error.Reviewer steps:
Related issues
Screenshots
This PR changes only compiled dashboard JSON (no UI/config forms). The before/after "Explore in Discover" behavior on
traefik_otelwas verified live on Kibana 9.5; a summary is posted on the tracking issue elastic/obs-integration-team#1148.