README.md 5.22 KB
Newer Older
1
[Grafana](https://grafana.com) [![Circle CI](https://circleci.com/gh/grafana/grafana.svg?style=svg)](https://circleci.com/gh/grafana/grafana) [![Go Report Card](https://goreportcard.com/badge/github.com/grafana/grafana)](https://goreportcard.com/report/github.com/grafana/grafana) [![codecov](https://codecov.io/gh/grafana/grafana/branch/master/graph/badge.svg)](https://codecov.io/gh/grafana/grafana)
Torkel Ödegaard's avatar
Torkel Ödegaard committed
2
================
Torkel Ödegaard's avatar
Torkel Ödegaard committed
3
[Website](https://grafana.com) |
tuexss's avatar
tuexss committed
4
[Twitter](https://twitter.com/grafana) |
Torkel Ödegaard's avatar
Torkel Ödegaard committed
5
[Community & Forum](https://community.grafana.com)
Rashid Khan's avatar
Rashid Khan committed
6

tuexss's avatar
tuexss committed
7
Grafana is an open source, feature rich metrics dashboard and graph editor for
Torkel Ödegaard's avatar
Torkel Ödegaard committed
8
Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.
Torkel Ödegaard's avatar
Torkel Ödegaard committed
9

Torkel Ödegaard's avatar
Torkel Ödegaard committed
10
![](http://docs.grafana.org/assets/img/features/dashboard_ex1.png)
Torkel Ödegaard's avatar
Torkel Ödegaard committed
11

Torkel Ödegaard's avatar
Torkel Ödegaard committed
12
## Installation
bergquist's avatar
bergquist committed
13
Head to [docs.grafana.org](http://docs.grafana.org/installation/) and [download](https://grafana.com/get)
14
the latest release.
Torkel Ödegaard's avatar
Torkel Ödegaard committed
15

Torkel Ödegaard's avatar
Torkel Ödegaard committed
16
If you have any problems please read the [troubleshooting guide](http://docs.grafana.org/installation/troubleshooting/).
17

Torkel Ödegaard's avatar
Torkel Ödegaard committed
18
## Documentation & Support
Torkel Ödegaard's avatar
Torkel Ödegaard committed
19
Be sure to read the [getting started guide](http://docs.grafana.org/guides/gettingstarted/) and the other feature guides.
Torkel Ödegaard's avatar
Torkel Ödegaard committed
20

Torkel Ödegaard's avatar
Torkel Ödegaard committed
21
## Run from master
22
If you want to build a package yourself, or contribute - here is a guide for how to do that. You can always find
Torkel Ödegaard's avatar
Torkel Ödegaard committed
23
the latest master builds [here](https://grafana.com/grafana/download)
Torkel Ödegaard's avatar
Torkel Ödegaard committed
24
25
26

### Dependencies

27
- Go (Latest Stable)
28
- Node.js LTS
Torkel Ödegaard's avatar
Torkel Ödegaard committed
29
30

### Building the backend
bergquist's avatar
bergquist committed
31
```bash
bergquist's avatar
bergquist committed
32
go get github.com/grafana/grafana
33
cd $GOPATH/src/github.com/grafana/grafana
bergquist's avatar
bergquist committed
34
go run build.go setup
Torkel Ödegaard's avatar
Torkel Ödegaard committed
35
go run build.go build
Torkel Ödegaard's avatar
Torkel Ödegaard committed
36
37
38
39
```

### Building frontend assets

Torkel Ödegaard's avatar
Torkel Ödegaard committed
40
For this you need Node.js (LTS version).
Torkel Ödegaard's avatar
Torkel Ödegaard committed
41

42
To build the assets, rebuild on file change, and serve them by Grafana's webserver (http://localhost:3000):
bergquist's avatar
bergquist committed
43
```bash
44
npm install -g yarn
45
yarn install --pure-lockfile
Marcus Efraimsson's avatar
Marcus Efraimsson committed
46
yarn watch
Torkel Ödegaard's avatar
Torkel Ödegaard committed
47
48
```

49
50
51
52
53
54
55
56
Build the assets, rebuild on file change with Hot Module Replacement (HMR), and serve them by webpack-dev-server (http://localhost:3333):
```bash
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.

Dan Cech's avatar
Dan Cech committed
57
Run tests
Torkel Ödegaard's avatar
Torkel Ödegaard committed
58
```bash
Marcus Efraimsson's avatar
Marcus Efraimsson committed
59
yarn jest
Torkel Ödegaard's avatar
Torkel Ödegaard committed
60
61
```

Torkel Ödegaard's avatar
Torkel Ödegaard committed
62
### Recompile backend on source change
63

bergquist's avatar
bergquist committed
64
To rebuild on source change.
bergquist's avatar
bergquist committed
65
```bash
Torkel Ödegaard's avatar
Torkel Ödegaard committed
66
67
68
69
go get github.com/Unknwon/bra
bra run
```

70
Open grafana in your browser (default: `http://localhost:3000`) and login with admin user (default: `user/pass = admin/admin`).
Torkel Ödegaard's avatar
Torkel Ödegaard committed
71

72
### Building a Docker image
73

74
There are two different ways to build a Grafana docker image. If your machine is setup for Grafana development and you run linux/amd64 you can build just the image. Otherwise, there is the option to build Grafana completely within Docker.
75
76
77
78

Run the image you have built using: `docker run --rm -p 3000:3000 grafana/grafana:dev`

#### Building on linux/amd64 (fast)
79
80
81
82
83
84

1. Build the frontend `go run build.go build-frontend`
2. Build the docker image `make build-docker-dev`

The resulting image will be tagged as `grafana/grafana:dev`

85
86
87
88
89
90
91
92
#### Building anywhere (slower)

Choose this option to build on platforms other than linux/amd64 and/or not have to setup the Grafana development environment.

1. `make build-docker-full` or `docker build -t grafana/grafana:dev .`

The resulting image will be tagged as `grafana/grafana:dev`

93
Notice: If you are using Docker for MacOS, be sure to set the memory limit to be larger than 2 GiB (at docker -> Preferences -> Advanced), otherwise `grunt build` may fail.
Minamiya_Natsuki's avatar
Minamiya_Natsuki committed
94

Torkel Ödegaard's avatar
Torkel Ödegaard committed
95
96
97
98
99
100
### 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
101
1. custom.ini
Torkel Ödegaard's avatar
Torkel Ödegaard committed
102

103
104
In your custom.ini uncomment (remove the leading `;`) sign. And set `app_mode = development`.

105
106
### Running tests

107
108
109
#### Frontend
Execute all frontend tests
```bash
Marcus Efraimsson's avatar
Marcus Efraimsson committed
110
yarn test
111
```
112

Tobias Skarhed's avatar
Tobias Skarhed committed
113
Writing & watching frontend tests
114

Marcus Efraimsson's avatar
Marcus Efraimsson committed
115
116
- Start watcher: `yarn jest`
- Jest will run all test files that end with the name ".test.ts"
117

118
119
120
#### Backend
```bash
# Run Golang tests using sqlite3 as database (default)
Dan Cech's avatar
Dan Cech committed
121
go test ./pkg/...
122

123
# Run Golang tests using mysql as database - convenient to use /docker/blocks/mysql_tests
Dan Cech's avatar
Dan Cech committed
124
GRAFANA_TEST_DB=mysql go test ./pkg/...
125
126

# Run Golang tests using postgres as database - convenient to use /docker/blocks/postgres_tests
Dan Cech's avatar
Dan Cech committed
127
GRAFANA_TEST_DB=postgres go test ./pkg/...
128
129
```

Morton Fox's avatar
Morton Fox committed
130
## Contribute
Torkel Ödegaard's avatar
Torkel Ödegaard committed
131

132
133
If you have any ideas for improvement or have found a bug, do not hesitate to open an issue.
And if you have time, clone this repo and submit a pull request to help me make Grafana
Torkel Ödegaard's avatar
Torkel Ödegaard committed
134
135
136
the kickass metrics & devops dashboard we all dream about! 

Read the [contributing](https://github.com/grafana/grafana/blob/master/CONTRIBUTING.md) guide then check the [`beginner friendly`](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) label to find issues that are easy and that we would like help with.
Torkel Ödegaard's avatar
Torkel Ödegaard committed
137

Torkel Ödegaard's avatar
Torkel Ödegaard committed
138
139
## Plugin development

140
141
Checkout the [Plugin Development Guide](http://docs.grafana.org/plugins/developing/development/) and checkout the [PLUGIN_DEV.md](https://github.com/grafana/grafana/blob/master/PLUGIN_DEV.md) file for changes in Grafana that relate to
plugin development.
Torkel Ödegaard's avatar
Torkel Ödegaard committed
142

Torkel Ödegaard's avatar
Torkel Ödegaard committed
143
## License
Torkel Ödegaard's avatar
Torkel Ödegaard committed
144

Erik Pettersson's avatar
Erik Pettersson committed
145
Grafana is distributed under [Apache 2.0 License](https://github.com/grafana/grafana/blob/master/LICENSE.md).
Torkel Ödegaard's avatar
Torkel Ödegaard committed
146