The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Torkel Ödegaard b0f3ca16d9
Update CHANGELOG.md
7 years ago
.circleci build: increase frontend tests timeout without no output 7 years ago
.github github: test new issue tempalte 7 years ago
conf Add auto_assign_org_id to defaults.ini 7 years ago
devenv devenv: update sql dashboards 7 years ago
docker move run script, update README 7 years ago
docs Merge pull request #12838 from grafana/12476-show-teams-on-profile 7 years ago
emails update email default year and name 7 years ago
examples update broken links (#6961) 9 years ago
packaging Removes link to deprecated docker image build 7 years ago
pkg fix: Alerting rendering timeout was 30 seconds, same as alert rule eval timeout, this should be much lower so the rendering timeout does not timeout the rule context, fixes #12151 (#12903) 7 years ago
public Merge pull request #12838 from grafana/12476-show-teams-on-profile 7 years ago
scripts move run script, update README 7 years ago
tasks/options Create annotations (#8197) 8 years ago
tests folders: basic integration tests for folders 7 years ago
tools/phantomjs Backend image rendering as plugin (#11966) 7 years ago
vendor dep ensure 7 years ago
.bra.toml dev: only build server with bra run 7 years ago
.dockerignore remove duplicated /tmp entry in .dockerignore 7 years ago
.editorconfig support for loading function definitions from graphite 7 years ago
.gitignore build: makes it easier to build a local docker container. 7 years ago
.jscs.json feat(import): things are starting to work 9 years ago
.jshintrc API Integration Tests via jest (#10899) 7 years ago
CHANGELOG.md Update CHANGELOG.md 7 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#8960) 8 years ago
Dockerfile build: fixes png rendering in the docker based docker-image build. 7 years ago
Gopkg.lock dep ensure 7 years ago
Gopkg.toml update aws-sdk-go 7 years ago
Gruntfile.js build: crossplatform build with packages. 7 years ago
LICENSE.md Update LICENSE.md 8 years ago
Makefile produce an image compatible with grafana-docker 7 years ago
NOTICE.md Update NOTICE.md 7 years ago
PLUGIN_DEV.md Webpack Grafana plugin template project to links (#11457) 7 years ago
README.md move run script, update README 7 years ago
ROADMAP.md Update ROADMAP.md 7 years ago
appveyor.yml build: always build for all platforms. 7 years ago
build.go added: replaces added to grafana 7 years ago
codecov.yml disable codecov comments 7 years ago
jest.config.js tech: enzyme container test working 7 years ago
karma.conf.js Webpack 4 (WIP) (#12098) 7 years ago
latest.json release 5.2.0 7 years ago
package.json Explore: Metrics chooser for prometheus 7 years ago
tsconfig.json Add tslib to TS compiler 7 years ago
tslint.json Tabs to spaces in tslint (#12529) 7 years ago
yarn.lock Explore: Metrics chooser for prometheus 7 years ago

README.md

Grafana Circle CI Go Report Card codecov

Website | Twitter | Community & Forum

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

Installation

Head to docs.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.10
  • NodeJS LTS

Building the backend

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

Building frontend assets

For this you need nodejs (v.6+).

To build the assets, rebuild on file change, and serve them by Grafana's webserver (http://localhost:3000):

npm install -g yarn
yarn install --pure-lockfile
yarn run watch

Build the assets, rebuild on file change with Hot Module Replacement (HMR), and serve them by webpack-dev-server (http://localhost:3333):

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.

Run tests

yarn run jest

Run karma tests

yarn run karma

Recompile backend on source change

To rebuild on source change.

go get github.com/Unknwon/bra
bra run

Open grafana in your browser (default: http://localhost:3000) and login with admin user (default: user/pass = admin/admin).

Building a docker image (on linux/amd64)

This builds a docker image from your local sources:

  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

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. custom.ini

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

Running tests

Frontend

Execute all frontend tests

yarn run test

Writing & watching frontend tests (we have two test runners)

  • jest for all new tests that do not require browser context (React+more)
    • Start watcher: yarn run jest
    • Jest will run all test files that end with the name ".jest.ts"
  • karma + mocha is used for testing angularjs components. We do want to migrate these test to jest over time (if possible).
    • Start watcher: yarn run karma
    • Karma+Mocha runs all files that end with the name "_specs.ts".

Backend

# Run Golang tests using sqlite3 as database (default)
go test ./pkg/...

# Run Golang tests using mysql as database - convenient to use /docker/blocks/mysql_tests
GRAFANA_TEST_DB=mysql go test ./pkg/...

# Run Golang tests using postgres as database - convenient to use /docker/blocks/postgres_tests
GRAFANA_TEST_DB=postgres go test ./pkg/...

Building custom docker image

You can build a custom image using Docker, which doesn't require installing any dependencies besides docker itself.

git clone https://github.com/grafana/grafana
cd grafana
docker build -t grafana:dev .
docker run -d --name=grafana -p 3000:3000 grafana:dev

Open grafana in your browser (default: http://localhost:3000) and login with admin user (default: user/pass = admin/admin).

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!

Plugin development

Checkout the Plugin Development Guide and checkout the PLUGIN_DEV.md file for changes in Grafana that relate to plugin development.

License

Grafana is distributed under Apache 2.0 License.