Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Choraden committed Dec 18, 2023
1 parent 35511b2 commit 9e8883f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dashboard Fusion

Dashboard Fusion is a tool for merging and updating Grafana dashboards by combining panels from different sources.
It's designed to be used when working with dashboards that share common panels.
It allows to update existing panels, while preserving the dashboard layout.

## Fusion Behavior

Fusion is performed by merging panels from multiple sources into a single dashboard.
- Panels are matched by title and type.
- If a panel with the same title and type exists in the dashboard, its content will be replaced, except for its position (preserving the dashboard layout).
- If a panel with the same title and type does not exist in the dashboard, it will be appended to the end of the dashboard.
Later, the dashboard can be manually reorganized to achieve the desired layout.

## Usage

```bash
# Merge panels from panels1.json and panels2.json into dashboard.json and save the result to output.json
go run ./cmd/dashboard-fusion --dash <dashboard.json> --panels <panels1.json,panels2.json> --out <output.json>
```

0 comments on commit 9e8883f

Please sign in to comment.