Go to file
Krasi Georgiev 406233e937
Merge pull request #4034 from si74/main_comments
main: actor functionality comments
2018-04-03 12:52:15 +03:00
.github Update command line flags in issue template (#3317) 2017-10-19 13:59:00 +01:00
cmd main: actor functionality comments 2018-04-01 11:19:30 -07:00
config discovery/ec2: Support filtering instances in discovery (#4011) 2018-03-31 07:51:11 +01:00
console_libraries Cut down console template examples to just node and prometheus (#3099) 2017-08-21 16:35:20 +01:00
consoles Fix rendering issues with console templates. (#3744) 2018-01-29 10:38:39 +00:00
discovery Add a machine type label to GCE SD (#4032) 2018-03-31 09:20:19 +01:00
docs Add a machine type label to GCE SD (#4032) 2018-03-31 09:20:19 +01:00
documentation minor yaml indentation consistency fix in example configs (#3946) 2018-03-11 23:06:13 +00:00
notifier notifier: update use testutil for testing (#3695) 2018-03-29 16:07:26 +01:00
pkg Merge pull request #3835 from krasi-georgiev/pool-package-generalize 2018-02-28 14:30:46 +01:00
prompb api: add flag to skip head on snapshots 2018-03-08 13:07:12 +01:00
promql Parser test cleanup (#3977) 2018-03-20 14:30:52 +00:00
relabel Rewrote tests for relabel and template (#3754) 2018-03-29 16:02:28 +01:00
rules Add an OpenTracing span for each rule (#4027) 2018-03-30 21:29:19 +01:00
scrape Merge pull request #3968 from zjwzte/fix-magic-number 2018-03-28 14:09:43 +02:00
scripts revert ot using the gogofast plugin and regenerate grpc server 2018-03-01 11:57:31 +02:00
storage all: remove unnecessary type conversions (#3992) 2018-03-21 09:25:22 +00:00
template Rewrote tests for relabel and template (#3754) 2018-03-29 16:02:28 +01:00
util General simplifications (#3887) 2018-02-26 07:58:10 +00:00
vendor update common package (#4015) 2018-03-27 10:21:56 +05:30
web simplify server error handling (#4006) 2018-03-25 10:05:59 +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 Check for unused vendored packages (#3892) 2018-03-02 10:20:45 +00:00
CHANGELOG.md *: cut v2.2.0 2018-03-08 15:37:46 +01:00
CONTRIBUTING.md Add section for new contributors 2017-07-27 16:53:34 +05:30
Dockerfile Fix command line flags in Dockerfile 2017-07-13 12:14:49 +02:00
LICENSE
MAINTAINERS.md Remove _local storage_ from fabxc's responsibilities again 2017-11-03 12:52:24 +01:00
Makefile web: replace deprecated InstrumentHandler() (#3862) 2018-03-21 08:16:16 +00: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 *: cut v2.2.0 2018-03-08 15:37:46 +01:00
circle.yml bump to golang 1.10 (#3856) 2018-02-26 09:42:49 +00: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.