The Prometheus monitoring system and time series database.
Find a file
Fabian Reinartz 890c1a7e74 cmd/promtool: add promtool command.
The promtool command should bundle multiple commands that help
in maintaining a running Prometheus server.
2015-06-22 16:06:18 +02:00
.build Simplify makefiles. 2014-11-25 17:10:39 +01:00
cmd cmd/promtool: add promtool command. 2015-06-22 16:06:18 +02:00
config Add support for Zookeeper Serversets for SD. 2015-06-16 11:02:08 +01:00
console_libraries Convert pathPrefix to not have trailing slash. 2015-06-01 12:43:17 +02:00
consoles Add cpu count to rhs table 2015-02-19 12:07:52 +01:00
documentation Adjust example config to naming changes 2015-05-19 18:12:58 +02:00
Godeps Add support for Zookeeper Serversets for SD. 2015-06-16 11:02:08 +01:00
notification notification: remove flags 2015-06-15 19:01:06 +02:00
promql promql: remove global flags 2015-06-15 19:01:06 +02:00
retrieval Add support for Zookeeper Serversets for SD. 2015-06-16 11:02:08 +01:00
rules promql: remove global flags 2015-06-15 19:01:06 +02:00
storage storage: remove global flags 2015-06-15 19:01:06 +02:00
template promql: remove global flags 2015-06-15 19:01:06 +02:00
tools Remove name arg from Parse* functions, enhance parsing errors. 2015-04-29 16:38:41 +02:00
util util/cli: create CLI utility package 2015-06-18 21:28:03 +02:00
version version: move version information into separate package. 2015-06-16 14:48:29 +02:00
web web: expose a version information endpoint 2015-06-17 14:49:31 +02:00
.gitignore Add "data" directory to .gitignore. 2015-06-11 15:39:28 +02:00
.pkgignore Make prometheus build on bazooka repo manager 2013-06-13 16:31:33 +02:00
.travis.yml Use less offensive language WRT Travise. 2014-12-09 14:25:37 +01:00
AUTHORS.md Update AUTHORS.md and put fabxc into maintainers. 2015-06-03 16:20:21 +02:00
CHANGELOG.md Cut 0.14.0. 2015-06-01 18:44:21 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md. 2015-01-22 15:07:20 +01:00
Dockerfile Fix Dockerfile with recent embed-static.sh/go-bindata change 2015-06-12 18:19:25 +02:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
Makefile Merge pull request #809 from prometheus/update-make-format 2015-06-15 21:04:28 +02:00
Makefile.INCLUDE version: move version information into separate package. 2015-06-16 14:48:29 +02:00
NOTICE Add support for Zookeeper Serversets for SD. 2015-06-16 11:02:08 +01:00
README.md Fix reference to example configuration file 2015-06-01 13:05:48 +02:00
travis-helper.sh Clean up license issues. 2015-01-21 20:07:45 +01:00

Prometheus Build Status

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
  • federation support coming soon

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.

Use make

Clone the repository in the usual way with git clone. (If you download and unpack the source archives provided by GitHub instead of using git clone, you need to set an environment variable VERSION to make the below work. See issue #609 for context.)

In most circumstances, the following should work:

$ make build
$ ./prometheus -config.file=documentation/examples/prometheus.yml

The above requires a number of common tools to be installed, namely curl, git, gzip, hg (Mercurial CLI), sed, xxd. Should you need to change any of the protocol buffer definition files (*.proto), you also need the protocol buffer compiler protoc, v2.5.0 or higher, in your $PATH.

Everything else will be downloaded and installed into a staging environment in the .build sub-directory. That includes a Go development environment of the appropriate version.

The Makefile offers a number of useful targets. Some examples:

  • make test runs tests.
  • make tarball creates a tarball with the binary for distribution.
  • make race_condition_run compiles and runs a binary with the race detector enabled. To pass arguments when running Prometheus this way, set the ARGUMENTS environment variable (e.g. ARGUMENTS="-config.file=./prometheus.conf" make race_condition_run).

Use your own Go development environment

Using your own Go development environment with the usual tooling is possible, too, but you have to take care of various generated files (usually by running make in the respective sub-directory):

  • Compiling the protocol buffer definitions in config (only if you have changed them).
  • Generating the parser and lexer code in rules (only if you have changed parser.y or lexer.l).
  • The files.go blob in web/blob, which embeds the static web content into the binary.

Furthermore, the build info (see build_info.go) will not be populated if you simply run go build. You have to pass in command line flags as defined in Makefile.INCLUDE (see ${BUILDFLAGS}) to do that.

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.