/grafana

Gorgeous metric viz, dashboards & editors for Graphite, InfluxDB & OpenTSDB
  1. Go 31.8%
  2. TypeScript 26.2%
  3. HTML 16.2%
  4. JavaScript 15.0%
  5. CSS 8.8%
  6. Shell 1.6%
  7. Other 0.4%
Go TypeScript HTML JavaScript CSS Shell Other
Find file
Latest commit 4a116ad Oct 1, 2016 @torkelo torkelo fix(build): fixed failing unit test
Permalink
Failed to load latest commit information.
.github add options to support cross build Sep 18, 2016
.hooks tech(build): update build docs Sep 15, 2016
conf feat(config): changed name of allow_user_login_pass to disable_login_… Sep 28, 2016
docker tech(docker): update prometheus config Aug 23, 2016
docs Modify basic introductions of docs and make it exact (#6166) Oct 1, 2016
emails feat(emails): move bg color to main table Sep 8, 2016
examples docs(example): remove old properties Aug 22, 2016
packaging Update systemd unit's description to be more understandable Sep 6, 2016
pkg fix(build): fixed failing unit test Oct 1, 2016
public fix(notifications): added form validation and restored Send Test butt… Oct 1, 2016
scripts tech(build): make sure build.go setup works fine Sep 23, 2016
tasks enforce unconditional copy Sep 18, 2016
tests feat(apps): fixed unit tests Jul 8, 2016
vendor Merge branch 'master' into go_routines Sep 28, 2016
.bowerrc Added bowerrc file Jun 13, 2015
.bra.toml turn watch all back on May 21, 2016
.editorconfig fix(.editorconfig): correct spelling of indent_style Sep 5, 2016
.floo Merge branch 'master' into export-dashboard May 18, 2016
.flooignore Merge branch 'master' into export-dashboard May 18, 2016
.gitignore tech(gitignore): ignore vscode folder Sep 5, 2016
.jscs.json feat(import): things are starting to work May 13, 2016
.jsfmtrc SharePanelModal: working on share feature, #864 Sep 30, 2014
.jshintrc feat(templating): lots of progress on template variable context speci… Mar 1, 2016
CHANGELOG.md docs(changelog): add note about closing #4087 and #2172 Sep 26, 2016
Gruntfile.js add option for grunt release Sep 18, 2016
LICENSE.md Updated copyright to 2016 Jan 1, 2016
Makefile tech(build): update makefile Sep 15, 2016
NOTICE.md updated license and added notice, hard to know how to handle attribut… Dec 27, 2013
README.md Make Slack Logo link to Slack (#6165) Oct 1, 2016
appveyor.yml fix(build): another windows build issue Jun 16, 2016
bower.json tech(lib upgrade): fixed issue with angular 1.5.8, so can revert reve… Sep 14, 2016
build.go fix(build): updated build.go setup Sep 22, 2016
circle.yml tech(build): upgrade ci build to 1.7.1 Sep 15, 2016
karma.conf.js fix(templating): fixed issue with mixing repeated row and repeated pa… May 12, 2016
latest.json Update latest.json Aug 2, 2016
package.json feat(alerting): disable visual thresholds while alert is enabled Aug 12, 2016
tsconfig.json feat(dashlist): updated dashlist Apr 11, 2016
tsd.json minor progress Dec 16, 2015
tslint.json feat(tslint): remove two space requirements for comments Mar 18, 2016

README.md

Grafana Circle CI Coverage Status

Website | Twitter | IRC | Slack Slack | Email

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

Features

Graphite Target Editor

  • Graphite target expression parser
  • Feature rich query composer
  • Quickly add and edit functions & parameters
  • Templated queries
  • See it in action

Graphing

  • Fast rendering, even over large timespans
  • Click and drag to zoom
  • Multiple Y-axis, logarithmic scales
  • Bars, Lines, Points
  • Smart Y-axis formatting
  • Series toggles & color selector
  • Legend values, and formatting options
  • Grid thresholds, axis labels
  • Annotations
  • Any panel can be rendered to PNG (server side using phantomjs)

Dashboards

Elasticsearch

  • Feature rich query editor UI

InfluxDB

  • Use InfluxDB as a metric data source, annotation source
  • Query editor with series and column typeahead, easy group by and function selection

OpenTSDB

  • Use as metric data source
  • Query editor with metric name typeahead and tag filtering

Requirements

There are no dependencies except an external time series data store. For dashboards and user accounts Grafana can use an embedded database (sqlite3) or you can use an external SQL data base like MySQL or Postgres.

Installation

Head to 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.7
  • NodeJS v4+

Get Code

go get github.com/grafana/grafana

Since imports of dependencies use the absolute path github.com/grafana/grafana within the $GOPATH, you will need to put your version of the code in $GOPATH/src/github.com/grafana/grafana to be able to develop and build grafana on a cloned repository. To do so, you can clone your forked repository directly to $GOPATH/src/github.com/grafana or you can create a symbolic link from your version of the code to $GOPATH/src/github.com/grafana/grafana. The last options makes it possible to change easily the grafana repository you want to build.

go get github.com/*your_account*/grafana
mkdir $GOPATH/src/github.com/grafana
ln -s  $GOPATH/src/github.com/*your_account*/grafana $GOPATH/src/github.com/grafana/grafana

Building the backend

cd $GOPATH/src/github.com/grafana/grafana
go run build.go setup
go run build.go build

Building frontend assets

To build less to css for the frontend you will need a recent version of of node (v4+), npm (v2.5.0) and grunt (v0.4.5). Run the following:

npm install
npm run build

To build the frontend assets only on changes:

sudo npm install -g grunt-cli # to do only once to install grunt command line interface
grunt watch

Recompile backend on source change

To rebuild on source change.

go get github.com/Unknwon/bra
bra run

Running

./bin/grafana-server

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. dev.ini (if found)
  3. custom.ini

Create a pull request

Before or after you create a pull request, sign the contributor license agreement.

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!

Before creating a pull request be sure that "grunt test" runs without any style or unit test errors, also please sign the CLA

License

Grafana is distributed under Apache 2.0 License. Work in progress Grafana 2.0 (with included Grafana backend)