README.md 5.49 KB
Newer Older
1
# Prometheus
2

3
[![Build Status](https://travis-ci.org/prometheus/prometheus.svg)][travis]
4
[![CircleCI](https://circleci.com/gh/prometheus/prometheus/tree/master.svg?style=shield)][circleci]
Steve Durrheimer's avatar
Steve Durrheimer committed
5
6
[![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
7
[![Go Report Card](https://goreportcard.com/badge/github.com/prometheus/prometheus)](https://goreportcard.com/report/github.com/prometheus/prometheus)
Dmytro Slupytskyi's avatar
Dmytro Slupytskyi committed
8
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/486/badge)](https://bestpractices.coreinfrastructure.org/projects/486)
9
[![fuzzit](https://app.fuzzit.dev/badge?org_id=prometheus&branch=master)](https://fuzzit.dev)
Matt T. Proud's avatar
Matt T. Proud committed
10

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

14
Prometheus, a [Cloud Native Computing Foundation](https://cncf.io/) project, is a systems and service monitoring system. It collects metrics
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.

abejidefemi1@gmail.com's avatar
abejidefemi1@gmail.com committed
19
Prometheus's main distinguishing features as compared to other monitoring systems are:
20
21
22
23
24
25
26
27

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

30
## Architecture overview
31

32
![](https://cdn.jsdelivr.net/gh/prometheus/prometheus@c34257d069c630685da35bcef084632ffd5d6209/documentation/images/architecture.svg)
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
33

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

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

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

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

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

49
### Docker images
50

51
Docker images are available on [Quay.io](https://quay.io/repository/prometheus/prometheus) or [Docker Hub](https://hub.docker.com/r/prom/prometheus/).
52

53
54
You can launch a Prometheus container for trying it out with

55
    $ docker run --name prometheus -d -p 127.0.0.1:9090:9090 prom/prometheus
56
57
58

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

59
### Building from source
60

61
To build Prometheus from the source code yourself you need to have a working
62
Go environment with [version 1.13 or greater installed](https://golang.org/doc/install).
63
64
You will also need to have [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/)
installed in order to build the frontend assets.
beorn7's avatar
beorn7 committed
65

66
You can directly use the `go` tool to download and install the `prometheus`
67
and `promtool` binaries into your `GOPATH`:
68

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

72
73
74
75
76
77
*However*, when using `go get` to build Prometheus, Prometheus will expect to be able to
read its web assets from local filesystem directories under `web/ui/static` and
`web/ui/templates`. In order for these assets to be found, you will have to run Prometheus
from the root of the cloned repository. Note also that these directories do not include the
new experimental React UI unless it has been built explicitly using `make assets` or `make build`.

78
79
An example of the above configuration file can be found [here.](https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml)

80
81
You can also clone the repository yourself and build using `make build`, which will compile in
the web assets so that Prometheus can be run from anywhere:
82

83
84
85
86
    $ mkdir -p $GOPATH/src/github.com/prometheus
    $ cd $GOPATH/src/github.com/prometheus
    $ git clone https://github.com/prometheus/prometheus.git
    $ cd prometheus
87
    $ make build
88
    $ ./prometheus --config.file=your_config.yml
89

90
The Makefile provides several targets:
91

92
  * *build*: build the `prometheus` and `promtool` binaries (includes building and compiling in web assets)
93
  * *test*: run the tests
94
  * *test-short*: run the short tests
95
96
97
  * *format*: format the source code
  * *vet*: check the source code for common errors
  * *docker*: build a docker container for the current `HEAD`
98

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
99
## More information
100

101
  * The source code is periodically indexed: [Prometheus Core](https://godoc.org/github.com/prometheus/prometheus).
Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
102
  * You will find a Travis CI configuration in `.travis.yml`.
103
  * 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
104

105
106
## Contributing

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

109
## License
110

111
Apache License 2.0, see [LICENSE](https://github.com/prometheus/prometheus/blob/master/LICENSE).
112
113
114
115
116


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