README.md 3.33 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

- 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**
17
- support for hierarchical and horizontal **federation**
18

19
## Architecture overview
20

21
![](https://cdn.rawgit.com/prometheus/prometheus/e761f0d/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

36
### Building from source
37

38
To build Prometheus from the source code yourself you need to have a working
39
Go environment with [version 1.5 or greater installed](http://golang.org/doc/install).
beorn7's avatar
beorn7 committed
40

41
You can directly use the `go` tool to download and install the `prometheus`
42
43
44
and `promtool` binaries into your `GOPATH`. We use Go 1.5's experimental
vendoring feature, so you will also need to set the `GO15VENDOREXPERIMENT=1`
environment variable in this case:
45

46
    $ GO15VENDOREXPERIMENT=1 go get github.com/prometheus/prometheus/cmd/...
47
    $ prometheus -config.file=your_config.yml
48

49
You can also clone the repository yourself and build using `make`:
50

51
52
53
54
    $ mkdir -p $GOPATH/src/github.com/prometheus
    $ cd $GOPATH/src/github.com/prometheus
    $ git clone https://github.com/prometheus/prometheus.git
    $ cd prometheus
55
    $ make build
56
    $ ./prometheus -config.file=your_config.yml
57

58
The Makefile provides several targets:
59

60
61
62
63
64
65
  * *build*: build the `prometheus` and `promtool` binaries
  * *test*: run the tests
  * *format*: format the source code
  * *vet*: check the source code for common errors
  * *assets*: rebuild the static assets
  * *docker*: build a docker container for the current `HEAD`
66

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

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
69
70
  * 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
71
  * 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
72

73
74
## Contributing

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

77
## License
78

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