mirror of
https://github.com/grafana/grafana.git
synced 2024-11-25 18:30:41 -06:00
Updated readme
This commit is contained in:
Torkel Ödegaard
parent
6d565cb355
commit
902f5d895a
170
README.md
170
README.md
@ -1,4 +1,4 @@
|
||||
[Grafana](http://grafana.org) [](https://travis-ci.org/grafana/grafana) [](https://coveralls.io/r/grafana/grafana) [](https://gitter.im/grafana/grafana?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[Grafana](http://grafana.org) [](https://circleci.com/gh/grafana/grafana) [](https://coveralls.io/r/grafana/grafana) [](https://gitter.im/grafana/grafana?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
================
|
||||
[Website](http://grafana.org) |
|
||||
[Twitter](https://twitter.com/grafana) |
|
||||
@ -8,80 +8,22 @@
|
||||
Grafana is an open source, feature rich metrics dashboard and graph editor for
|
||||
Graphite, InfluxDB & OpenTSDB.
|
||||
|
||||
## Grafana 2.0
|
||||
The develop branch has now been merged with master. For 1.9 users this is a big change as Grafana is no longer
|
||||
a standalone frontend only web application. Grafana 2.0 comes with a backend.
|
||||
- [Install instructions](http://docs.grafana.org/v2.0/installation/)
|
||||
- [Migrating from 1.x to 2.x](http://docs.grafana.org/v2.0/installation/migrating_to2/)
|
||||
- [What's New in Grafana 2.0](http://docs.grafana.org/v2.0/guides/whats-new-in-v2/)
|
||||
|
||||
|
||||
|
||||
# Grafana 2.0 Alpha branch [](https://circleci.com/gh/grafana/grafana)
|
||||
|
||||
Grafana 2.0 comes with a backend written in Go. It is not ready for production use yet as there is still a lot of small
|
||||
issues to fix and polish missing. But feedback on what is done and bug reports would be greatly appreciated.
|
||||
|
||||
## Try it out with docker
|
||||
```
|
||||
docker run -i -p 3000:3000 grafana/grafana:develop
|
||||
```
|
||||
The default admin user is admin/admin.
|
||||
|
||||
## building and running
|
||||
|
||||
```
|
||||
go get github.com/grafana/grafana
|
||||
```
|
||||
The above will give an error saying there is no go code. That is because the new backend parts are in the develop branch.
|
||||
|
||||
Building
|
||||
```
|
||||
cd $GOPATH/src/github.com/grafana/grafana
|
||||
git checkout -t origin/develop
|
||||
go run build.go setup (only needed once to install godep)
|
||||
godep restore (will pull down all golang lib dependecies in your current GOPATH)
|
||||
go build .
|
||||
```
|
||||
|
||||
To build less to css for the frontend you will need a recent version of of node (v0.12.0),
|
||||
npm (v2.5.0) and grunt (v0.4.5). Run the following:
|
||||
|
||||
```
|
||||
npm install
|
||||
npm install -g grunt-cli
|
||||
grunt
|
||||
```
|
||||
|
||||
To rebuild on source change (requires that you executed godep restore)
|
||||
```
|
||||
go get github.com/Unknwon/bra
|
||||
bra run
|
||||
```
|
||||
|
||||
Running
|
||||
```
|
||||
./bin/grafana web
|
||||
```
|
||||
Open grafana in your browser (default http://localhost:3000) and login with admin user (default user/pass = admin/admin).
|
||||
|
||||
### Config
|
||||
Create a grafana.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. grafana.dev.ini (if found)
|
||||
3. grafana.custom.ini
|
||||
|
||||
### Docs
|
||||
There is no docs for the configuration and new UI views, or the account / user model yet. But a quick note
|
||||
is that Grafana 2.0 has a multi tenant account & user model where Dashboards, data sources, api keys, etc are
|
||||
tied to an account and not to a specific user. Users are coupled to accounts via an account user role (Admin, Editor, Viewer).
|
||||
The default configuration is set to a single account mode to make this user & account model easier to handle in a single account setup.
|
||||
User sign ups are automatically added to a main account with the Editor role (this can be overriden in the config file). The default
|
||||
grafana admin user that is created on first startup also creates the main account.
|
||||
|
||||
|
||||
## Features
|
||||
### Graphite Target Editor
|
||||
- Graphite target expression parser
|
||||
- Feature rich query composer
|
||||
- Quickly add and edit functions & parameters
|
||||
- Templated queries
|
||||
- [See it in action](http://grafana.org/docs/features/graphite)
|
||||
- [See it in action](http://docs.grafana.org/datasources/graphite/)
|
||||
|
||||
### Graphing
|
||||
- Fast rendering, even over large timespans
|
||||
@ -92,22 +34,20 @@ grafana admin user that is created on first startup also creates the main accoun
|
||||
- Series toggles & color selector
|
||||
- Legend values, and formatting options
|
||||
- Grid thresholds, axis labels
|
||||
- [Annotations](http://grafana.org/docs/features/annotations)
|
||||
- [Annotations](http://docs.grafana.org/reference/annotations/)
|
||||
- Any panel can be rendered to PNG (server side using phantomjs)
|
||||
|
||||
### Dashboards
|
||||
- Create, edit, save & search dashboards
|
||||
- Change column spans and row heights
|
||||
- Drag and drop panels to rearrange
|
||||
- Use InfluxDB or Elasticsearch as dashboard storage
|
||||
- Import & export dashboard (json file)
|
||||
- Import dashboard from Graphite
|
||||
- Templating
|
||||
- [Scripted dashboards](http://grafana.org/docs/features/scripted_dashboards)
|
||||
- [Dashboard playlists](http://grafana.org/docs/features/playlist)
|
||||
- [Time range controls](http://grafana.org/docs/features/time_range)
|
||||
- [Templating](http://docs.grafana.org/reference/templating/)
|
||||
- [Scripted dashboards](http://docs.grafana.org/reference/scripting/)
|
||||
- [Dashboard playlists](http://docs.grafana.org/reference/playlist/)
|
||||
- [Time range controls](http://docs.grafana.org/reference/timerange/)
|
||||
|
||||
### InfluxDB
|
||||
- Use InfluxDB as a metric data source, annotation source, and for dashboard storage
|
||||
- Use InfluxDB as a metric data source, annotation source
|
||||
- Query editor with series and column typeahead, easy group by and function selection
|
||||
|
||||
### OpenTSDB
|
||||
@ -115,31 +55,77 @@ grafana admin user that is created on first startup also creates the main accoun
|
||||
- Query editor with metric name typeahead and tag filtering
|
||||
|
||||
## Requirements
|
||||
There are no dependencies, Grafana is a client side application that runs in your browser. It only needs a time series store where it can fetch metrics. If you use InfluxDB Grafana can use it to store dashboards. If you use Graphite or OpenTSDB you can use Elasticsearch to store dashboards or just use json files stored on disk.
|
||||
There are no dependencies except an external time series data store. For dashboard 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](http://grafana.org) and [download](http://grafana.org/download/)
|
||||
Head to [grafana.org](http://docs.grafana.org/installation/) and [download](http://grafana.org/download/)
|
||||
the latest release.
|
||||
|
||||
Then follow the [quick setup & config guide](http://grafana.org/docs/). If you have any problems please
|
||||
read the [troubleshooting guide](http://grafana.org/docs/troubleshooting).
|
||||
If you have any problems please read the [troubleshooting guide](http://docs.grafana.org/installation/troubleshooting/).
|
||||
|
||||
## Documentation & Support
|
||||
Be sure to read the [getting started guide](http://grafana.org/docs/features/intro) and the other
|
||||
feature guides.
|
||||
Be sure to read the [getting started guide](http://docs.grafana.org/guides/gettingstarted/) and the other feature guides.
|
||||
|
||||
## Run from master
|
||||
Grafana uses Node.js and Grunt for asset management (css & javascript), unit test runner and javascript syntax verification.
|
||||
- clone repository
|
||||
- install nodejs
|
||||
- npm install (in project root)
|
||||
- npm install -g grunt-cli
|
||||
- grunt (grunt default task that will generate css files)
|
||||
- grunt build (creates optimized & minified release)
|
||||
- grunt release (same as grunt build but will also create tar & zip package)
|
||||
- grunt test (executes jshint and unit tests)
|
||||
If you want to build a package your self, or contribute. Here is a guide for how to do that. You can always find
|
||||
the latest master builds [here](http://grafana.org/download/builds)
|
||||
|
||||
## Contribute
|
||||
### Dependencies
|
||||
|
||||
- Go 1.4
|
||||
- NodeJS
|
||||
|
||||
### Get Code
|
||||
|
||||
```
|
||||
go get github.com/grafana/grafana
|
||||
```
|
||||
|
||||
### Building the backend
|
||||
```
|
||||
cd $GOPATH/src/github.com/grafana/grafana
|
||||
go run build.go setup (only needed once to install godep)
|
||||
godep restore (will pull down all golang lib dependecies in your current GOPATH)
|
||||
go build .
|
||||
```
|
||||
|
||||
### Building frontend assets
|
||||
|
||||
To build less to css for the frontend you will need a recent version of of node (v0.12.0),
|
||||
npm (v2.5.0) and grunt (v0.4.5). Run the following:
|
||||
|
||||
```
|
||||
npm install
|
||||
npm install -g grunt-cli
|
||||
grunt
|
||||
```
|
||||
|
||||
### Recompile backend on source change
|
||||
To rebuild on source change (requires that you executed godep restore)
|
||||
```
|
||||
go get github.com/Unknwon/bra
|
||||
bra run
|
||||
```
|
||||
|
||||
### Running
|
||||
```
|
||||
./grafana web
|
||||
```
|
||||
|
||||
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 requests
|
||||
Before or after your create a pull requests, sign the [contributor license aggrement](/docs/contributing/cla.html).## 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!
|
||||
|
||||
@ -14,19 +14,15 @@ dev environment.
|
||||
- Go 1.4
|
||||
- NodeJS
|
||||
|
||||
|
||||
## Get Code
|
||||
|
||||
```
|
||||
go get github.com/grafana/grafana
|
||||
```
|
||||
|
||||
The above will give an error saying there is no go code. That is because the new backend parts are in the develop branch.
|
||||
|
||||
## Building the backend
|
||||
```
|
||||
cd $GOPATH/src/github.com/grafana/grafana
|
||||
git checkout -t origin/develop
|
||||
go run build.go setup (only needed once to install godep)
|
||||
godep restore (will pull down all golang lib dependecies in your current GOPATH)
|
||||
go build .
|
||||
@ -52,7 +48,7 @@ bra run
|
||||
|
||||
## Running
|
||||
```
|
||||
./bin/grafana web
|
||||
./grafana web
|
||||
```
|
||||
|
||||
Open grafana in your browser (default http://localhost:3000) and login with admin user (default user/pass = admin/admin).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user