Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/torkelo/grafana

Grafana - A Graphite & InfluxDB Dashboard and Graph Editor
https://github.com/torkelo/grafana

Last synced: about 2 months ago
JSON representation

Grafana - A Graphite & InfluxDB Dashboard and Graph Editor

Awesome Lists containing this project

README 

        
[Grafana](http://grafana.org) [![Build Status](https://api.travis-ci.org/grafana/grafana.png)](https://travis-ci.org/grafana/grafana)

=================

A beautiful, easy to use and feature rich Graphite dashboard replacement and graph editor. Visit [grafana.org](http://grafana.org) for screenshots, videos and feature descriptions.



![](http://grafana.org/assets/img/edit_dashboards.png)



## Features

### Graphite Target Editor

- Graphite target expression parser

- Quickly add / edit / remove function ([video demo](http://youtu.be/I90WHRwE1ZM))

- Function parameters can be easily changed

- Quickly navigate graphite metric structure

- Templating

- Integrated links to function documentation

- Rearrange function order

- Native Graphite PNG render support



### Graphing

- Fast rendering, even over large timespans.

- Click and drag to zoom.

- Multiple Y-axis.

- Bars, Lines, Points.

- Smart Y-axis formating

- Series toggles & color selector

- Axis labels

- Grid thresholds, axis labels

- [Annotations] (https://github.com/grafana/grafana/wiki/Annotations)



### Dashboards

- Create and edit dashboards

- Drag and drop graphs to rearrange

- Set column spans and row heights

- Save & [search dashboards](https://github.com/grafana/grafana/wiki/Search-features)

- Import & export dashboard (json file)

- Import dashboard from Graphite

- Templating

- [Scripted dashboards](https://github.com/grafana/grafana/wiki/Scripted-dashboards) (generate from js script and url parameters)

- Flexible [time range controls](https://github.com/grafana/grafana/wiki/Time-range-controls)

- [Dashboard playlists](https://github.com/grafana/grafana/wiki/Dashboard-playlist)



### InfluxDB

- [Use InfluxDB](https://github.com/grafana/grafana/wiki/InfluxDB) as metric datasource



# Requirements

Grafana is very easy to install. It is a client side web app with no backend. Any webserver will do. Optionally you will need ElasticSearch if you want to be able to save and load dashboards quickly instead of json files or local storage.



# Installation

- Download and extract the [latest release](https://github.com/grafana/grafana/releases).

- Rename `config.sample.js` to `config.js`, then change `graphiteUrl` and `elasticsearch` to point to the correct urls. The urls entered here must be reachable by your browser.

- Point your browser to the installation.



To run from master:

- Clone this repository

- Start a web server in src folder

- Or create a optimized & minified build:

 - npm install (requires nodejs)

 - grunt build (requires grunt-cli)



If you use ansible for provisioning and deployment [ansible-grafana](https://github.com/bobrik/ansible-grafana) should get you started.



When you have Grafana up an running, read the [Getting started](https://github.com/grafana/grafana/wiki/Getting-started) guide for

an introduction on how to use Grafana and/or watch [this video](https://www.youtube.com/watch?v=OUvJamHeMpw) for a guide in creating a new dashboard and for creating

templated dashboards.



# Graphite server config

If you haven't used an alternative dashboard for graphite before you need to enable cross-domain origin request. For Apache 2.x:

```

Header set Access-Control-Allow-Origin "*"

Header set Access-Control-Allow-Methods "GET, OPTIONS"

Header set Access-Control-Allow-Headers "origin, authorization, accept"

```

Note that using "\*" leaves your graphite instance quite open so you might want to consider using "http://my.graphite-dom.ain" in place of "\*"



If your Graphite web is proteced by basic authentication, you have to enable the HTTP verb OPTIONS, origin

(no wildcards are allowed in this case) and add Access-Control-Allow-Credentials. This looks like the following for Apache:

```

Header set Access-Control-Allow-Origin "http://mygrafana.com:5656"

Header set Access-Control-Allow-Credentials true



    AuthName "graphs restricted"

    AuthType Basic

    AuthUserFile /etc/apache2/htpasswd

    

      require valid-user

    



```



# Roadmap

- Improve and refine the target parser and editing

- Improve graphite import feature

- Refine and simplify common tasks

- More panel types (not just graphs)

- Use elasticsearch to search for metrics

- Improve template support

- Annotate graph by querying ElasticSearch for events (or other event sources)



# 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!



Clone repository:

- npm install

- grunt server (starts development web server in src folder)

- grunt (runs jshint and less -> css compilation)



# Notice

This software is based on the great log dashboard [kibana](https://github.com/elasticsearch/kibana).



# License

Grafana is distributed under Apache 2.0 License.