README.md
1# Prometheus
2
3[][circleci]
4[][quay]
5[][hub]
6[](https://goreportcard.com/report/github.com/prometheus/prometheus)
7[](https://bestpractices.coreinfrastructure.org/projects/486)
8[](https://fuzzit.dev)
9
10Visit [prometheus.io](https://prometheus.io) for the full documentation,
11examples and guides.
12
13Prometheus, a [Cloud Native Computing Foundation](https://cncf.io/) project, is a systems and service monitoring system. It collects metrics
14from configured targets at given intervals, evaluates rule expressions,
15displays the results, and can trigger alerts if some condition is observed
16to be true.
17
18Prometheus's main distinguishing features as compared to other monitoring systems are:
19
20- a **multi-dimensional** data model (timeseries defined by metric name and set of key/value dimensions)
21- a **flexible query language** to leverage this dimensionality
22- no dependency on distributed storage; **single server nodes are autonomous**
23- timeseries collection happens via a **pull model** over HTTP
24- **pushing timeseries** is supported via an intermediary gateway
25- targets are discovered via **service discovery** or **static configuration**
26- multiple modes of **graphing and dashboarding support**
27- support for hierarchical and horizontal **federation**
28
29## Architecture overview
30
31
32
33## Install
34
35There are various ways of installing Prometheus.
36
37### Precompiled binaries
38
39Precompiled binaries for released versions are available in the
40[*download* section](https://prometheus.io/download/)
41on [prometheus.io](https://prometheus.io). Using the latest production release binary
42is the recommended way of installing Prometheus.
43See the [Installing](https://prometheus.io/docs/introduction/install/)
44chapter in the documentation for all the details.
45
46Debian packages [are available](https://packages.debian.org/sid/net/prometheus).
47
48### Docker images
49
50Docker images are available on [Quay.io](https://quay.io/repository/prometheus/prometheus) or [Docker Hub](https://hub.docker.com/r/prom/prometheus/).
51
52You can launch a Prometheus container for trying it out with
53
54 $ docker run --name prometheus -d -p 127.0.0.1:9090:9090 prom/prometheus
55
56Prometheus will now be reachable at http://localhost:9090/.
57
58### Building from source
59
60To build Prometheus from the source code yourself you need to have a working
61Go environment with [version 1.13 or greater installed](https://golang.org/doc/install).
62You will also need to have [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/)
63installed in order to build the frontend assets.
64
65You can directly use the `go` tool to download and install the `prometheus`
66and `promtool` binaries into your `GOPATH`:
67
68 $ go get github.com/prometheus/prometheus/cmd/...
69 $ prometheus --config.file=your_config.yml
70
71*However*, when using `go get` to build Prometheus, Prometheus will expect to be able to
72read its web assets from local filesystem directories under `web/ui/static` and
73`web/ui/templates`. In order for these assets to be found, you will have to run Prometheus
74from the root of the cloned repository. Note also that these directories do not include the
75new experimental React UI unless it has been built explicitly using `make assets` or `make build`.
76
77An example of the above configuration file can be found [here.](https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml)
78
79You can also clone the repository yourself and build using `make build`, which will compile in
80the web assets so that Prometheus can be run from anywhere:
81
82 $ mkdir -p $GOPATH/src/github.com/prometheus
83 $ cd $GOPATH/src/github.com/prometheus
84 $ git clone https://github.com/prometheus/prometheus.git
85 $ cd prometheus
86 $ make build
87 $ ./prometheus --config.file=your_config.yml
88
89The 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 * *format*: format the source code
95 * *vet*: check the source code for common errors
96 * *docker*: build a docker container for the current `HEAD`
97
98## React UI Development
99
100For 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).
101
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.
107
108## Contributing
109
110Refer to [CONTRIBUTING.md](https://github.com/prometheus/prometheus/blob/master/CONTRIBUTING.md)
111
112## License
113
114Apache License 2.0, see [LICENSE](https://github.com/prometheus/prometheus/blob/master/LICENSE).
115
116
117[hub]: https://hub.docker.com/r/prom/prometheus/
118[circleci]: https://circleci.com/gh/prometheus/prometheus
119[quay]: https://quay.io/repository/prometheus/prometheus
120
){kind=link}
){kind=link}
){kind=link}