Go to file
Brian Brazil ca31d36382 Merge pull request #1444 from prometheus/add-tests-for-string-parsing
Add tests to specify the string escaping behavior
2016-03-01 22:31:08 +00:00
cmd Rename notification to notifier 2016-03-01 12:39:08 +01:00
config Fix global config YAML issues 2016-02-15 14:08:25 +01:00
console_libraries Add blackbox console. 2015-11-01 20:06:52 +00:00
consoles Fix the instrumentation fixes 2016-02-17 15:50:55 +01:00
documentation Remove invalid scrape timeout from example config. 2016-02-24 21:06:36 +01:00
notifier Rename notification to notifier 2016-03-01 12:39:08 +01:00
promql Add tests to specify the string escaping behavior 2016-03-01 17:23:18 -05:00
retrieval Kubernetes SD: Fix node IP discovery 2016-03-01 12:24:52 +00:00
rules Rename notification to notifier 2016-03-01 12:39:08 +01:00
scripts Merge pull request #1415 from prometheus/release-0.17 2016-02-22 16:39:48 +01:00
storage Merge pull request #1422 from prometheus/release-0.17 2016-02-23 23:07:44 +01:00
template template: Use zero-values for missing values. 2015-11-28 13:45:32 +00:00
util Fix minor typo 2016-02-22 23:25:17 +00:00
vendor Update common/expfmt vendoring 2016-02-11 16:08:29 +01:00
version Bump version to 0.17.0rc2 2016-02-05 13:33:22 +01:00
web Fix global config YAML issues 2016-02-15 14:08:25 +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 Improve 0.17.0 changelog 2016-02-22 19:49:33 -05:00
CONTRIBUTING.md Update CONTRIBUTING.md. 2015-01-22 15:07:20 +01:00
Dockerfile Add goenv script and fix Docker 2015-09-18 10:28:15 +02:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
Makefile Add tarballs target to build release tarballs. 2016-01-27 17:03:44 +01:00
NOTICE Add support for Zookeeper Serversets for SD. 2015-06-16 11:02:08 +01:00
README.md Change `make` to `make build` 2016-02-05 11:30:31 +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 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.
  • 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.