
dashboard-review
Use when reviewing dashboard JSON changes in a PR or branch. Extracts structured descriptions with kbdash, compares before/after, and checks guideline compliance.
- Installs
- 511
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/elastic/integration-skills --skill dashboard-review- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads dashboard-review automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
dashboard-review
When to use
Use this skill when tasks include:
- reviewing a PR that modifies Kibana dashboard JSON files
- comparing dashboard changes between branches
- summarizing what changed in dashboard exports
- checking dashboard changes against the official dashboard guidelines
When not to use
Do not use this skill as the primary guide for:
- creating new dashboards or exporting them from Kibana (
dashboard-guidelines) - dashboard naming conventions and file layout (
dashboard-guidelines→references/kibana-assets-layout.md) - package-wide command orchestration (
elastic-package-cli) - test suite selection (
integration-testing)
Prerequisites
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.
Review procedure
Read references/review-procedure.md for the full step-by-step
workflow. The high-level flow is:
- Identify changed dashboard files (added, removed, modified).
- Extract before/after descriptions with
kbdash. - Compare descriptions and classify changes as meaningful or cosmetic.
- Verify suspected issues against the raw JSON before reporting.
- Format output as one section per dashboard with bullet-pointed changes.
- Check guideline compliance on added or modified dashboards.
Guideline compliance checks
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:
- TSVB panels: Flag any
visualizationpanel using TSVB. The guidelines require Lens for all new visualizations. Migrating existing TSVB to Lens is encouraged. - Missing dataset filter: Each visualization should filter on
data_stream.datasetor an equivalently specific scope. Flag panels that query broad index patterns (metrics-*,logs-*) without scoping. - By-reference visualizations: Visualization and lens panels
should be embedded by value. kbdash flags by-reference
lens,visualization, andmappanels with[!] <type> ref: … (definition not inlined). Flag these. Saved searches are inherently referenced and carry a separate[!] saved search refwarning — do not flag those. - Deprecated input controls: The
input-control-vistype is deprecated. Dashboard-native controls should be used instead. - Package-name title prefix: Panel titles matching
[<Package Name> ...]create unnecessary repetition. Flag these. - Broad wildcard filters: Filters using unscoped
-*patterns without further qualification are a performance concern. - High panel count: kbdash includes the count in the panels
section header —
Panels (N total, …). If N exceeds roughly 20, note it. The guidelines recommend splitting across dashboards and linking with drilldowns. - Queries on
event.datasetinstead ofdata_stream.dataset: Saved-object queries (dashboards, saved searches, packaged ML job datafeeds) must filter ondata_stream.dataset. Some inputs (e.g. packetbeat) never setevent.dataset, so anevent.datasetfilter silently matches nothing. Flag every saved-object query in a diff that renames or re-maps fields. - YAML dashboard sources out of sync: When a package keeps YAML
dashboard sources in
_dev/shared/kibana/*.yaml(compiled tokibana/dashboard/*.jsonwith kb-dashboard), BOTH must be committed and in sync. Flag JSON-only edits when a YAML source exists for that dashboard. - Regeneration diffs: A recompile PR is expected to change only
state.adHocDataViews,state.internalReferences, and per-layerindexkeys (the ES|QL/Discover fix on Kibana 9.3+). Diffs beyond those keys in a "regenerate" PR deserve inspection. - Missing Kibana asset tags: kbdash shows a
Tags:section for each dashboard (resolved fromkibana/tag/when run on a package directory). New content-pack dashboards are expected to carry Kibana asset tags — note their absence (LOW). - Navigation link completeness: If a dashboard has a links panel,
verify that every dashboard in the package has a corresponding
entry. Run
kbdash <package-dir>to see all dashboard titles (the=== … ===headers) alongside each links panel'sLink: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.
Handoff to other skills
After the review is complete:
dashboard-guidelinesfor creation or export guidance if the review surfaces structural issuespackage-specwhen dashboard changes require a release note entryelastic-package-clifor validation commands
References
references/review-procedure.md— full extraction, comparison, and output formatting workflow
FAQ
What does the dashboard-review skill do?
Use when reviewing dashboard JSON changes in a PR or branch. Extracts structured descriptions with kbdash, compares before/after, and checks guideline compliance.
How do I install dashboard-review?
Run npx skills add https://github.com/elastic/integration-skills --skill dashboard-review in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/dashboard-review/ (personal) or .claude/skills/dashboard-review/ (project).
Which AI agents can use dashboard-review?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is dashboard-review safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains dashboard-review?
It is published by elastic in elastic/integration-skills. It has 511 recorded installs.
More from elastic/integration-skills
ingest-pipelines
elastic/integration-skills
Use when designing or modifying Elasticsearch ingest pipelines, including single-path parsing, branching logic, sub-pipelines, enrichment processors, and robust onfailure handling.
integration-testing
elastic/integration-skills
Use when creating, running, or debugging elastic-package tests — pipeline fixture authoring and expected output, system tests with mock API wiring, and script tests for failure paths and upgrades. Load the reference file for the test type you are working on.
research-integration
elastic/integration-skills
Research a vendor, product, or feature to collect all information needed before building an Elastic integration. Investigates data collection methods, API or log documentation, sample data formats, field schemas, ECS mapping candidates, and configuration requirements. Outputs a structured research brief to researchresults/ /. Invoke manually with /research-integration.
ecs-field-mappings
elastic/integration-skills
Use when defining field mappings for data streams, populating ecs.yml with ECS field references, selecting ECS categorization values, choosing custom field types, or troubleshooting mapping validation failures.
anonymize-logs
elastic/integration-skills
Anonymize and sanitize customer-provided log files. Performs a line-by-line review and replaces all sensitive values inline, preserving log structure and format exactly — never reformats, re-indents, or restructures content. Use when sanitizing customer logs, sample events, or test fixtures. Invoke manually with /anonymize-logs.
create-integration
elastic/integration-skills
Use when creating a new Elastic integration package, scaffolding data streams, answering package layout or structure questions, or running the end-to-end integration build workflow. Covers package topology, scaffold commands, post-scaffold edits, and full orchestration of CEL/pipeline/test subagents.
Popular data & databases skills
supabase-postgres-best-practices
supabase/agent-skills
Postgres best practices maintained by Supabase, for Postgres running anywhere. Load this skill BEFORE writing or changing anything that lives in a Postgres database: creating or altering tables and columns (including choosing column types), schema design, migrations and declarative schema files, RLS policies and the tests that verify them, indexes, triggers, database functions, queues and scheduled jobs (pgcron, pgmq), vector/semantic search (pgvector), and restoring dumps (pgrestore) or importing data. Also load it when diagnosing slow queries, high CPU, timeouts, EXPLAIN plans, connection exhaustion, locking, bloat, or rows visible to the wrong user or tenant. This is not just a performance guide — schema, migration, security, and SQL authoring tasks need these rules too, even for a one-column change or a single query.
prisma-client-api
prisma/skills
Prisma Client API reference covering model queries, filters, operators, and client methods. Use when writing database queries, using CRUD operations, filtering data, or configuring Prisma Client. Triggers on "prisma query", "findMany", "create", "update", "delete", "$transaction".
prisma-database-setup
prisma/skills
Deprecated compatibility name for prisma-orm-setup. Use only when a user or existing integration explicitly invokes prisma-database-setup; otherwise select prisma-orm-setup.
prisma-cli
prisma/skills
Prisma ORM 7 CLI reference for existing Prisma 7 applications or explicitly selected Prisma 7 workflows. Covers prisma init, generate, migrate, db, dev, studio, and mcp. For setup, connection repair, or Prisma 8, use prisma-orm-setup; not the Prisma Platform CLI.
prisma-postgres
prisma/skills
Deprecated compatibility name for prisma-postgres-setup. Use only when a user or existing integration explicitly invokes prisma-postgres; otherwise select prisma-postgres-setup.
prisma-driver-adapter-implementation
prisma/skills
Required reference for Prisma ORM 7 SQL driver adapter work. Use when implementing or modifying adapters, adding database drivers, or touching SqlDriverAdapter, Transaction, savepoint, result mapping, or DriverAdapterError behavior. Covers current transaction lifecycle, optional savepoint hooks, original database-error preservation, and verification.