2017-09-01 00:16:42 -05:00
|
|
|
[Grafana](https://grafana.com) [](https://circleci.com/gh/grafana/grafana) [](https://goreportcard.com/report/github.com/grafana/grafana)
|
2014-07-14 13:53:20 -05:00
|
|
|
================
|
2017-03-13 15:32:28 -05:00
|
|
|
[Website](https://grafana.com) |
|
2015-03-25 06:17:22 -05:00
|
|
|
[Twitter](https://twitter.com/grafana) |
|
2017-03-13 17:05:47 -05:00
|
|
|
[Community & Forum](https://community.grafana.com)
|
2013-01-25 22:10:28 -06:00
|
|
|
|
2015-03-25 06:03:20 -05:00
|
|
|
Grafana is an open source, feature rich metrics dashboard and graph editor for
|
2015-11-12 06:50:57 -06:00
|
|
|
Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.
|
2014-07-14 13:53:20 -05:00
|
|
|
|
2017-03-13 15:32:28 -05:00
|
|
|
|
2015-03-29 06:39:51 -05:00
|
|
|
|
2014-08-12 02:24:58 -05:00
|
|
|
## Installation
|
2017-09-07 08:26:08 -05:00
|
|
|
Head to [docs.grafana.org](http://docs.grafana.org/installation/) and [download](https://grafana.com/get)
|
2014-08-05 05:27:03 -05:00
|
|
|
the latest release.
|
2014-01-19 10:16:57 -06:00
|
|
|
|
2015-03-29 06:30:03 -05:00
|
|
|
If you have any problems please read the [troubleshooting guide](http://docs.grafana.org/installation/troubleshooting/).
|
2014-04-09 05:36:35 -05:00
|
|
|
|
2014-08-12 02:24:58 -05:00
|
|
|
## Documentation & Support
|
2015-03-29 06:30:03 -05:00
|
|
|
Be sure to read the [getting started guide](http://docs.grafana.org/guides/gettingstarted/) and the other feature guides.
|
2014-01-20 03:57:59 -06:00
|
|
|
|
2014-08-12 02:24:58 -05:00
|
|
|
## Run from master
|
2015-09-08 15:16:51 -05:00
|
|
|
If you want to build a package yourself, or contribute. Here is a guide for how to do that. You can always find
|
2017-03-13 15:32:28 -05:00
|
|
|
the latest master builds [here](https://grafana.com/grafana/download)
|
2015-03-29 06:30:03 -05:00
|
|
|
|
|
|
|
|
### Dependencies
|
|
|
|
|
|
2017-04-11 23:38:37 -05:00
|
|
|
- Go 1.8.1
|
|
|
|
|
- NodeJS LTS
|
2015-03-29 06:30:03 -05:00
|
|
|
|
|
|
|
|
### Building the backend
|
2016-02-10 05:08:04 -06:00
|
|
|
```bash
|
2017-09-07 08:26:08 -05:00
|
|
|
go get github.com/grafana/grafana
|
|
|
|
|
cd ~/go/src/github.com/grafana/grafana
|
2016-09-15 06:09:33 -05:00
|
|
|
go run build.go setup
|
2015-12-03 05:03:06 -06:00
|
|
|
go run build.go build
|
2015-03-29 06:30:03 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Building frontend assets
|
|
|
|
|
|
2017-02-03 09:15:37 -06:00
|
|
|
To build less to css for the frontend you will need a recent version of **node (v6+)**,
|
2015-03-29 06:30:03 -05:00
|
|
|
npm (v2.5.0) and grunt (v0.4.5). Run the following:
|
|
|
|
|
|
2016-02-10 05:08:04 -06:00
|
|
|
```bash
|
2017-01-06 00:28:43 -06:00
|
|
|
npm install -g yarn
|
2017-01-12 08:36:44 -06:00
|
|
|
yarn install --pure-lockfile
|
2016-04-25 11:44:26 -05:00
|
|
|
npm run build
|
2015-03-29 06:30:03 -05:00
|
|
|
```
|
|
|
|
|
|
2016-05-02 13:36:06 -05:00
|
|
|
To build the frontend assets only on changes:
|
|
|
|
|
|
|
|
|
|
```bash
|
2017-09-07 08:26:08 -05:00
|
|
|
npm run dev
|
2016-05-02 13:36:06 -05:00
|
|
|
```
|
|
|
|
|
|
2015-03-29 06:30:03 -05:00
|
|
|
### Recompile backend on source change
|
2016-09-15 06:09:33 -05:00
|
|
|
To rebuild on source change.
|
2016-02-10 05:08:04 -06:00
|
|
|
```bash
|
2015-03-29 06:30:03 -05:00
|
|
|
go get github.com/Unknwon/bra
|
|
|
|
|
bra run
|
|
|
|
|
```
|
|
|
|
|
|
2016-10-20 15:08:12 -05:00
|
|
|
Open grafana in your browser (default: `http://localhost:3000`) and login with admin user (default: `user/pass = admin/admin`).
|
2015-03-29 06:30:03 -05:00
|
|
|
|
|
|
|
|
### 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
|
2017-05-21 03:07:21 -05:00
|
|
|
1. custom.ini
|
2015-03-29 06:30:03 -05:00
|
|
|
|
2015-04-29 15:35:03 -05:00
|
|
|
## Contribute
|
2014-08-12 02:23:25 -05:00
|
|
|
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!
|
2014-01-20 03:57:59 -06:00
|
|
|
|
2014-08-12 02:24:58 -05:00
|
|
|
## License
|
2014-03-31 09:22:55 -05:00
|
|
|
Grafana is distributed under Apache 2.0 License.
|
2015-02-05 03:10:39 -06:00
|
|
|
Work in progress Grafana 2.0 (with included Grafana backend)
|
