2020-01-27 16:10:08 +00:00
# Prometheus
2015-12-21 17:09:38 +00:00
2021-02-22 19:19:08 +00:00
[][circleci]
2016-04-26 15:23:41 +00:00
[][quay]
[][hub]
2016-09-15 03:09:26 +00:00
[](https://goreportcard.com/report/github.com/prometheus/prometheus)
2018-02-05 19:39:32 +00:00
[](https://bestpractices.coreinfrastructure.org/projects/486)
2020-08-14 15:23:55 +00:00
[](https://gitpod.io/#https://github.com/prometheus/prometheus)
2021-02-07 19:51:02 +00:00
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened& can=1& q=proj:prometheus)
2012-11-24 11:14:12 +00:00
2016-04-13 01:01:09 +00:00
Visit [prometheus.io ](https://prometheus.io ) for the full documentation,
examples and guides.
2016-07-27 22:15:03 +00:00
Prometheus, a [Cloud Native Computing Foundation ](https://cncf.io/ ) project, is a systems and service monitoring system. It collects metrics
2014-12-07 00:23:01 +00:00
from configured targets at given intervals, evaluates rule expressions,
2020-10-27 09:50:37 +00:00
displays the results, and can trigger alerts when specified conditions are observed.
2014-12-07 00:23:01 +00:00
2020-10-27 09:50:37 +00:00
The features that distinguish Prometheus from other metrics and monitoring systems are:
2014-12-06 23:05:10 +00:00
2020-10-27 09:50:37 +00:00
- A **multi-dimensional** data model (time series defined by metric name and set of key/value dimensions)
2020-08-04 20:38:08 +00:00
- PromQL, a **powerful and flexible query language** to leverage this dimensionality
2020-10-27 09:50:37 +00:00
- No dependency on distributed storage; **single server nodes are autonomous**
- An HTTP **pull model** for time series collection
- **Pushing time series** is supported via an intermediary gateway for batch jobs
- Targets are discovered via **service discovery** or **static configuration**
- Multiple modes of **graphing and dashboarding support**
- Support for hierarchical and horizontal **federation**
2014-12-06 23:05:10 +00:00
2014-12-07 00:29:56 +00:00
## Architecture overview
2014-12-07 00:23:01 +00:00
2018-10-13 12:20:29 +00:00
2014-11-17 18:20:39 +00:00
2014-11-21 12:27:28 +00:00
## Install
2014-11-17 18:20:39 +00:00
2014-11-21 12:27:28 +00:00
There are various ways of installing Prometheus.
2014-11-17 18:20:39 +00:00
2015-05-22 11:31:59 +00:00
### Precompiled binaries
2012-11-24 11:33:34 +00:00
2015-05-22 11:31:59 +00:00
Precompiled binaries for released versions are available in the
2016-09-07 12:32:48 +00:00
[*download* section ](https://prometheus.io/download/ )
on [prometheus.io ](https://prometheus.io ). Using the latest production release binary
2016-09-15 03:09:26 +00:00
is the recommended way of installing Prometheus.
See the [Installing ](https://prometheus.io/docs/introduction/install/ )
2016-04-25 09:31:38 +00:00
chapter in the documentation for all the details.
2015-05-22 11:31:59 +00:00
2016-09-07 12:32:48 +00:00
### Docker images
2016-07-01 08:16:49 +00:00
2018-11-16 11:26:10 +00:00
Docker images are available on [Quay.io ](https://quay.io/repository/prometheus/prometheus ) or [Docker Hub ](https://hub.docker.com/r/prom/prometheus/ ).
2013-01-24 23:33:16 +00:00
2017-03-13 10:37:25 +00:00
You can launch a Prometheus container for trying it out with
2018-11-16 11:26:10 +00:00
$ docker run --name prometheus -d -p 127.0.0.1:9090:9090 prom/prometheus
2017-03-13 10:37:25 +00:00
Prometheus will now be reachable at http://localhost:9090/.
2015-09-17 16:20:38 +00:00
### Building from source
2013-01-24 23:33:16 +00:00
2021-09-17 22:48:02 +00:00
To build Prometheus from source code, first ensure that you have a working
2020-11-18 17:16:33 +00:00
Go environment with [version 1.14 or greater installed ](https://golang.org/doc/install ).
2021-08-12 18:25:26 +00:00
You also need [Node.js ](https://nodejs.org/ ) and [npm ](https://www.npmjs.com/ )
2019-10-17 12:38:09 +00:00
installed in order to build the frontend assets.
2015-04-10 11:53:32 +00:00
2015-09-17 16:20:38 +00:00
You can directly use the `go` tool to download and install the `prometheus`
2017-10-12 22:15:29 +00:00
and `promtool` binaries into your `GOPATH` :
2013-04-14 04:59:55 +00:00
2021-08-27 09:08:21 +00:00
$ GO111MODULE=on go install github.com/prometheus/prometheus/cmd/...
2017-08-08 07:19:35 +00:00
$ prometheus --config.file=your_config.yml
2013-04-14 04:59:55 +00:00
2021-08-27 09:08:21 +00:00
*However*, when using `go install` to build Prometheus, Prometheus will expect to be able to
2019-10-17 12:38:09 +00:00
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` .
2021-02-22 19:19:08 +00:00
An example of the above configuration file can be found [here. ](https://github.com/prometheus/prometheus/blob/main/documentation/examples/prometheus.yml )
2019-11-09 08:48:09 +00:00
2019-10-17 12:38:09 +00:00
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:
2013-04-14 04:59:55 +00:00
2015-09-17 16:20:38 +00:00
$ mkdir -p $GOPATH/src/github.com/prometheus
$ cd $GOPATH/src/github.com/prometheus
$ git clone https://github.com/prometheus/prometheus.git
$ cd prometheus
2016-02-05 10:30:31 +00:00
$ make build
2017-08-08 07:19:35 +00:00
$ ./prometheus --config.file=your_config.yml
2013-04-14 04:59:55 +00:00
2015-09-18 07:34:17 +00:00
The Makefile provides several targets:
2013-04-14 04:59:55 +00:00
2019-10-17 12:38:09 +00:00
* *build*: build the `prometheus` and `promtool` binaries (includes building and compiling in web assets)
2015-09-17 16:20:38 +00:00
* *test*: run the tests
2017-04-07 11:46:06 +00:00
* *test-short*: run the short tests
2015-09-17 16:20:38 +00:00
* *format*: format the source code
* *vet*: check the source code for common errors
2020-09-16 13:01:48 +00:00
* *assets*: build the new experimental React UI
2013-06-13 13:17:03 +00:00
2021-02-09 14:50:36 +00:00
### Building the Docker image
The `make docker` target is designed for use in our CI system.
You can build a docker image locally with the following commands:
$ make promu
$ promu crossbuild -p linux/amd64
2021-06-15 21:16:21 +00:00
$ make npm_licenses
2021-02-09 14:50:36 +00:00
$ make common-docker-amd64
*NB* if you are on a Mac, you will need [gnu-tar ](https://formulae.brew.sh/formula/gnu-tar ).
2019-11-14 18:53:10 +00:00
## React UI Development
2021-02-22 19:19:08 +00:00
For more information on building, running, and developing on the new React-based UI, see the React app's [README.md ](web/ui/react-app/README.md ).
2019-11-14 18:53:10 +00:00
2014-11-21 12:27:28 +00:00
## More information
2013-05-06 08:54:27 +00:00
2021-06-17 11:18:51 +00:00
* The source code is periodically indexed: [Prometheus Core ](https://pkg.go.dev/github.com/prometheus/prometheus ).
2020-10-21 07:37:18 +00:00
* You will find a CircleCI configuration in [`.circleci/config.yml` ](.circleci/config.yml ).
2016-11-10 06:45:09 +00:00
* See the [Community page ](https://prometheus.io/community ) for how to reach the Prometheus developers and users on various communication channels.
2013-03-28 14:54:40 +00:00
2013-04-14 04:59:55 +00:00
## Contributing
2021-02-22 19:19:08 +00:00
Refer to [CONTRIBUTING.md ](https://github.com/prometheus/prometheus/blob/main/CONTRIBUTING.md )
2013-04-14 04:59:55 +00:00
2013-01-24 20:56:08 +00:00
## License
2012-11-26 19:11:34 +00:00
2021-02-22 19:19:08 +00:00
Apache License 2.0, see [LICENSE ](https://github.com/prometheus/prometheus/blob/main/LICENSE ).
2015-12-21 17:09:38 +00:00
[hub]: https://hub.docker.com/r/prom/prometheus/
[circleci]: https://circleci.com/gh/prometheus/prometheus
2016-04-26 15:23:41 +00:00
[quay]: https://quay.io/repository/prometheus/prometheus
