README.md 4.32 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]
Tobias Schmidt's avatar
Tobias Schmidt committed
6
[![Go Report Card](https://goreportcard.com/badge/github.com/prometheus/prometheus)](https://goreportcard.com/report/github.com/prometheus/prometheus)
Matt T. Proud's avatar
Matt T. Proud committed
7

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

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

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

27
## Architecture overview
28

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

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

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

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

beorn7's avatar
beorn7 committed
37
Precompiled binaries for released versions are available in the
38
39
[*download* section](https://prometheus.io/download/)
on [prometheus.io](https://prometheus.io). Using the latest production release binary
Tobias Schmidt's avatar
Tobias Schmidt committed
40
41
is the recommended way of installing Prometheus.
See the [Installing](https://prometheus.io/docs/introduction/install/)
42
chapter in the documentation for all the details.
beorn7's avatar
beorn7 committed
43

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

46
### Docker images
47

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

50
### Building from source
51

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

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

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

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

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

72
The Makefile provides several targets:
73

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

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

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

87
88
## Contributing

89
Refer to [CONTRIBUTING.md](https://github.com/prometheus/prometheus/blob/master/CONTRIBUTING.md)
90

91
## License
92

93
Apache License 2.0, see [LICENSE](https://github.com/prometheus/prometheus/blob/master/LICENSE).
94
95
96
97
98


[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
99
[quay]: https://quay.io/repository/prometheus/prometheus