The Prometheus monitoring system and time series database.
 
 
 
 
 
 
Go to file
Julius Volz 3d47f94149 Drop metric names after transformations.
After many transformations, it doesn't make sense to keep the metric
names, since the result of the transformation is no longer that metric.
This drops the metric name after such transformations and makes the web
UI deal well with missing metric names.

This depends on the current branch on the following things:

- prometheus/client_golang needs to be at
  e237cf15c6
  in branch "julius/int-fingerprints" (to be merged with new storage)

- prometheus/promdash needs to be at
  dd7691c9c2

Change-Id: Ib3c8cad8d647d9854e8c653c424b8c235ccc231d
2014-11-25 17:13:04 +01:00
.build Simplify makefiles. 2014-11-25 17:10:39 +01:00
config Simplify makefiles. 2014-11-25 17:10:39 +01:00
documentation Add Java implementation links to metric model docs. 2014-02-27 15:08:44 +01:00
notification Changes after pair code review. 2014-11-25 17:12:59 +01:00
retrieval Changes after pair code review. 2014-11-25 17:12:59 +01:00
rules Drop metric names after transformations. 2014-11-25 17:13:04 +01:00
stats Initial experimental snapshot of next-gen storage. 2014-11-25 17:02:00 +01:00
storage Changes after pair code review. 2014-11-25 17:12:59 +01:00
templates Fix targetpool_test.go and other tests. 2014-11-25 17:08:26 +01:00
tools Changes after pair code review. 2014-11-25 17:12:59 +01:00
utility Fix typo in comment. 2014-11-25 17:10:39 +01:00
web Drop metric names after transformations. 2014-11-25 17:13:04 +01:00
.gitignore More updates for first time users. 2013-10-22 20:54:43 +02:00
.pkgignore Make prometheus build on bazooka repo manager 2013-06-13 16:31:33 +02:00
.travis.yml Trailing build system cleanups. 2013-06-13 15:38:03 +02:00
CHANGELOG.md Cut v0.8.0. 2014-11-25 17:02:01 +01:00
CONTRIBUTING.md Link to relevant style guidelines. 2014-05-06 12:23:03 +02:00
CONTRIBUTORS.md Update community documentation. 2013-03-28 10:46:41 +01:00
Dockerfile Build prometheus tools as well 2014-11-25 17:01:59 +01:00
LICENSE Address outstanding comments from PR/47 and other cleanups. 2013-02-07 11:38:01 +01:00
MANIFEST Add MANIFEST listing 3rd party libs and versions. 2013-04-09 13:31:56 +02:00
Makefile Simplify makefiles. 2014-11-25 17:10:39 +01:00
Makefile.INCLUDE Simplify makefiles. 2014-11-25 17:10:39 +01:00
README.md Update README.md. 2014-11-25 17:13:04 +01:00
build_info.go Simplify makefiles. 2014-11-25 17:10:39 +01:00
main.go Changes after pair code review. 2014-11-25 17:12:59 +01:00
tests-for-die-in-a-fire-travis.sh Remove gvm on travis. 2013-06-13 14:36:00 +02:00

README.md

Prometheus

Bedecke deinen Himmel, Zeus! A new kid is in town.

Prometheus is a generic time series collection and computation server that is useful in the following fields:

  • Industrial Experimentation / Real-Time Behavioral Validation / Software Release Qualification
  • Econometric and Natural Sciences
  • Operational Concerns and Monitoring

The system is designed to collect telemetry from named targets on given intervals, evaluate rule expressions, display the results, and trigger an action if some condition is observed to be true.

TODO: The above description is somewhat esoteric. Rephrase it into somethith that tells normal people how they will usually benefit from using Prometheus.

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 distribution soon. Once those are offered, it will be the recommended way of installing Prometheus.

Use make

In most cirumstances, the following should work:

$ make
$ ARGUMENTS="-config.file=documentation/examples/prometheus.conf" make run

${ARGUMENTS} is passed verbatim to the commandline starting the Prometheus binary. This is useful for quick one-off invocations and smoke testing.

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](http://code.google.com/p/protobuf/](http://code.google.com/p/protobuf/), 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 tar ball with the binary for distribution.
  • make race_condition_run compiles and runs a binary with the race detector enabled.

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

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.