Go to file
Ben Kochie 709ad10d97
Reduce CircleCI duplication (#4335)
Reduce the duplication of per-project specifics in the CircleCI config.
* Add docker repo variable, default to docker hub.
* Add make targets for docker push and tag latest.

Signed-off-by: Ben Kochie <superq@gmail.com>
2018-07-04 11:27:10 +02:00
.circleci Reduce CircleCI duplication (#4335) 2018-07-04 11:27:10 +02:00
.github request a use case for proposals 2018-04-11 13:47:48 +03:00
cmd return error exit status in prometheus cli (#4296) 2018-06-21 08:32:26 +01:00
config config: set target group source index during unmarshalling (#4245) 2018-06-13 16:34:59 +01:00
console_libraries Cut down console template examples to just node and prometheus (#3099) 2017-08-21 16:35:20 +01:00
consoles Update example console template for node exporter 0.16.0 (#4208) 2018-06-08 14:01:05 +01:00
discovery Add "omitempty" to some SD config YAML field tags (#4338) 2018-07-03 13:43:41 +02:00
docs Address comments 2018-06-06 11:21:17 -04:00
documentation fix minor issues in custom SD example (#4278) 2018-06-18 16:08:02 +01:00
notifier Fix spelling mistakes found by codespell (#4065) 2018-04-27 13:04:02 +01:00
pkg pkg/textparse: unescape help string 2018-06-06 05:56:10 -04:00
prompb Add prompb/README (#4222) 2018-06-11 22:00:33 +01:00
promql Check for timeout in each iteration of matrixSelector (#4300) 2018-06-21 22:43:31 +01:00
relabel Rewrote tests for relabel and template (#3754) 2018-03-29 16:02:28 +01:00
rules Make TestUpdate() do some work (#4306) 2018-06-22 15:21:04 +01:00
scrape Address comments 2018-06-06 11:21:17 -04:00
scripts use the Makefile.common (#3978) 2018-04-19 12:07:10 +03:00
storage Merge pull request #4285 from prometheus/release-2.3 2018-06-20 14:51:00 +01:00
template Rewrote tests for relabel and template (#3754) 2018-03-29 16:02:28 +01:00
util Optimise PromQL (#3966) 2018-06-04 15:47:45 +02:00
vendor vendour: update prometheus/tsdb 2018-06-05 05:33:04 -04:00
web spelling. 2018-06-18 17:32:44 +01:00
.dockerignore New release process using docker, circleci and a centralized 2016-04-18 22:41:04 +02:00
.gitignore cleanup gitignore (#3869) 2018-02-20 11:03:22 +00:00
.promu.yml promu: Use default Go version again 2016-10-11 11:42:05 +02:00
.travis.yml travis: remove testing with go 1.x 2018-07-03 09:30:28 +02:00
CHANGELOG.md Release 2.3.1 2018-06-19 13:12:11 +01:00
CONTRIBUTING.md Mention the DCO (#4211) 2018-06-01 14:15:12 +01:00
Dockerfile Fix command line flags in Dockerfile 2017-07-13 12:14:49 +02:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md Remove _local storage_ from fabxc's responsibilities again 2017-11-03 12:52:24 +01:00
Makefile Makefile: update .PHONY target (#4234) 2018-06-11 17:51:28 +02:00
Makefile.common Reduce CircleCI duplication (#4335) 2018-07-04 11:27:10 +02:00
NOTICE Update NOTICE for gogo/protobuf 2017-11-02 15:28:47 +01:00
README.md bump to golang 1.10 (#3856) 2018-02-26 09:42:49 +00:00
VERSION Release 2.3.1 2018-06-19 13:12:11 +01:00
code-of-conduct.md Add CNCF code of conduct as the Prometheus code of conduct 2016-10-19 21:39:19 +02:00

README.md

Prometheus Build Status

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

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

You can launch a Prometheus container for trying it out with

$ docker run --name prometheus -d -p 127.0.0.1:9090:9090 quay.io/prometheus/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.10 or greater installed.

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

You can also clone the repository yourself and build using make:

$ 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
  • test: run the tests
  • test-short: run the short tests
  • format: format the source code
  • vet: check the source code for common errors
  • assets: rebuild the static assets
  • docker: build a docker container for the current HEAD

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.