The Prometheus monitoring system and time series database.
 
 
 
 
 
 
Go to file
Anthony D'Atri 2cbc0f9bfe
Various doc tweaks (#8111)
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-27 09:50:37 +00:00
.circleci .circleci/config.yml: check mixins (#6895) 2020-08-25 15:59:41 +02:00
.github Update prombench workflows to incorporate new naming convention 2020-08-24 01:04:19 +05:30
cmd promtool: Calculate mint and maxt per test (#8096) 2020-10-24 12:03:55 +01:00
config Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
console_libraries Update various UI components (#7807) 2020-08-15 22:31:30 +02:00
consoles Update console template example metric names. (#5678) 2019-06-17 12:13:29 +01:00
discovery Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
docs Various doc tweaks (#8111) 2020-10-27 09:50:37 +00:00
documentation add networking.k8s.io for ingress (#8091) 2020-10-22 15:08:12 -06:00
notifier Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
pkg Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
prompb web: Remove APIv2 (#7935) 2020-09-15 09:30:55 +02:00
promql Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
rules Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
scrape More granular locking for scrapeLoop. (#8104) 2020-10-26 14:46:20 +00:00
scripts web: Remove APIv2 (#7935) 2020-09-15 09:30:55 +02:00
storage Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
template Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
tsdb Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
util Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
vendor Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
web react updates for pathPrefix (#7979) 2020-10-22 17:22:32 +02:00
.dockerignore Add image build for ppc64le architecture 2020-04-06 18:03:58 -03:00
.gitignore add tsdb cmds into promtool (#6088) 2020-07-23 19:35:50 +01:00
.gitpod.yml Gitpod config (#7749) 2020-08-14 17:23:55 +02:00
.golangci.yml golangci: Use depguard to prevent using restricted packages (#7825) 2020-08-21 11:37:21 +02:00
.promu.yml Update to go 1.15 (#7798) 2020-08-15 23:49:11 +02:00
CHANGELOG.md *: Cut v2.22.0-rc.0 2020-10-08 13:52:40 +02:00
CODE_OF_CONDUCT.md Improve repo sync script 2020-06-17 17:12:36 +02:00
CONTRIBUTING.md Gitpod config (#7749) 2020-08-14 17:23:55 +02:00
Dockerfile Integrate beginning of React UI (#5694) 2019-10-17 14:38:09 +02:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md Add Bartek as maintainer for TSDB (#7690) 2020-07-29 20:25:14 +05:30
Makefile Merge pull request #7067 from carlosedp/ppc64le 2020-08-05 18:16:59 +02:00
Makefile.common Add major version tag (#8026) 2020-10-22 17:19:44 +02:00
NOTICE Update NOTICE for the XORChunk (#7415) 2020-06-18 15:12:35 +05:30
README.md Various doc tweaks (#8111) 2020-10-27 09:50:37 +00:00
RELEASE.md Reflect automatic docs publishing in the release process (#8056) 2020-10-15 11:06:42 +02:00
VERSION *: Cut v2.22.0-rc.0 2020-10-08 13:52:40 +02:00
fuzzit.sh Fix fuzzit job (#6005) 2019-09-11 09:08:20 +02:00
go.mod Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00
go.sum Move away from testutil, refactor imports (#8087) 2020-10-22 11:00:08 +02:00

README.md

Prometheus

CircleCI Docker Repository on Quay Docker Pulls Go Report Card CII Best Practices fuzzit Gitpod ready-to-code

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:

  • A multi-dimensional data model (time series defined by metric name and set of key/value dimensions)
  • PromQL, a powerful and flexible query language to leverage this dimensionality
  • 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

Architecture overview

Install

There are various ways of installing Prometheus.

Precompiled binaries

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.

Docker images

Docker images are available on Quay.io or Docker Hub.

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/.

Building from source

To build Prometheus from source code, first ensure that have a working Go environment with version 1.13 or greater installed. You also need Node.js and Yarn installed in order to build the frontend assets.

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

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

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.

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:

  • build: build the prometheus and promtool binaries (includes building and compiling in web assets)
  • test: run the tests
  • test-short: run the short tests
  • format: format the source code
  • vet: check the source code for common errors
  • docker: build a docker container for the current HEAD
  • assets: build the new experimental React UI

React UI Development

For more information on building, running, and developing on the new React-based UI, see the React app's README.md.

More information

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.