Terminal
Terminal/Skill
Reviews changes to Kibana dashboard JSON in a pull request or branch, summarizing what changed and flagging departures from the dashboard guidelines.
By Elastic
Works with
npx skills add elastic/integration-skills --skill dashboard-reviewUse this skill when tasks include:
Do not use this skill as the primary guide for:
dashboard-guidelines)dashboard-guidelines → references/kibana-assets-layout.md)elastic-package-cli)integration-testing)kbdash must be installed:
go install github.com/efd6/kbdash@latest
Lines prefixed with [!] in the output are warnings about potential
issues in the dashboard JSON (consistency mismatches, incomplete
extraction, parse errors). Run kbdash -h for a description of each
warning type.
Read references/review-procedure.md for the full step-by-step
workflow. The high-level flow is:
kbdash.After summarizing changes, check the final state of every added or modified dashboard against the official dashboard guidelines. Report violations in a "Guideline notes" subsection after the change summary for each dashboard.
Check for these issues:
visualization panel using TSVB. The
guidelines require Lens for all new visualizations. Migrating
existing TSVB to Lens is encouraged.data_stream.dataset or an equivalently specific scope. Flag
panels that query broad index patterns (metrics-*, logs-*)
without scoping.lens,
visualization, and map panels with [!] <type> ref: … (definition not inlined). Flag these. Saved searches are
inherently referenced and carry a separate [!] saved search ref
warning — do not flag those.input-control-vis type is
deprecated. Dashboard-native controls should be used instead.[<Package Name> ...] create unnecessary repetition. Flag these.-* patterns
without further qualification are a performance concern.Panels (N total, …). If N exceeds roughly 20,
note it. The guidelines recommend splitting across dashboards and
linking with drilldowns.event.dataset instead of data_stream.dataset:
Saved-object queries (dashboards, saved searches, packaged ML job
datafeeds) must filter on data_stream.dataset. Some inputs
(e.g. packetbeat) never set event.dataset, so an
event.dataset filter silently matches nothing. Flag every
saved-object query in a diff that renames or re-maps fields._dev/shared/kibana/*.yaml (compiled to
kibana/dashboard/*.json with kb-dashboard), BOTH must be
committed and in sync. Flag JSON-only edits when a YAML source
exists for that dashboard.state.adHocDataViews, state.internalReferences, and per-layer
index keys (the ES|QL/Discover fix on Kibana 9.3+). Diffs beyond
those keys in a "regenerate" PR deserve inspection.Tags: section for
each dashboard (resolved from kibana/tag/ when run on a package
directory). New content-pack dashboards are expected to carry
Kibana asset tags — note their absence (LOW).kbdash <package-dir> to see all dashboard titles
(the === … === headers) alongside each links panel's Link:
lines. Note any dashboard whose title has no matching link.Only report issues that actually exist — skip passing checks. For pre-existing violations in unchanged panels, mention them once briefly ("N existing panels also use TSVB") rather than listing each one. Focus review attention on newly added or modified panels.
After the review is complete:
dashboard-guidelines for creation or export guidance if the review surfaces structural issuespackage-spec when dashboard changes require a release note entryelastic-package-cli for validation commandsreferences/review-procedure.md — full extraction, comparison, and output formatting workflow