Go to file
Bjoern Rabenstein 2c8fdcbc23 Remove a deadlock during shutdown.
If queries are still running when the shutdown is initiated, they will
finish _during_ the shutdown. In that case, they might request chunk
eviction upon unpinning their pinned chunks. That might completely
fill the evict request queue _after_ draining it during storage
shutdown. If that ever happens (which is the case if there are _many_
queries still running during shutdown), the affected queries will be
stuck while keeping a fingerprint locked. The checkpointing can then
not process that fingerprint (or one that shares the same lock). And
then we are deadlocked.
2015-01-22 14:42:15 +01:00
.build Simplify makefiles. 2014-11-25 17:10:39 +01:00
Godeps Vendor external dependencies with godep. 2015-01-09 12:00:42 +01:00
config Clean up license issues. 2015-01-21 20:07:45 +01:00
console_libraries Console templating library, including graphs. 2014-12-18 16:54:31 +00:00
consoles Console templating library, including graphs. 2014-12-18 16:54:31 +00:00
documentation Update architecture diagram and include source file. 2014-12-23 14:04:58 +01:00
notification Clean up license issues. 2015-01-21 20:07:45 +01:00
retrieval Clean up license issues. 2015-01-21 20:07:45 +01:00
rules Clean up license issues. 2015-01-21 20:07:45 +01:00
stats Clean up license issues. 2015-01-21 20:07:45 +01:00
storage Remove a deadlock during shutdown. 2015-01-22 14:42:15 +01:00
templates Clean up license issues. 2015-01-21 20:07:45 +01:00
tools Clean up license issues. 2015-01-21 20:07:45 +01:00
utility Clean up license issues. 2015-01-21 20:07:45 +01:00
web Merge pull request #456 from prometheus/beorn7/license-cleanup 2015-01-22 14:32:37 +01:00
.gitignore Upgrade to Go 1.4 2014-12-15 14:05:43 +01: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 Tweak AUTHORS. 2015-01-22 14:12:26 +01:00
CHANGELOG.md Cut v0.8.0. 2014-11-25 17:02:01 +01:00
CONTRIBUTING.md Update contributing guide to remove gerrit. 2015-01-02 10:14:05 +00:00
Dockerfile Clean up license issues. 2015-01-21 20:07:45 +01:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
Makefile Clean up license issues. 2015-01-21 20:07:45 +01:00
Makefile.INCLUDE Clean up license issues. 2015-01-21 20:07:45 +01:00
NOTICE Clean up license issues. 2015-01-21 20:07:45 +01:00
README.md Add build status badge to README.md title. 2015-01-20 17:21:04 +01:00
VERSION Prometheus version 0.9.0rc4. 2015-01-20 15:15:37 +01:00
build_info.go Clean up license issues. 2015-01-21 20:07:45 +01:00
main.go Clean up license issues. 2015-01-21 20:07:45 +01:00
travis-helper.sh Clean up license issues. 2015-01-21 20:07:45 +01:00

README.md

Prometheus

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 packages

We plan to provide precompiled binaries for various platforms and even packages for common Linux distributions soon. Once those are offered, it will be the recommended way of installing Prometheus.

Use make

In most cirumstances, the following should work:

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

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.