Go to file
Fabian Reinartz b09b90a940 Correctly close querier on error, revendor tsdb 2017-03-09 15:40:52 +01:00
.github .github: Add issue template 2016-06-06 11:48:14 +02:00
cmd Merge branch 'master' into dev-2.0 2017-03-02 08:16:58 +01:00
config Re-add multiple remote writers 2017-02-20 13:23:12 +01:00
console_libraries Add blackbox console. 2015-11-01 20:06:52 +00:00
consoles Add various persistence related metrics (#2333) 2017-01-11 15:11:19 +00:00
discovery discovery: Instead of looping over conf.Search, use NameList() 2017-02-13 15:48:51 -05:00
documentation Fix kubernetes host:port relabel regex. 2017-02-16 14:46:04 -05:00
notifier Merge branch 'master' into dev-2.0 2017-03-02 08:16:58 +01:00
pkg *: Simplify []byte to string unsafe conversion 2017-03-07 11:41:11 +01:00
promql Correctly close querier on error, revendor tsdb 2017-03-09 15:40:52 +01:00
relabel Only clone the metric in the one place relabelling needs it. (#2292) 2016-12-21 10:00:33 +00:00
retrieval retrieval: fix test 2017-03-08 15:37:12 +01:00
rules retrieval/storage: adapt to new interface 2017-02-02 13:05:46 +01:00
scripts New release process using docker, circleci and a centralized 2016-04-18 22:41:04 +02:00
storage storage/tsdb: don't use partitioned DB. 2017-03-07 11:51:30 +01:00
template storage/vendor: update to latest fabxc/tsdb 2017-02-20 11:11:44 +01:00
util *: pass Prometheus registry into storage 2017-02-28 09:33:14 +01:00
vendor Correctly close querier on error, revendor tsdb 2017-03-09 15:40:52 +01:00
web Merge branch 'master' into dev-2.0 2017-03-02 08:16:58 +01:00
.codeclimate.yml Update .codeclimate.yml 2017-01-23 14:58:53 -05:00
.dockerignore New release process using docker, circleci and a centralized 2016-04-18 22:41:04 +02:00
.gitignore gitignore: clean up 2016-07-04 11:34:33 +02:00
.promu.yml promu: Use default Go version again 2016-10-11 11:42:05 +02:00
.travis.yml build: Use Go1.7.4 in Travis 2017-02-10 13:05:32 +01:00
CHANGELOG.md Cut v1.5.2 2017-02-10 13:57:11 +01:00
CONTRIBUTING.md Replace AUTHORS.md by an updated MAINTAINERS.md 2017-02-20 11:45:22 +01:00
Dockerfile Docker: Move console dirs to /usr/share/prometheus 2016-07-29 14:00:47 +01:00
LICENSE
MAINTAINERS.md Replace AUTHORS.md by an updated MAINTAINERS.md 2017-02-20 11:45:22 +01:00
Makefile Add promu installation logging to Makefile 2016-09-16 00:59:56 +02:00
NOTICE Replace handlebars with the simpler and saner mustache library. 2016-11-17 02:33:12 +00:00
README.md Merge pull request #2179 from prometheus/update-mailing-list-ref 2017-01-26 17:08:16 +01:00
VERSION Cut v1.5.2 2017-02-10 13:57:11 +01:00
circle.yml circle: update golang-builder image version 2016-11-25 14:29:07 +01:00
code-of-conduct.md Add CNCF code of conduct as the Prometheus code of conduct 2016-10-19 21:39:19 +02:00

README.md

Prometheus Build Status

CircleCI Docker Repository on Quay Docker Pulls Go Report Card Code Climate Issue Count

Visit prometheus.io for the full documentation, examples and guides.

Prometheus, a Cloud Native Computing Foundation project, is a systems and service monitoring system. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts if some condition is observed to be true.

Prometheus' main distinguishing features as compared to other monitoring systems are:

  • a multi-dimensional data model (timeseries defined by metric name and set of key/value dimensions)
  • a flexible query language to leverage this dimensionality
  • no dependency on distributed storage; single server nodes are autonomous
  • timeseries collection happens via a pull model over HTTP
  • pushing timeseries is supported via an intermediary gateway
  • targets are discovered via service discovery or static configuration
  • multiple modes of graphing and dashboarding support
  • support for hierarchical and horizontal federation

Architecture overview

Install

There are various ways of installing Prometheus.

Precompiled binaries

Precompiled binaries for released versions are available in the download section on prometheus.io. Using the latest production release binary is the recommended way of installing Prometheus. See the Installing chapter in the documentation for all the details.

Debian packages are available.

Docker images

Docker images are available on Quay.io.

Building from source

To build Prometheus from the source code yourself you need to have a working Go environment with version 1.5 or greater installed.

You can directly use the go tool to download and install the prometheus and promtool binaries into your GOPATH. We use Go 1.5's experimental vendoring feature, so you will also need to set the GO15VENDOREXPERIMENT=1 environment variable in this case:

$ GO15VENDOREXPERIMENT=1 go get github.com/prometheus/prometheus/cmd/...
$ prometheus -config.file=your_config.yml

You can also clone the repository yourself and build using make:

$ mkdir -p $GOPATH/src/github.com/prometheus
$ cd $GOPATH/src/github.com/prometheus
$ git clone https://github.com/prometheus/prometheus.git
$ cd prometheus
$ make build
$ ./prometheus -config.file=your_config.yml

The Makefile provides several targets:

  • build: build the prometheus and promtool binaries
  • test: run the tests
  • format: format the source code
  • vet: check the source code for common errors
  • assets: rebuild the static assets
  • docker: build a docker container for the current HEAD

More information

  • The source code is periodically indexed: Prometheus Core.
  • You will find a Travis CI configuration in .travis.yml.
  • See the Community page for how to reach the Prometheus developers and users on various communication channels.

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.