The Prometheus monitoring system and time series database.
 
 
 
 
 
 
Go to file
Ben Kochie c6399296dc
Fix spelling/typos (#4921)
* Fix spelling/typos

Fix spelling/typos reported by codespell/misspell.
* UK -> US spelling changes.

Signed-off-by: Ben Kochie <superq@gmail.com>
2018-11-27 17:44:29 +01:00
.circleci Merge branch 'master' into go-modules 2018-11-09 11:42:12 +01:00
.github Fix quoting in issue template (#4688) 2018-10-02 14:52:57 +02:00
cmd collect cpu and trace profiles with the promtool debug command (#4897) 2018-11-23 17:57:31 +02:00
config Fix spelling/typos (#4921) 2018-11-27 17:44:29 +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 Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
docs Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
documentation Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
notifier Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
pkg Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
prompb Merge pull request #4579 from bwplotka/ensure-genproto-works 2018-11-06 15:46:56 +01:00
promql Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
relabel Rewrote tests for relabel and template (#3754) 2018-03-29 16:02:28 +01:00
rules Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
scrape Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
scripts proto: Allow reproducible proto generation. 2018-10-05 10:22:02 +01:00
storage Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
template add alert template expanding failure metric (#4747) 2018-11-06 14:39:06 +00:00
util go get honnef.co/go/tools/cmd/staticcheck in a temp dir 2018-10-29 17:25:43 +01:00
vendor update promlog to latest version (#4876) 2018-11-23 14:22:40 +01:00
web Fix spelling/typos (#4921) 2018-11-27 17:44:29 +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 *: support for Go modules 2018-10-29 17:25:43 +01:00
.travis.yml Merge branch 'master' into go-modules 2018-11-09 11:42:12 +01:00
CHANGELOG.md Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
CONTRIBUTING.md Fix spelling/typos (#4921) 2018-11-27 17:44:29 +01:00
Dockerfile Included default flags into Dockerfile entrypoint (#4796) 2018-11-16 09:17:32 +01: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 *: fix assets generation 2018-11-12 10:38:29 +01:00
Makefile.common Fix .PHONE -> .PHONY typo in Makefile.common (#4886) 2018-11-20 17:17:48 +08:00
NOTICE Update NOTICE for gogo/protobuf 2017-11-02 15:28:47 +01:00
README.md Migrate all Docker image references to Docker Hub (#4864) 2018-11-16 11:26:10 +00:00
RELEASE.md Add RELEASE.md 2018-11-06 15:47:26 +01:00
VERSION *: Cut v2.5.0 2018-11-06 09:20:09 +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
go.mod update promlog to latest version (#4876) 2018-11-23 14:22:40 +01:00
go.sum update promlog to latest version (#4876) 2018-11-23 14:22:40 +01: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 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.11 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.