You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dipack P Panjabi e2dd5b61ef Added CreateBlock and CreateHead functions to new file (#6331) 11 hours ago
.circleci .circleci/config.yml: cache dependencies (#6181) 4 weeks ago
.github disable github actions (#6207) 4 weeks ago
cmd remove unwanted break (#6338) 2 days ago
config config: add test case for scrape interval larger than timeout. (#6037) 1 month ago
console_libraries Added humanizePercentage formatting to templates (#5670) 5 months ago
consoles Update console template example metric names. (#5678) 5 months ago
discovery As per dev summit, SD moratorium has been lifted. (#6324) 23 hours ago
docs Fix small typo in docs (#6345) 1 day ago
documentation Simplify remote write dashboard in mixin. 2 days ago
notifier notifier: return nil is better. (#5958) 2 months ago
pkg Add exemplar support to the openmetrics parser (#6292) 2 days ago
prompb remote-read: streamed chunked server side; Extended protobuf; Added chunked, checksumed reader (#5703) 3 months ago
promql fixes space issue in duration range promql (#6295) 1 week ago
rules *: improve error messages when parsing bad rules (#5965) 2 months ago
scrape React UI: Implement /targets page (#6276) 1 week ago
scripts React UI: Serve React UI under /new (#6229) 3 weeks ago
storage Port tsdb to use pkg/labels. (#6326) 3 days ago
template template: remove redundant parentheses. (#5904) 3 months ago
tsdb Added CreateBlock and CreateHead functions to new file (#6331) 11 hours ago
util Compute WAL size and use it during retention size checks (#5886) 1 week ago
vendor clean up indirects in go.mod manifest (#6249) 3 weeks ago
web React UI: Add /tsdb-status to React-handled routes (#6313) 1 day ago
.dockerignore Docker images for ARM32v7 and ARM64v8 (#5031) 7 months ago
.gitignore Add tsdb/tsdb to .gitignore 6 days ago
.golangci.yml *: enable all default linters (#5504) 6 months ago
.promu.yml Integrate beginning of React UI (#5694) 1 month ago
.travis.yml Integrate beginning of React UI (#5694) 1 month ago
CHANGELOG.md Cut 2.14.0 release (#6298) 1 week ago
CONTRIBUTING.md *: bump Go version to 1.13 (#6020) 2 months ago
Dockerfile Integrate beginning of React UI (#5694) 1 month ago
LICENSE Clean up license issues. 4 years ago
MAINTAINERS.md Step down and propose Ganesh as TSDB maintainer 1 month ago
Makefile Add unit tests for react-app (#6234) 3 weeks ago
Makefile.common Bump golangci-lint to v1.18.0 (#6004) 2 months ago
NOTICE Integrate beginning of React UI (#5694) 1 month ago
README.md React UI: Add better docs for the React UI (#6315) 1 week ago
RELEASE.md Clarify the branch in preparing the release (#6122) 1 month ago
VERSION Cut 2.14.0 release (#6298) 1 week ago
code-of-conduct.md Add CNCF code of conduct as the Prometheus code of conduct 3 years ago
fuzzit.sh Fix fuzzit job (#6005) 2 months ago
go.mod clean up indirects in go.mod manifest (#6249) 3 weeks ago
go.sum clean up indirects in go.mod manifest (#6249) 3 weeks ago

README.md

Prometheus

Build Status CircleCI Docker Repository on Quay Docker Pulls Go Report Card CII Best Practices fuzzit

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 if some condition is observed to be true.

Prometheus’s main distinguishing features as compared to other monitoring systems are:

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

Debian packages are available.

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 the source code yourself you need to have a working Go environment with version 1.13 or greater installed. You will also need to have 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

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

  • The source code is periodically indexed: Prometheus Core.
  • You will find a Travis CI configuration in .travis.yml.
  • See the Community page for how to reach the Prometheus developers and users on various communication channels.

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.