The tool for beautiful monitoring and metric analytics & dashboards for Graphite, InfluxDB & Prometheus & More
Go TypeScript HTML CSS JavaScript Shell Other
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci Don't build-all for PRs Jul 11, 2018
.github github: test new issue tempalte Mar 9, 2018
conf docs: minor docs fix Jul 18, 2018
devenv fix: postgres/mysql engine cache was not being used, fixes #12636 (#1… Jul 18, 2018
docker nginx: update to docker block Jul 16, 2018
docs docs: minor docs fix Jul 18, 2018
emails update email default year and name Mar 20, 2018
examples update broken links (#6961) Dec 14, 2016
packaging docs: release 5.1.0-beta1 Apr 20, 2018
pkg Merge pull request #11624 from mtanda/cw_get_metric_data Jul 22, 2018
public Merge pull request #11624 from mtanda/cw_get_metric_data Jul 22, 2018
scripts move go vet out of scripts and fixing warning (#12552) Jul 10, 2018
tasks/options Create annotations (#8197) Oct 7, 2017
tests folders: basic integration tests for folders Feb 20, 2018
tools/phantomjs Backend image rendering as plugin (#11966) May 24, 2018
vendor dep ensure Jul 9, 2018
.bra.toml dev: only build server with bra run Apr 19, 2018
.dockerignore Include the vendor directory when copying source in to Docker (#12305) Jun 18, 2018
.editorconfig support for loading function definitions from graphite Jan 16, 2018
.gitignore devenv: updated devenv provision scripts Jul 7, 2018
.jscs.json feat(import): things are starting to work May 13, 2016
.jshintrc API Integration Tests via jest (#10899) Feb 14, 2018
CHANGELOG.md changelog: adds note for #11487 Jul 22, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#8960) Jul 31, 2017
Gopkg.lock dep ensure Jul 9, 2018
Gopkg.toml update aws-sdk-go Jul 9, 2018
Gruntfile.js build: crossplatform build with packages. May 18, 2018
LICENSE.md Update LICENSE.md Nov 24, 2017
Makefile Support for local Docker builds May 7, 2018
NOTICE.md Update NOTICE.md Nov 24, 2017
PLUGIN_DEV.md Webpack Grafana plugin template project to links (#11457) Apr 3, 2018
README.md Fix typo in README.md May 24, 2018
ROADMAP.md Update ROADMAP.md Jun 26, 2018
appveyor.yml build: always build for all platforms. May 23, 2018
build.go added: replaces added to grafana Jul 18, 2018
codecov.yml disable codecov comments Apr 17, 2018
jest.config.js tech: enzyme container test working Jan 1, 2018
karma.conf.js Webpack 4 (WIP) (#12098) Jun 26, 2018
latest.json release 5.2.0 Jun 27, 2018
package.json Add new sequential color scales Jul 10, 2018
tsconfig.json poc: mobx test Dec 20, 2017
tslint.json Tabs to spaces in tslint (#12529) Jul 8, 2018
yarn.lock fixes typos Jun 29, 2018

README.md

Grafana Circle CI Go Report Card codecov

Website | Twitter | Community & Forum

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

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.10
  • NodeJS LTS

Building the backend

go get github.com/grafana/grafana
cd $GOPATH/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+).

To build the assets, rebuild on file change, and serve them by Grafana's webserver (http://localhost:3000):

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

Build the assets, rebuild on file change with Hot Module Replacement (HMR), and serve them by webpack-dev-server (http://localhost:3333):

yarn start
# OR set a theme
env GRAFANA_THEME=light yarn start

Note: HMR for Angular is not supported. If you edit files in the Angular part of the app, the whole page will reload.

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

Frontend

Execute all frontend tests

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".

Backend

# Run Golang tests using sqlite3 as database (default)
go test ./pkg/... 

# Run Golang tests using mysql as database - convenient to use /docker/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/... 

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.