Skip to content

docs(grafana): document Classic file-export for --input-mode files - #297

Open
Shaurya2k06 wants to merge 1 commit into
elastic:mainfrom
Shaurya2k06:docs/grafana-file-export-scope
Open

docs(grafana): document Classic file-export for --input-mode files#297
Shaurya2k06 wants to merge 1 commit into
elastic:mainfrom
Shaurya2k06:docs/grafana-file-export-scope

Conversation

@Shaurya2k06

Copy link
Copy Markdown

Summary

  • Add a File Export Scope section to docs/sources/grafana.md (next to Live Extraction Scope) for --input-mode files / --source files.
  • Tell operators to use Grafana Share → Export defaults: Model = Classic, format = JSON (no Advanced options needed).
  • Call out that V1/V2 resource exports and YAML are not accepted today — the extractor skips them and surfaces no Grafana dashboards found ... expected top-level 'panels' or 'rows' key.
  • Note that the sharing toggles ("Share dashboard with another instance" / "Export for sharing externally") only swap datasource placeholders and do not change migratability; API-shaped {"dashboard": ...} JSON wrappers are still accepted.

Docs-only; no code or behavior changes. V1/V2/YAML ingestion remains a non-goal.

Validation

  • Docs reviewed after editing
  • Commands validated against canonical sources
  • .venv/bin/python -m pytest tests/ -x -q
  • Generated docs refreshed if needed (N/A — no generated docs)

Checklist

  • Scope is focused
  • Docs updated
  • No secrets committed

Closes #296

Operators exporting from Grafana's Share dialog often pick V1/V2 resource
or YAML shapes that the file extractor silently skips. Document the
default Classic JSON path so offline migrations fail less mysteriously.

Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
@cla-checker-service

cla-checker-service Bot commented Jul 15, 2026

Copy link
Copy Markdown

💚 CLA has been signed

@Shaurya2k06
Shaurya2k06 marked this pull request as draft July 15, 2026 11:09
@Shaurya2k06
Shaurya2k06 marked this pull request as ready for review July 15, 2026 11:09
@Shaurya2k06

Copy link
Copy Markdown
Author

@miguel-sanchez-elastic could I get a review on this? Happy to make changes if required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Grafana dashboard export format requirements for file-based migration

1 participant