README.md 3.84 KB
Newer Older
1
# Prometheus [![Build Status](https://travis-ci.org/prometheus/prometheus.svg)](https://travis-ci.org/prometheus/prometheus) [![Circle CI](https://circleci.com/gh/prometheus/prometheus/tree/master.svg?style=svg)](https://circleci.com/gh/prometheus/prometheus/tree/master)
Matt T. Proud's avatar
Matt T. Proud committed
2

3
4
5
6
7
8
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:
9
10
11
12
13
14
15
16
17
18

- 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

19
## Architecture overview
20

21
![](https://cdn.rawgit.com/prometheus/prometheus/62b69b0/documentation/images/architecture.svg)
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
22

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
23
## Install
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
24

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
25
There are various ways of installing Prometheus.
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
26

beorn7's avatar
beorn7 committed
27
### Precompiled binaries
28

beorn7's avatar
beorn7 committed
29
30
31
32
33
34
Precompiled binaries for released versions are available in the
[*releases* section](https://github.com/prometheus/prometheus/releases)
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.
35

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
36
### Use `make`
37

beorn7's avatar
beorn7 committed
38
39
40
41
42
43
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](https://github.com/prometheus/prometheus/issues/609) for
context.)
beorn7's avatar
beorn7 committed
44

Joseph Wilk's avatar
typo    
Joseph Wilk committed
45
In most circumstances, the following should work:
46

juliusv's avatar
juliusv committed
47
    $ make build
48
    $ ./prometheus -config.file=documentation/examples/prometheus.yml
49

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
50
The above requires a number of common tools to be installed, namely
51
`curl`, `git`, `gzip`, `hg` (Mercurial CLI).
52

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
53
54
55
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.
56

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

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
59
* `make test` runs tests.
juliusv's avatar
juliusv committed
60
* `make tarball` creates a tarball with the binary for distribution.
61
* `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`).
62

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

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
65
Using your own Go development environment with the usual tooling is
66
67
68
possible, too. After making changes to the files in `web/static` you
have to run `make` in the `web/` directory. This generates the respective
`web/blob/files.go` file which embedds the static assets in the compiled binary.
69

70
Furthermore, the version information (see `version/info.go`) will not be
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
71
72
73
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.
74

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
75
## More information
76

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
77
78
  * 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
79
  * 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
80

81
82
## Contributing

83
Refer to [CONTRIBUTING.md](CONTRIBUTING.md)
84

85
## License
86

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