Website | Twitter | Community & Forum
Grafana is an open source, feature rich metrics dashboard and graph editor for Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.
Head to docs.grafana.org for documentation or download to get the latest release.
Be sure to read the getting started guide and the other feature guides.
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
- Go (Latest Stable)
- bra [
go get github.com/Unknwon/bra]
- bra [
- Node.js LTS
- yarn [
npm install -g yarn]
- yarn [
The project located in the go-path will be your working directory.
go get github.com/grafana/grafana
cd $GOPATH/src/github.com/grafana/grafanago run build.go setup
go run build.go buildFor this you need Node.js (LTS version).
yarn install --pure-lockfileTo run the backend and rebuild on source change:
$GOPATH/bin/bra runRebuild on file change, and serve them by Grafana's webserver (http://localhost:3000):
yarn startBuild the assets, rebuild on file change with Hot Module Replacement (HMR), and serve them by webpack-dev-server (http://localhost:3333):
yarn start:hot
# OR set a theme
env GRAFANA_THEME=light yarn start:hotNote: HMR for Angular is not supported. If you edit files in the Angular part of the app, the whole page will reload.
Run tests and rebuild on source change:
yarn jestOpen grafana in your browser (default: e.g. http://localhost:3000) and login with admin user (default: user/pass = admin/admin).
There are two different ways to build a Grafana docker image. If your machine is setup for Grafana development and you run linux/amd64 you can build just the image. Otherwise, there is the option to build Grafana completely within Docker.
Run the image you have built using: docker run --rm -p 3000:3000 grafana/grafana:dev
- Build the frontend
go run build.go build-frontend - Build the docker image
make build-docker-dev
The resulting image will be tagged as grafana/grafana:dev
Choose this option to build on platforms other than linux/amd64 and/or not have to setup the Grafana development environment.
make build-docker-fullordocker build -t grafana/grafana:dev .
The resulting image will be tagged as grafana/grafana:dev
Notice: If you are using Docker for MacOS, be sure to set the memory limit to be larger than 2 GiB (at docker -> Preferences -> Advanced), otherwise grunt build may fail.
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:
- grafana.ini
- custom.ini
In your custom.ini uncomment (remove the leading ;) sign. And set app_mode = development.
Execute all frontend tests
yarn testWriting & watching frontend tests
- Start watcher:
yarn jest - Jest will run all test files that end with the name ".test.ts"
# Run Golang tests using sqlite3 as database (default)
go test ./pkg/...
# Run Golang tests using mysql as database - convenient to use /docker
7F56
/blocks/mysql_tests
GRAFANA_TEST_DB=mysql go test ./pkg/...
# Run Golang tests using postgres as database - convenient to use /docker/blocks/postgres_tests
GRAFANA_TEST_DB=postgres go test ./pkg/...Here you can find helpful scripts and docker-compose setup that will populate your dev environment for quicker testing end experimenting.
If you have any ideas for improvement or have found a bug, do not hesitate to open an issue. And if you have time, clone this repo and submit a pull request to help me make Grafana the kickass metrics & devops dashboard we all dream about!
Read the contributing guide then check the beginner friendly label to find issues that are easy and that we would like help with.
Checkout the Plugin Development Guide and checkout the PLUGIN_DEV.md file for changes in Grafana that relate to plugin development.
Grafana is distributed under Apache 2.0 License.