The Prometheus monitoring system and time series database.
Find a file
beorn7 ad9b4c2b68 Fix typos
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-18 15:44:13 +02:00
.circleci Add sync_codemirror (#9379) 2021-09-24 15:54:25 +02:00
.github Add Jessica as Promtool maintainer (#9348) 2021-09-17 01:10:32 +02:00
cmd Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
config config: fix puppetdb tests 2021-09-16 18:31:28 +02:00
console_libraries Make React UI the default, keep old UI under /classic (#8142) 2020-11-03 14:51:48 +01:00
consoles Cleaned up a little bit of HTML 2021-07-28 20:12:06 -04:00
discovery Cut v2.30.1 (#9402) 2021-09-28 14:24:43 +05:30
docs fix/9269 add documentation for endpointslice 2021-10-03 21:30:39 +02:00
documentation Add PuppetDB service discovery 2021-09-16 16:54:26 +02:00
model/histogram Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
notifier Enable HTTP2 again (#9398) 2021-09-26 23:16:12 +02:00
pkg Merge branch 'main' into sparsehistogram 2021-10-12 15:30:20 +02:00
prompb Add metrics.proto to other protobuf code (#8996) 2021-06-28 11:16:06 +01:00
promql Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
rules Limit number of alerts or series produced by a rule (#9260) 2021-09-15 09:48:26 +02:00
scrape Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
scripts Merge branch 'main' into sparsehistogram 2021-10-07 23:16:42 +02:00
storage Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
template Support customization of template options in TemplateExpander (#9290) 2021-09-13 17:19:08 +05:30
tsdb Fix typos 2021-10-18 15:44:13 +02:00
util tests: Move from t.Errorf and others. (Part 2) (#9309) 2021-09-13 21:19:20 +02:00
web Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
.dockerignore Add image build for ppc64le architecture 2020-04-06 18:03:58 -03:00
.gitignore move to npm workspace 2021-09-10 15:38:20 +02:00
.gitpod.Dockerfile add gitpod dockerfile to upgrade node and npm version 2021-09-27 18:59:41 +02:00
.gitpod.yml fix gitpod by using custome dockerfile and accurate npm ui path 2021-09-27 18:59:41 +02:00
.golangci.yml fixes yamllint errors 2021-06-12 12:47:47 +02:00
.promu.yml Build with Go 1.17 2021-08-27 00:32:49 +02:00
.yamllint Switch golangci-lint to GitHub Actions (#9232) 2021-09-10 16:30:18 +02:00
CHANGELOG.md Cut v2.30.3 (#9446) 2021-10-05 20:31:30 +05:30
CODE_OF_CONDUCT.md Improve repo sync script 2020-06-17 17:12:36 +02:00
CONTRIBUTING.md Change channel to prometheus-dev 2021-09-09 08:13:57 -04:00
Dockerfile Dockerfile: Optimize and consolidate steps (#9180) 2021-09-30 11:13:44 +02:00
go.mod Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
go.sum Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md Fix Levi's name in MAINTAINERS.md (#9491) 2021-10-12 02:05:22 +02:00
Makefile fix license tarball 2021-09-10 17:38:53 +02:00
Makefile.common Switch golangci-lint to GitHub Actions (#9232) 2021-09-10 16:30:18 +02:00
NOTICE Add new codemirror-promql-based expression editor (#8634) 2021-03-23 23:55:52 +01:00
README.md Typo fixes 2021-09-17 15:48:02 -07:00
RELEASE.md Volunteer @roidelapluie and @juliusv as upcoming release shepherds 2021-10-11 17:14:32 +02:00
SECURITY.md Add SECURITY.md file (#8292) 2021-01-09 09:58:53 +01:00
VERSION Cut v2.30.3 (#9446) 2021-10-05 20:31:30 +05:30

Prometheus

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

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 you have a working Go environment with version 1.14 or greater installed. You also need Node.js and npm 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:

$ GO111MODULE=on go install github.com/prometheus/prometheus/cmd/...
$ prometheus --config.file=your_config.yml

However, when using go install 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
  • assets: build the new experimental React UI

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
$ make npm_licenses
$ make common-docker-amd64

NB if you are on a Mac, you will need gnu-tar.

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.