The Prometheus monitoring system and time series database.
 
 
 
 
 
 
Go to file
Fabian Reinartz c70379e1c7 Merge branch 'dev-2.0' of github.com:prometheus/prometheus into dev-2.0 2017-09-04 13:10:50 +02:00
.github Update Issue Template (#2541) 2017-03-29 15:39:38 +01:00
cmd Merge branch 'dev-2.0' of github.com:prometheus/prometheus into dev-2.0 2017-09-04 13:10:50 +02:00
config Merge branch 'master' into mergemaster 2017-08-10 17:04:25 +02:00
console_libraries Cut down console template examples to just node and prometheus (#3099) 2017-08-21 16:35:20 +01:00
consoles Update Prometheus console template example for 2.0 (#3100) 2017-08-26 21:46:12 +01:00
discovery Merge branch 'master' into mergemaster 2017-08-10 17:04:25 +02:00
documentation Merge branch 'master' into mergemaster 2017-08-10 17:04:25 +02:00
notifier Merge branch 'master' into dev-2.0 2017-06-06 09:36:51 +02:00
pkg Handle common escape characters properly. (#2995) 2017-07-27 15:15:41 +02:00
prompb Rename proto package from remote -> prometheus. 2017-08-01 11:12:34 +01:00
promql Merge branch 'master' into mergemaster 2017-08-10 17:04:25 +02:00
relabel Stricter Relabel Config Checking for Labeldrop/keep (#2510) 2017-03-18 22:32:08 +01:00
retrieval util: Add idle timeout for scrape connections 2017-08-10 14:47:51 +02:00
rules Move /rules to new format (#2901) 2017-07-08 11:38:02 +02:00
scripts *: add admin grpc API 2017-07-10 09:14:14 +02:00
storage storage: instantiate correct block ranges 2017-08-24 12:36:07 +02:00
template Merge branch 'master' into uptsdb 2017-05-16 16:48:37 +02:00
util Merge branch 'dev-2.0' into mergemaster 2017-08-10 17:27:52 +02:00
vendor vendor: update prometheus/tsdb 2017-08-18 10:08:59 +02:00
web api.go: Fix typo in comment (#3122) 2017-08-28 11:03:07 +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 Fixing tests for Windows 2017-07-09 01:59:30 -03: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 v2.0.0-beta.2 2017-08-18 10:12:25 +02:00
CONTRIBUTING.md Add section for new contributors 2017-07-27 16:53:34 +05:30
Dockerfile Fix command line flags in Dockerfile 2017-07-13 12:14:49 +02:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md Add maintainers' GitHub usernames to MAINTAINERS.md. 2017-04-25 16:32:23 +10:00
Makefile make: disable remote tests temporarily 2017-04-27 17:27:19 +02:00
NOTICE Replace handlebars with the simpler and saner mustache library. 2016-11-17 02:33:12 +00:00
README.md Change -config.file to --config.file in Readme and error message 2017-08-08 12:49:35 +05:30
VERSION *: cut v2.0.0-beta.2 2017-08-18 10:12:25 +02:00
circle.yml Create sha256 checksums file during release 2017-05-18 16:50:44 +02: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.8 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.