README.md 3.49 KB
Newer Older
1
# Prometheus
Matt T. Proud's avatar
Matt T. Proud committed
2

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Prometheus is a systems and service monitoring system. 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

Prometheus 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.
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
18

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
19
## Install
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
20

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
21
There are various ways of installing Prometheus.
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
22

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
23
### Precompiled packages
24

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
25
We plan to provide precompiled binaries for various platforms and even
juliusv's avatar
juliusv committed
26
packages for common Linux distributions soon. Once those are offered,
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
27
it will be the recommended way of installing Prometheus.
28

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
29
### Use `make`
30

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
31
In most cirumstances, the following should work:
32

juliusv's avatar
juliusv committed
33
34
    $ make build
    $ ./prometheus -config.file=documentation/examples/prometheus.conf
35

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
36
37
38
39
40
41
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`.
42

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
43
44
45
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.
46

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
47
The `Makefile` offers a number of useful targets. Some examples:
48

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
49
* `make test` runs tests.
juliusv's avatar
juliusv committed
50
51
* `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`).
52

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
53
### Use your own Go development environment
Matt T. Proud's avatar
Matt T. Proud committed
54

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
55
56
57
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):
58

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
59
60
61
* 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.
62

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
63
64
65
66
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.
67

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
68
## More information
69

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
70
71
  * The source code is periodically indexed: [Prometheus Core](http://godoc.org/github.com/prometheus/prometheus).
  * You will find a Travis CI configuration in `.travis.yml`.
juliusv's avatar
juliusv committed
72
  * All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers) and the `#prometheus` channel on `irc.freenode.net`.
Matt T. Proud's avatar
Matt T. Proud committed
73

74
75
## Contributing

76
Refer to [CONTRIBUTING.md](CONTRIBUTING.md)
77

78
## License
79

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
80
Apache License 2.0, see [LICENSE](LICENSE).