The Prometheus monitoring system and time series database.
Find a file
beorn7 04ccf84559 main.go: Set GOGC to 40 by default
Rationale: The default value for GOGC is 100, i.e. a garbage collected
is initialized once as many heap space has been allocated as was in
use after the last GC was done. This ratio doesn't make a lot of sense
in Prometheus, as typically about 60% of the heap is allocated for
long-lived memory chunks (most of which are around for many hours if
not days). Thus, short-lived heap objects are accumulated for quite
some time until they finally match the large amount of memory used by
bulk memory chunks and a gigantic GC cyle is invoked. With GOGC=40, we
are essentially reinstating "normal" GC behavior by acknowledging that
about 60% of the heap are used for long-term bulk storage.

The median Prometheus production server at SoundCloud runs a GC cycle
every 90 seconds. With GOGC=40, a GC cycle is run every 35 seconds
(which is still not very often). However, the effective RAM usage is
now reduced by about 30%. If settings are updated to utilize more RAM,
the time between GC cycles goes up again (as the heap size is larger
with more long-lived memory chunks, but the frequency of creating
short-lived heap objects does not change). On a quite busy large
Prometheus server, the timing changed from one GC run every 20s to one
GC run every 12s.

In the former case (just changing GOGC, leave everything else as it
is), the CPU usage increases by about 10% (on a mid-size referenc
server from 8.1 to 8.9). If settings are adjusted, the CPU
consumptions increases more drastically (from 8 cores to 13 cores on a
large reference server), despite GCs happening more rarely, presumably
because a 50% larger set of memory chunks is managed now. Having more
memory chunks is good in many regards, and most servers are running
out of memory long before they run out of CPU cycles, so the tradeoff
is overwhelmingly positive in most cases.

Power users can still set the GOGC environment variable as usual, as
the implementation in this commit honors an explicitly set variable.
2017-03-26 21:55:37 +02:00
.github .github: Add issue template 2016-06-06 11:48:14 +02:00
cmd main.go: Set GOGC to 40 by default 2017-03-26 21:55:37 +02:00
config Merge pull request #2479 from YKlausz/consul-tls 2017-03-20 11:40:18 +01:00
console_libraries Adding version to names of static files 2017-03-03 23:36:06 +03:00
consoles Add various persistence related metrics (#2333) 2017-01-11 15:11:19 +00:00
discovery Merge pull request #2479 from YKlausz/consul-tls 2017-03-20 11:40:18 +01:00
documentation Remove PromDash from architecture diagram 2017-03-23 13:11:05 +01:00
notifier notifier: Allow swapping out HTTP Doer 2017-02-27 20:36:22 +01:00
promql Comments and Typo Fixes 2017-03-06 17:16:37 +05:30
relabel Stricter Relabel Config Checking for Labeldrop/keep (#2510) 2017-03-18 22:32:08 +01:00
retrieval Setting User-Agent header (#2447) 2017-02-28 09:59:33 -04:00
rules rules: update annotations on each iteration 2016-11-22 15:43:07 +01:00
scripts New release process using docker, circleci and a centralized 2016-04-18 22:41:04 +02:00
storage Merge pull request #2494 from tomwilkie/remote-write-sharding 2017-03-20 12:45:17 +01:00
template storage: Contextify storage interfaces. 2016-09-19 16:29:07 +02:00
util Prevent deadlock in ZK TreeCache constructor by deferring the initial sync. 2017-03-03 23:58:46 +01:00
vendor Limit 'discarding sample' logs to 1 every 10s (#2446) 2017-02-23 19:20:39 +01:00
web Don't truncate build version 2017-03-19 18:37:23 +01:00
.codeclimate.yml Update .codeclimate.yml 2017-01-23 14:58:53 -05:00
.dockerignore New release process using docker, circleci and a centralized 2016-04-18 22:41:04 +02:00
.gitignore gitignore: clean up 2016-07-04 11:34:33 +02:00
.promu.yml promu: Use default Go version again 2016-10-11 11:42:05 +02:00
.travis.yml build: Use Go1.7.4 in Travis 2017-02-10 13:05:32 +01:00
CHANGELOG.md Cut v1.5.2 2017-02-10 13:57:11 +01:00
circle.yml circle: update golang-builder image version 2016-11-25 14:29:07 +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
CONTRIBUTING.md Replace AUTHORS.md by an updated MAINTAINERS.md 2017-02-20 11:45:22 +01:00
Dockerfile Docker: Move console dirs to /usr/share/prometheus 2016-07-29 14:00:47 +01:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md Replace AUTHORS.md by an updated MAINTAINERS.md 2017-02-20 11:45:22 +01:00
Makefile Use go env to fetch GOPATH to support Go 1.8 2017-03-22 19:04:20 +01:00
NOTICE Replace handlebars with the simpler and saner mustache library. 2016-11-17 02:33:12 +00:00
README.md Update architecture diagram link 2017-03-23 13:16:54 +01:00
VERSION Cut v1.5.2 2017-02-10 13:57:11 +01:00

Prometheus Build Status

CircleCI Docker Repository on Quay Docker Pulls Go Report Card Code Climate Issue Count

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.5 or greater installed.

You can directly use the go tool to download and install the prometheus and promtool binaries into your GOPATH. We use Go 1.5's experimental vendoring feature, so you will also need to set the GO15VENDOREXPERIMENT=1 environment variable in this case:

$ GO15VENDOREXPERIMENT=1 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
  • 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.