Go to file
Frederic Branczyk 3287b9a4b8
Merge pull request #4579 from bwplotka/ensure-genproto-works
proto: Allow reproducible proto generation.
2018-11-06 15:46:56 +01:00
.circleci *: move to go 1.11 (#4626) 2018-10-16 09:41:45 +02:00
.github Fix quoting in issue template (#4688) 2018-10-02 14:52:57 +02:00
cmd discovery: add config label to discovered targets metric (#4753) 2018-10-18 16:46:59 +01:00
config discovery/openstack: support tls_config 2018-09-25 14:31:32 +02: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 __meta_kubernetes_pod_phase label in discovery (#4824) 2018-11-06 14:40:24 +00:00
docs Add __meta_kubernetes_pod_phase label in discovery (#4824) 2018-11-06 14:40:24 +00:00
documentation documentation - add marathon-sd example configuration 2018-10-25 18:02:59 +02:00
notifier change time.duration to model.duration for standardization (#4479) 2018-08-24 16:55:21 +02:00
pkg Expand OM to OpenMetrics 2018-10-18 14:16:41 +01:00
prompb Merge pull request #4579 from bwplotka/ensure-genproto-works 2018-11-06 15:46:56 +01:00
promql Allow promql benchmarks to query more samples (#4770) 2018-10-22 18:02:22 +01:00
relabel Rewrote tests for relabel and template (#3754) 2018-03-29 16:02:28 +01:00
rules Updates to /targets and /rules (scrape duration, last evaluation time) (#4722) 2018-10-12 18:26:59 +02:00
scrape Hook OpenMetrics parser into scraping. 2018-10-18 13:58:00 +01:00
scripts proto: Allow reproducible proto generation. 2018-10-05 10:22:02 +01:00
storage Adding new metric type to track in-flight remote read queries. (#4677) 2018-10-10 14:48:32 -07:00
template add alert template expanding failure metric (#4747) 2018-11-06 14:39:06 +00:00
util Adding unit tests for the util package (#4534) 2018-08-27 15:55:49 +01:00
vendor update tsdb (#4692) 2018-10-08 18:26:53 +03:00
web web: display job label in targets page 2018-10-30 16:20:43 +01:00
.dockerignore
.gitignore cleanup gitignore (#3869) 2018-02-20 11:03:22 +00:00
.promu.yml *: move to go 1.11 (#4626) 2018-10-16 09:41:45 +02:00
.travis.yml *: move to go 1.11 (#4626) 2018-10-16 09:41:45 +02:00
CHANGELOG.md *: Cut v2.5.0 2018-11-06 09:20:09 +01:00
CONTRIBUTING.md Mention the DCO (#4211) 2018-06-01 14:15:12 +01:00
Dockerfile Fix Dockerfile label syntax 2018-08-26 19:43:53 -07:00
LICENSE
MAINTAINERS.md Remove _local storage_ from fabxc's responsibilities again 2017-11-03 12:52:24 +01:00
Makefile Expand OM to OpenMetrics 2018-10-18 14:16:41 +01:00
Makefile.common proto: Allow reproducible proto generation. 2018-10-05 10:22:02 +01:00
NOTICE Update NOTICE for gogo/protobuf 2017-11-02 15:28:47 +01:00
README.md Switching from rawgit to jsdelivr (#4733) (#4737) 2018-10-13 13:20:29 +01:00
VERSION *: Cut v2.5.0 2018-11-06 09:20:09 +01:00
code-of-conduct.md

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.