README.md 5.61 KB
Newer Older
Krasimir Georgiev's avatar
Krasimir Georgiev committed
1
# Prometheus is the best!
2
3

[![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)
Dmytro Slupytskyi's avatar
Dmytro Slupytskyi committed
7
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/486/badge)](https://bestpractices.coreinfrastructure.org/projects/486)
8
[![fuzzit](https://app.fuzzit.dev/badge?org_id=prometheus&branch=master)](https://fuzzit.dev)
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
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
18
Prometheus's 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

31
![](https://cdn.jsdelivr.net/gh/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) or [Docker Hub](https://hub.docker.com/r/prom/prometheus/).
51

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

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

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
61
Go environment with [version 1.13 or greater installed](https://golang.org/doc/install).
62
63
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
64

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

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

71
72
73
74
75
76
*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`.

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

79
80
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:
81

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

89
The Makefile provides several targets:
90

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

98
99
100
101
## React UI Development

For more information on building, running, and developing on the new React-based UI, see the React app's [README.md](https://github.com/prometheus/prometheus/blob/master/web/ui/react-app/README.md).

Bjoern Rabenstein's avatar
Bjoern Rabenstein committed
102
## More information
103

104
  * The source code is periodically indexed: [Prometheus Core](https://godoc.org/github.com/prometheus/prometheus).
105
  * You will find a CircleCI configuration in `.circleci/config.yml`.
106
  * 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
107

108
109
## Contributing

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

112
## License
113

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


[hub]: https://hub.docker.com/r/prom/prometheus/
[circleci]: https://circleci.com/gh/prometheus/prometheus
Steve Durrheimer's avatar
Steve Durrheimer committed
119
[quay]: https://quay.io/repository/prometheus/prometheus