Skip to content

A tool to LIST, ADD and DELETE dashboards on a given Grafana Instance

Notifications You must be signed in to change notification settings

BennyG93/GrafPushr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grafana Dashboard Pusher

Store JSON Dashboard templates in ./tmeplates

Examples:
  • Listing all Grafana Dashboards
$ ./GrafPushr.rb -o list -u grafana.example.com -d all
Listing all dashboards:
Database Performance - db/database-performance
System Healthcheck - db/system-healthcheck
  • Adding a Dashboard to Grafana
$ ./GrafPushr.rb -o add -u grafana.example.com -d system-healthcheck
ADDING Dashboard
{"slug":"system-healthcheck","status":"success","version":0}
  • Deleting a Dashboard from Grafana
$ ./GrafPushr.rb -o delete -u grafana.example.com -d system-healthcheck
DELETED Dashboard:
{"title":"System Healthcheck"}
Usage:
$ ./GrafPushr.rb -h
	The Dashboard Pusher is a simple Ruby wrapper for the Grafana API.
	It is only desinged for Dashboards and has 3 functions LIST, ADD, DELETE.

	Example:
	$ ./GrafPushr.rb -o list -u grafana.example.com -d system-healthcheck

	Usage:
		ruby api_tool.rb [options]
	where [options] are:
  -o, --option=<s>       LIST, ADD, DELETE
  -u, --url=<s>          Grafana URL
  -d, --dashboard=<s>    Name of Dashboard JSON file saved in ./files
  -v, --version          Print version and exit
  -h, --help             Show this message
Testing:

RSPEC tests have been written which will test the HTTP calls and stub the responses

Tests are invoked using rake

$ rake -T
rake jsonlint  # JSON Lint test on files in templates directory
rake spec      # Run all tests for this tool
rake spec

External request
  queries Grafana LIST all Dashboards API service
  queries Grafana ADD Dashboards API service
  queries Grafana DELTE Dashboards API service

Finished in 0.01331 seconds (files took 0.37656 seconds to load)
3 examples, 0 failures

About

A tool to LIST, ADD and DELETE dashboards on a given Grafana Instance

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages