The Prometheus monitoring system and time series database.
 
 
 
 
 
 
Go to file
Conor Broderick 9eb1a5d6bf Handle invalid query in graph UI (#2652) 2017-04-24 10:50:57 +01:00
.github Update Issue Template (#2541) 2017-03-29 15:39:38 +01:00
cmd Initial commit of 'promtool check-metrics', promlint package (#2605) 2017-04-13 23:53:41 +02:00
config Make remote read/write use config.HTTPClientConfig 2017-03-20 13:37:50 +01:00
console_libraries Revert use of buildVersion in console templates. (#2579) 2017-04-05 15:19:17 +01:00
consoles Add various persistence related metrics (#2333) 2017-01-11 15:11:19 +00:00
discovery Fix Map Race by Moving Locking closer to the Write (#2476) 2017-04-07 08:55:01 +02:00
documentation Correct example name to adapter. (#2590) 2017-04-10 17:24:53 +01:00
notifier Merge pull request #2465 from Gouthamve/alert-metrics-2429 2017-03-31 21:45:05 +02:00
promql Force buckets in a histogram to be monotonic for quantile estimation (#2610) 2017-04-14 16:21:49 +02:00
relabel Stricter Relabel Config Checking for Labeldrop/keep (#2510) 2017-03-18 22:32:08 +01:00
retrieval retrieval: make scrape timeout header consistent with others 2017-04-05 14:56:22 -04:00
rules Register forgotten prometheus_evaluator_iterations_total metric 2017-04-02 20:32:56 -03:00
scripts New release process using docker, circleci and a centralized 2016-04-18 22:41:04 +02:00
storage storage: Don't panic if storage has no FPs even after initial wait 2017-04-18 15:59:12 +02:00
template storage: Contextify storage interfaces. 2016-09-19 16:29:07 +02:00
util Add promlint check for histogram/summary reserved names (#2626) 2017-04-15 22:38:01 +01:00
vendor vendoring: Update client_golang/prometheus 2017-04-11 12:58:24 +02:00
web Handle invalid query in graph UI (#2652) 2017-04-24 10:50:57 +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 Use latest released Go 1.8.x 2017-04-04 13:52:18 +03:00
CHANGELOG.md Cut v1.6.1 (#2640) 2017-04-19 14:23:56 +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 Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md Replace AUTHORS.md by an updated MAINTAINERS.md 2017-02-20 11:45:22 +01:00
Makefile Test Longer Tests in Travis (#2570) 2017-04-07 13:46:06 +02:00
NOTICE Replace handlebars with the simpler and saner mustache library. 2016-11-17 02:33:12 +00:00
README.md Test Longer Tests in Travis (#2570) 2017-04-07 13:46:06 +02:00
VERSION Cut v1.6.1 (#2640) 2017-04-19 14:23:56 +01:00
circle.yml Create sha256 checksums file during release 2017-04-15 12:26:51 -03: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.

You can launch a Prometheus container for trying it out with

$ docker run --name prometheus -d -p 127.0.0.1:9090:9090 quay.io/prometheus/prometheus

Prometheus will now be reachable at http://localhost:9090/.

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
  • test-short: run the short 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.