README.md 4.82 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)
7
8
[![Code Climate](https://codeclimate.com/github/prometheus/prometheus/badges/gpa.svg)](https://codeclimate.com/github/prometheus/prometheus)
[![Issue Count](https://codeclimate.com/github/prometheus/prometheus/badges/issue_count.svg)](https://codeclimate.com/github/prometheus/prometheus)
Matt T. Proud's avatar
Matt T. Proud committed
9

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

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

- 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**
27
- support for hierarchical and horizontal **federation**
28

29
## Architecture overview
30

Julius Volz's avatar
Julius Volz committed
31
![](https://cdn.rawgit.com/prometheus/prometheus/c34257d069c630685da35bcef084632ffd5d6209/documentation/images/architecture.svg)
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
32

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
33
## Install
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
34

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
35
There are various ways of installing Prometheus.
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
36

beorn7's avatar
beorn7 committed
37
### Precompiled binaries
38

beorn7's avatar
beorn7 committed
39
Precompiled binaries for released versions are available in the
40
41
[*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
42
43
is the recommended way of installing Prometheus.
See the [Installing](https://prometheus.io/docs/introduction/install/)
44
chapter in the documentation for all the details.
beorn7's avatar
beorn7 committed
45

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

48
### Docker images
49

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

52
53
54
55
56
57
You can launch a Prometheus container for trying it out with

    $ docker run --name prometheus -d -p 127.0.0.1:9090:9090 quay.io/prometheus/prometheus

Prometheus will now be reachable at http://localhost:9090/.

58
### Building from source
59

60
To build Prometheus from the source code yourself you need to have a working
Jacky Wu's avatar
Jacky Wu committed
61
Go environment with [version 1.8 or greater installed](http://golang.org/doc/install).
beorn7's avatar
beorn7 committed
62

63
You can directly use the `go` tool to download and install the `prometheus`
64
65
66
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:
67

68
    $ GO15VENDOREXPERIMENT=1 go get github.com/prometheus/prometheus/cmd/...
69
    $ prometheus --config.file=your_config.yml
70

71
You can also clone the repository yourself and build using `make`:
72

73
74
75
76
    $ mkdir -p $GOPATH/src/github.com/prometheus
    $ cd $GOPATH/src/github.com/prometheus
    $ git clone https://github.com/prometheus/prometheus.git
    $ cd prometheus
77
    $ make build
78
    $ ./prometheus --config.file=your_config.yml
79

80
The Makefile provides several targets:
81

82
83
  * *build*: build the `prometheus` and `promtool` binaries
  * *test*: run the tests
84
  * *test-short*: run the short tests
85
86
87
88
  * *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`
89

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
90
## More information
91

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
92
93
  * 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`.
94
  * See the [Community page](https://prometheus.io/community) for how to reach the Prometheus developers and users on various communication channels.
Matt T. Proud's avatar
Matt T. Proud committed
95

96
97
## Contributing

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

100
## License
101

102
Apache License 2.0, see [LICENSE](https://github.com/prometheus/prometheus/blob/master/LICENSE).
103
104
105
106
107


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