README.md 4.08 KB
Newer Older
1
2
3
# Prometheus [![Build Status](https://travis-ci.org/prometheus/prometheus.svg)][travis]

[![CircleCI](https://circleci.com/gh/prometheus/prometheus/tree/master.svg?style=shield)][circleci]
Steve Durrheimer's avatar
Steve Durrheimer committed
4
5
[![Docker Repository on Quay](https://quay.io/repository/prometheus/prometheus/status)][quay]
[![Docker Pulls](https://img.shields.io/docker/pulls/prom/prometheus.svg?maxAge=604800)][hub]
Matt T. Proud's avatar
Matt T. Proud committed
6

7
8
9
Visit [prometheus.io](https://prometheus.io) for the full documentation,
examples and guides.

10
Prometheus, a [Cloud Native Computing Foundation](https://cncf.io/) project, is a systems and service monitoring system. It collects metrics
11
12
13
14
15
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:
16
17
18
19
20
21
22
23

- 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**
24
- support for hierarchical and horizontal **federation**
25

26
## Architecture overview
27

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

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
30
## Install
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
31

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
32
There are various ways of installing Prometheus.
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
33

beorn7's avatar
beorn7 committed
34
### Precompiled binaries
35

beorn7's avatar
beorn7 committed
36
37
38
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
39
40
41
is the recommended way of installing Prometheus. 
See the [Installing](https://prometheus.io/docs/introduction/install/) 
chapter in the documentation for all the details.
beorn7's avatar
beorn7 committed
42

43
44
45
46
Debian packages [are available](https://packages.debian.org/sid/net/prometheus).

### Container images

47
Container images are available on [Quay.io](https://quay.io/repository/prometheus/prometheus).
48

49
### Building from source
50

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

54
You can directly use the `go` tool to download and install the `prometheus`
55
56
57
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:
58

59
    $ GO15VENDOREXPERIMENT=1 go get github.com/prometheus/prometheus/cmd/...
60
    $ prometheus -config.file=your_config.yml
61

62
You can also clone the repository yourself and build using `make`:
63

64
65
66
67
    $ mkdir -p $GOPATH/src/github.com/prometheus
    $ cd $GOPATH/src/github.com/prometheus
    $ git clone https://github.com/prometheus/prometheus.git
    $ cd prometheus
68
    $ make build
69
    $ ./prometheus -config.file=your_config.yml
70

71
The Makefile provides several targets:
72

73
74
75
76
77
78
  * *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`
79

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
80
## More information
81

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
82
83
  * 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
84
  * 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
85

86
87
## Contributing

88
Refer to [CONTRIBUTING.md](CONTRIBUTING.md)
89

90
## License
91

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
92
Apache License 2.0, see [LICENSE](LICENSE).
93
94
95
96
97


[travis]: https://travis-ci.org/prometheus/prometheus
[hub]: https://hub.docker.com/r/prom/prometheus/
[circleci]: https://circleci.com/gh/prometheus/prometheus
Steve Durrheimer's avatar
Steve Durrheimer committed
98
[quay]: https://quay.io/repository/prometheus/prometheus