Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jirwin/grapr
A tool for importing dashboards into grafana so they can easily be stored next to your code.
https://github.com/jirwin/grapr
Last synced: about 1 month ago
JSON representation
A tool for importing dashboards into grafana so they can easily be stored next to your code.
- Host: GitHub
- URL: https://github.com/jirwin/grapr
- Owner: jirwin
- License: mit
- Created: 2015-07-03T07:36:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-07-04T21:25:07.000Z (over 9 years ago)
- Last Synced: 2024-10-19T05:19:02.142Z (3 months ago)
- Language: JavaScript
- Size: 156 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grapr
A tool for importing dashboards into [Grafana](http://grafana.org/) so they can easily be stored next to your code.
## Example Usage
`$ node index.js --dashboard examples/new-dashboard.js`
### Options
- dashboard - The path to the dashboard JSON you'd like to create
- esHost - The host for your elasticsearch server. Defaults to `localhost`
- esPost - The port for your elasticsearch server. Defaults to `9200`
## Dashboard format
The dashboards this processes are just a little more than what is exported directly from Grafana. `name` is a unique identifier(no spaces) for the dashboard. The `dashboard` field is the JSON exported from Grafana.
```json
{
"name": "this-is-a-unique-name-for-the-dashboard",
"dashboard": {
"id": null,
"title": "New Dashboard",
"originalTitle": "New Dashboard",
"tags": [],
"style": "dark",
"timezone": "browser",
"editable": true,
"hideControls": false,
"rows": [
{
"title": "Row1",
"height": "250px",
"editable": true,
"collapse": false,
"panels": [
{
"error": false,
"span": 12,
"editable": true,
"type": "graph",
"id": 1,
"datasource": null,
"renderer": "flot",
"x-axis": true,
"y-axis": true,
"scale": 1,
"y_formats": [
"short",
"short"
],
"grid": {
"leftMax": null,
"rightMax": null,
"leftMin": null,
"rightMin": null,
"threshold1": null,
"threshold2": null,
"threshold1Color": "rgba(216, 200, 27, 0.27)",
"threshold2Color": "rgba(234, 112, 112, 0.22)"
},
"annotate": {
"enable": false
},
"resolution": 100,
"lines": true,
"fill": 0,
"linewidth": 1,
"points": false,
"pointradius": 5,
"bars": false,
"stack": false,
"legend": {
"show": true,
"values": false,
"min": false,
"max": false,
"current": false,
"total": false,
"avg": false
},
"percentage": false,
"zerofill": true,
"nullPointMode": "connected",
"steppedLine": false,
"tooltip": {
"value_type": "cumulative",
"query_as_alias": true
},
"targets": [
{
"target": "randomWalk('randomWalk')"
}
],
"aliasColors": {},
"seriesOverrides": [],
"title": "No title"
}
]
}
],
"nav": [
{
"type": "timepicker",
"enable": true,
"status": "Stable",
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
],
"refresh_intervals": [
"5s",
"10s",
"30s",
"1m",
"5m",
"15m",
"30m",
"1h",
"2h",
"1d"
],
"now": true,
"collapse": false,
"notice": false
}
],
"time": {
"from": "now-6h",
"to": "now"
},
"templating": {
"list": []
},
"annotations": {
"list": [],
"enable": false
},
"refresh": false,
"version": 6
}
}
```