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

Brian Brazil's avatar
Brian Brazil committed
19
20
21
22
23
## Hacktoberfest 2015

Prometheus is a featured project in [DigitalOcean's Hacktoberfest](https://hacktoberfest.digitalocean.com/). 
We have prepared a [list of potential projects](https://docs.google.com/document/d/1u1iPsFZ0kaa1SJZ1BKoNdm0j5c2lxB1pFah1b4Na8Sg/edit#heading=h.lgmt23h6abgp) to get you started.

24
## Architecture overview
25

26
![](https://cdn.rawgit.com/prometheus/prometheus/e761f0d/documentation/images/architecture.svg)
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
27

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
28
## Install
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
29

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
30
There are various ways of installing Prometheus.
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
31

beorn7's avatar
beorn7 committed
32
### Precompiled binaries
33

beorn7's avatar
beorn7 committed
34
35
36
37
38
39
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.
40

41
### Building from source
42

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

46
47
You can directly use the `go` tool to download and install the `prometheus`
and `promtool` binaries into your `GOPATH`:
48

49
50
    $ go get github.com/prometheus/prometheus/...
    $ prometheus -config.file=your_config.yml
51

52
You can also clone the repository yourself and build using `make`:
53

54
55
56
57
58
59
    $ mkdir -p $GOPATH/src/github.com/prometheus
    $ cd $GOPATH/src/github.com/prometheus
    $ git clone https://github.com/prometheus/prometheus.git
    $ cd prometheus
    $ make
    $ ./prometheus -config.file=your_config.yml
60

61
The Makefile provides several targets:
62

63
64
65
66
67
68
  * *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`
69

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
70
## More information
71

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
72
73
  * 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
74
  * 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
75

76
77
## Contributing

78
Refer to [CONTRIBUTING.md](CONTRIBUTING.md)
79

80
## License
81

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