Go to file
Brian Brazil 5caa70ee28 Merge pull request #1138 from prometheus/brian-brazil-patch-1
Mention hactoberfest
2015-10-02 17:09:09 +01:00
cmd Rename global "labels" config option to "external_labels". 2015-09-29 20:54:20 +02:00
config Rename global "labels" config option to "external_labels". 2015-09-29 20:54:20 +02:00
console_libraries Add console template for Prometheus itself 2015-08-07 16:34:48 +01:00
consoles Rename label 'filesystem'->'mountpoint' in node-cpu console. 2015-09-30 17:25:59 +02:00
documentation Add Kubernetes namespace & name labels to example config 2015-09-29 12:55:15 +01:00
notification Rename global "labels" config option to "external_labels". 2015-09-29 20:54:20 +02:00
promql promql: Reduce flakiness of concurrency test 2015-09-23 10:07:30 +01:00
retrieval Kubernetes SD example: separate out cluster level components & services 2015-09-29 11:22:18 +01:00
rules Fix unkeyed field errors. 2015-09-18 17:00:08 +02:00
scripts Fix missing go version in build tags 2015-09-18 10:38:26 +02:00
storage Rename global "labels" config option to "external_labels". 2015-09-29 20:54:20 +02:00
template Fix some dead code, missing error checks, shadowings. 2015-09-14 12:21:34 +02:00
util Switch to common/route package 2015-09-24 17:08:47 +02:00
vendor Switch to common/route package 2015-09-24 17:08:47 +02:00
version Cut release 0.16.0rc2 2015-09-30 16:28:25 +02:00
web HTML-escape string return values in web UI. 2015-10-01 13:21:39 +02:00
.dockerignore Add service discovery using Marathon API. 2015-08-10 01:36:24 +02:00
.gitignore Replace Makefile with simpler setup 2015-09-17 17:26:36 +02:00
.travis.yml Bump travis go version 2015-09-17 17:09:01 +02:00
AUTHORS.md Change mail address 2015-09-07 15:12:42 +02:00
CHANGELOG.md Add missing 'g' 2015-09-30 16:40:29 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md. 2015-01-22 15:07:20 +01:00
Dockerfile Add goenv script and fix Docker 2015-09-18 10:28:15 +02:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
Makefile Fix phony targets and log asset generation 2015-09-19 11:51:40 +02:00
NOTICE Add support for Zookeeper Serversets for SD. 2015-06-16 11:02:08 +01:00
README.md Mention Hacktoberfest 2015-10-02 17:08:11 +01:00
circle.yml Add circleci yaml for Dockerfile test build 2015-06-26 11:00:15 +02:00

README.md

Prometheus Build Status Circle CI

Prometheus 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
  • federation support coming soon

Hacktoberfest 2015

Prometheus is a featured project in DigitalOcean's Hacktoberfest. We have prepared a list of potential projects to get you started.

Architecture overview

Install

There are various ways of installing Prometheus.

Precompiled binaries

Precompiled binaries for released versions are available in the releases section of the GitHub repository. Using the latest production release binary is the recommended way of installing Prometheus.

Debian and RPM packages are being worked on.

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:

$ go get github.com/prometheus/prometheus/...
$ 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
$ ./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.
  • All of the core developers are accessible via the Prometheus Developers Mailinglist and the #prometheus channel on irc.freenode.net.

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.