The Prometheus monitoring system and time series database.
Visit prometheus.io for the full documentation, examples and guides.
Prometheus, a Cloud Native Computing Foundation project, is a systems and service monitoring system. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are observed.
The features that distinguish Prometheus from other metrics and monitoring systems are:
There are various ways of installing Prometheus.
Precompiled binaries for released versions are available in the download section on prometheus.io. Using the latest production release binary is the recommended way of installing Prometheus. See the Installing chapter in the documentation for all the details.
You can launch a Prometheus container for trying it out with
$ docker run --name prometheus -d -p 127.0.0.1:9090:9090 prom/prometheus
Prometheus will now be reachable at http://localhost:9090/.
To build Prometheus from source code, first ensure that have a working Go environment with version 1.14 or greater installed. You also need Node.js and Yarn installed in order to build the frontend assets.
You can directly use the
gotool to download and install the
promtoolbinaries into your
$ GO111MODULE=on go get github.com/prometheus/prometheus/cmd/... $ prometheus --config.file=your_config.yml
However, when using
go getto build Prometheus, Prometheus will expect to be able to read its web assets from local filesystem directories under
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
An example of the above configuration file can be found here.
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:
$ mkdir -p $GOPATH/src/github.com/prometheus $ cd $GOPATH/src/github.com/prometheus $ git clone https://github.com/prometheus/prometheus.git $ cd prometheus $ make build $ ./prometheus --config.file=your_config.yml
The Makefile provides several targets:
promtoolbinaries (includes building and compiling in web assets)
make dockertarget 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 $ make npm_licenses $ make common-docker-amd64
NB if you are on a Mac, you will need gnu-tar.
For more information on building, running, and developing on the new React-based UI, see the React app's README.md.
Refer to CONTRIBUTING.md
Apache License 2.0, see LICENSE.