steventobin/grafana repository overview

⁠Grafana⁠

Website⁠ | Twitter⁠ | Community & Forum⁠

Grafana is an open source, feature rich metrics dashboard and graph editor for Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.

⁠Grafana v5 Alpha Preview

Grafana master is now v5.0 alpha. This is going to be the biggest and most foundational release Grafana has ever had, coming with a ton of UX improvements, a new dashboard grid engine, dashboard folders, user teams and permissions. Checkout out this video preview⁠ of Grafana v5.

⁠Installation

Head to docs.grafana.org⁠ and download⁠ the latest release.

If you have any problems please read the troubleshooting guide⁠.

⁠Documentation & Support

Be sure to read the getting started guide⁠ and the other feature guides.

⁠Run from master

If you want to build a package yourself, or contribute - Here is a guide for how to do that. You can always find the latest master builds here⁠

⁠Dependencies

• Go 1.9
• NodeJS LTS

⁠Building the backend

go get github.com/grafana/grafana
cd ~/go/src/github.com/grafana/grafana
go run build.go setup
go run build.go build

⁠Building frontend assets

For this you need nodejs (v.6+).

npm install -g yarn
yarn install --pure-lockfile
npm run watch

Run tests

npm run jest

Run karma tests

npm run karma

⁠Recompile backend on source change

To rebuild on source change.

go get github.com/Unknwon/bra
bra run

Open grafana in your browser (default: http://localhost:3000) and login with admin user (default: user/pass = admin/admin).

⁠Dev config

Create a custom.ini in the conf directory to override default configuration options. You only need to add the options you want to override. Config files are applied in the order of:

1. grafana.ini
2. custom.ini

In your custom.ini uncomment (remove the leading ;) sign. And set app_mode = development.

⁠Running tests

• You can run backend Golang tests using "go test ./pkg/...".
• Execute all frontend tests with "npm run test"

Writing & watching frontend tests (we have two test runners)

• jest for all new tests that do not require browser context (React+more)
  • Start watcher: npm run jest
  • Jest will run all test files that end with the name ".jest.ts"
• karma + mocha is used for testing angularjs components. We do want to migrate these test to jest over time (if possible).
  • Start watcher: npm run karma
  • Karma+Mocha runs all files that end with the name "_specs.ts".

⁠Contribute

If you have any idea for an improvement or found a bug, do not hesitate to open an issue. And if you have time clone this repo and submit a pull request and help me make Grafana the kickass metrics & devops dashboard we all dream about!

⁠Plugin development

Checkout the Plugin Development Guide⁠ and checkout the PLUGIN_DEV.md⁠ file for changes in Grafana that relate to plugin development.

⁠License

Grafana is distributed under Apache 2.0 License.