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.
Go to file
Sofia Papagiannaki 7b70e7db2d
AuthProxy: Optimistic lock pattern for remote cache Set (#17485)
* Implementation of optimistic lock pattern

Try to insert the remote cache key and handle integrity error

* Remove transaction

Integrity error inside a transaction results in deadlock

* Remove check for existing remote cache key

Is no longer needed since integrity constrain violations are handled

* Add check for integrity constrain violation

Do not update the row if the insert statement fails
for other than an integrity constrain violation

* Handle failing inserts because of deadlocks

If the insert statement fails because of a deadlock
try to update the row

* Add utility function for returning SQL error code

Useful for debugging

* Add logging for failing expired cache key deletion

Do not shallow it completely

* Revert "Add utility function for returning SQL error code"

This reverts commit 8e0b82c79633e7d8bc350823cbbab2ac7a58c0a5.

* Better log for failing deletion of expired cache key

* Add some comments

* Remove check for existing cache key

Attempt to insert the key without checking if it's already there
and handle the error situations

* Do not propagate deadlocks created during update

Most probably somebody else is trying to insert/update
the key at the same time so it is safe enough to ignore it
2019-06-13 15:36:09 +02:00
.circleci Build: Upgrades to golang 1.12.6 (#17542) 2019-06-13 11:08:48 +02:00
.github Fix typo in PULL_REQUEST_TEMPLATE.md 2019-04-18 10:58:11 +02:00
conf middleware: add security related HTTP(S) response headers (#17522) 2019-06-12 13:15:50 +02:00
devenv Devenv: Add telegraf with log parsing to influxdb docker block (#17546) 2019-06-12 15:30:33 +02:00
docs Docs feedback: installation/debian.md (#17563) 2019-06-13 09:52:44 +02:00
emails Fix: Alert email variable name typo fixed (#16232) 2019-03-27 09:42:20 +01:00
packages Chore: Hugo upgrade (#17494) 2019-06-12 08:01:44 +02:00
packaging Docker: Prevent a permission denied error when writing files to the default provisioning directory (#16831) 2019-05-10 09:03:17 +02:00
pkg AuthProxy: Optimistic lock pattern for remote cache Set (#17485) 2019-06-13 15:36:09 +02:00
public Explore: Includes context parameter when invoking getExploreState() from Prometheus datasource (#17569) 2019-06-13 14:14:09 +01:00
scripts Build: Upgrades to golang 1.12.6 (#17542) 2019-06-13 11:08:48 +02:00
style_guides add some mock/stub guidelines to testing guideline (#16466) 2019-04-09 14:34:34 +02:00
tools/phantomjs Update render.js 2018-09-22 00:54:56 +03:00
vendor Feature: Parse user agent string in user auth token api response (#16… (#17504) 2019-06-11 14:12:52 +02:00
.babelrc WIP babel 7 2018-10-29 12:20:10 +01:00
.bra.toml build: internal metrics for packaging. 2018-11-15 14:42:09 +01:00
.browserslistrc Fix: Autoprefixer is now working (#16351) 2019-04-02 18:15:30 +02:00
.dockerignore remove duplicated /tmp entry in .dockerignore 2018-08-09 09:10:53 +02:00
.editorconfig Chore: Implement revive (#16200) 2019-03-27 17:53:49 +01:00
.gitignore Chore: explore possibilities of using makefile (#17039) 2019-05-16 00:29:26 +03:00
.prettierignore Updated prettierignore 2019-03-08 13:56:21 +01:00
build.go replace dep with go modules (#16017) 2019-04-16 12:00:55 +02:00
CHANGELOG.md Update changelog for 6.2.2 (#17452) 2019-06-05 15:05:44 +02:00
CODE_OF_CONDUCT.md Spelling/grammar fixes in top level markdown files 2019-01-28 15:58:32 +00:00
CONTRIBUTING.md Docs: Add guidelines for PR/commit messages (#17190) 2019-05-21 13:58:14 +02:00
Dockerfile Feature: provide multildap server configuration (#16914) 2019-05-13 11:51:16 +03:00
go.mod Feature: Parse user agent string in user auth token api response (#16… (#17504) 2019-06-11 14:12:52 +02:00
go.sum Feature: Parse user agent string in user auth token api response (#16… (#17504) 2019-06-11 14:12:52 +02:00
Gruntfile.js build: correctly adds enterprise to the filename. (#13831) 2018-10-25 16:55:27 +02:00
jest.config.e2e.js Tests: Adds end-to-end tests skeleton and basic smoke test scenario (#16901) 2019-05-08 16:50:21 +02:00
jest.config.js Build: Use isolated modules for ts-jest (#16786) 2019-04-26 19:14:48 +02:00
latest.json Update latest (#17456) 2019-06-05 17:35:04 +02:00
LICENSE Small license correction 2019-03-21 16:36:24 +01:00
Makefile Build: make bra a local dependency (#17414) 2019-06-07 16:42:08 +03:00
NOTICE.md Update NOTICE.md 2018-08-09 10:51:04 +02:00
package.json CLI: Search perf test data (#17422) 2019-06-06 10:05:08 +02:00
PLUGIN_DEV.md Update PLUGIN_DEV.md 2019-03-20 12:24:54 -07:00
README.md Build: make bra a local dependency (#17414) 2019-06-07 16:42:08 +03:00
ROADMAP.md Docs: Updated roadmap issue to link to the pinned roadmap issues 2019-04-09 14:22:47 +02:00
tsconfig.json Chore: Bump ts-node to 8.1.0 (#17093) 2019-05-15 14:40:53 +02:00
tslint.json Chore: Replaces moment with Grafanas DateTime (#16919) 2019-05-08 13:51:44 +02:00
UPGRADING_DEPENDENCIES.md build: removes gopkg files from dev docker file (#16817) 2019-04-30 12:01:43 +02:00
yarn.lock Chore: Bump axios to 0.19.0 (#17403) 2019-06-03 11:22:54 +02:00

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 for documentation or download to get the latest release.

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 (Latest Stable)
  • Node.js LTS
    • yarn [npm install -g yarn]

Get the project

The project located in the go-path will be your working directory.

go get github.com/grafana/grafana
cd $GOPATH/src/github.com/grafana/grafana

Run and rebuild on source change

Backend

To run the backend and rebuild on source change:

make run

Frontend

Rebuild on file change, and serve them by Grafana's webserver (http://localhost:3000):

yarn start

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

yarn start:hot
# OR set a theme
env GRAFANA_THEME=light yarn start:hot

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 and rebuild on source change:

yarn jest

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

Building

The backend

go run build.go setup
go run build.go build

Frontend assets

For this you need Node.js (LTS version).

yarn install --pure-lockfile

Building a Docker image

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.

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

Building on linux/amd64 (fast)

  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

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

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.

Development

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 test

Writing & watching frontend tests

  • Start watcher: yarn jest
  • Jest will run all test files that end with the name ".test.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/...

End-to-end

Execute all end-to-end tests

yarn e2e-tests

Execute all end-to-end tests using using a specific url

ENV BASE_URL=http://localhost:3333 yarn e2e-tests

Debugging all end-to-end tests (BROWSER=1 will start the browser and SLOWMO=1 will delay each puppeteer operation by 100ms)

ENV BROWSER=1 SLOWMO=1 yarn e2e-tests

Datasource and dashboard provisioning

Here you can find helpful scripts and docker-compose setup that will populate your dev environment for quicker testing end experimenting.

Contribute

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 the kickass metrics & devops dashboard we all dream about!

Read the contributing guide then check the beginner friendly label to find issues that are easy and that we would like help with.

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.