Go to file
Tiago Katcipis bb4722d6b5 Adding RabbitMQ example as mentioned on #1312 2016-01-12 20:59:37 -02:00
cmd Improve handling of series file truncation 2016-01-11 16:42:10 +01:00
config Add new defaults for relabel configurations 2015-11-16 13:16:13 +01:00
console_libraries Add blackbox console. 2015-11-01 20:06:52 +00:00
consoles All console expressions should use irate. 2016-01-05 11:53:22 +00:00
documentation Adding RabbitMQ example as mentioned on #1312 2016-01-12 20:59:37 -02:00
notification Add comments, rename a method 2015-12-23 12:29:28 +01:00
promql Support old alerting rule syntax 2016-01-11 12:14:06 +01:00
retrieval Use up/down in UI for consistency with 'up' metric. 2016-01-12 12:09:20 +00:00
rules Terminate rule groups during initial sleep 2016-01-12 10:54:09 +01:00
scripts Fix missing go version in build tags 2015-09-18 10:38:26 +02:00
storage Update doc comment 2016-01-12 12:38:18 +01:00
template template: Use zero-values for missing values. 2015-11-28 13:45:32 +00:00
util Support escape sequences in strings and add raw strings. 2015-10-08 19:17:21 +02:00
vendor Upgrade common/log vendoring. 2016-01-04 14:48:35 +01:00
version Update version on master branch 2015-11-05 10:34:29 +01:00
web Revert autocomplete changes 2016-01-11 15:18:39 +01:00
.dockerignore Add service discovery using Marathon API. 2015-08-10 01:36:24 +02:00
.gitignore Remove -web.use-local-assets 2015-11-11 17:58:03 +01:00
.travis.yml Let code format style errors fail CI 2016-01-06 18:29:28 -05:00
AUTHORS.md Update Julius's email address in AUTHORS.md 2015-10-26 02:21:39 +01:00
CHANGELOG.md Update CHANGELOG.md 2015-10-20 23:25:24 -06:00
CONTRIBUTING.md
Dockerfile Add goenv script and fix Docker 2015-09-18 10:28:15 +02:00
LICENSE
Makefile Let code format style errors fail CI 2016-01-06 18:29:28 -05:00
NOTICE
README.md Fix outdated federation feature statement 2015-11-08 23:35:11 +01:00
circle.yml Add circleci yaml for Dockerfile test build 2015-06-26 11:00:15 +02:00

README.md

Prometheus Build Status Circle CI

Prometheus 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 releases section of the GitHub repository. Using the latest production release binary is the recommended way of installing Prometheus.

Debian and RPM packages are being worked on.

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
$ ./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.
  • All of the core developers are accessible via the Prometheus Developers Mailinglist and the #prometheus channel on irc.freenode.net.

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.