The Prometheus monitoring system and time series database.
Find a file
Jason Anderson 808f79f00a Feature: Allow getting credentials via EC2 role (#3343)
* Allow getting credentials via EC2 role

This is subtly different than the existing `role_arn` solution, which
allows Prometheus to assume an IAM role given some set of credentials
already in-scope. With EC2 roles, one specifies the role at instance
launch time (via an instance profile.) The instance then exposes
temporary credentials via its metadata. The AWS Go SDK exposes a
credential provider that polls the [instance metadata endpoint][1]
already, so we can simply use that and it will take care of renewing the
credentials when they expire.

Without this, if this is being used inside EC2, it is difficult to
cleanly allow the use of STS credentials. One has to set up a proxy role
that can assume the role you really want, and launch the EC2 instance
with the proxy role. This isn't very clean, and also doesn't seem to be
[supported very well][2].

[1]:
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
[2]: https://github.com/aws/aws-cli/issues/1390

* Automatically try to detect EC2 role credentials

The `Available()` function exposed on ec2metadata returns a simple
true/false if the ec2 metadata is available. This is the best way to
know if we're actually running in EC2 (which is the only valid use-case
for this credential provider.)

This allows this to "just work" if you are using EC2 instance roles.
2017-10-25 14:15:39 +01:00
.github Update command line flags in issue template (#3317) 2017-10-19 13:59:00 +01:00
cmd Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
config Remote storage reads based on oldest timestamp in primary storage (#3129) 2017-10-18 12:08:14 +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 Prometheus console template example for 2.0 (#3100) 2017-08-26 21:46:12 +01:00
discovery Feature: Allow getting credentials via EC2 role (#3343) 2017-10-25 14:15:39 +01:00
documentation Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
notifier Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
pkg Fix some lint errors (#3334) 2017-10-23 14:57:30 +01:00
prompb Rename proto package from remote -> prometheus. 2017-08-01 11:12:34 +01:00
promql Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
relabel Stricter Relabel Config Checking for Labeldrop/keep (#2510) 2017-03-18 22:32:08 +01:00
retrieval Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
rules Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
scripts *: add admin grpc API 2017-07-10 09:14:14 +02:00
storage Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
template Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
util Fix some lint errors (#3334) 2017-10-23 14:57:30 +01:00
vendor Update prometheus/tsdb dependency 2017-10-16 15:36:25 +02:00
web Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07: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 Fixing tests for Windows 2017-07-09 01:59:30 -03:00
.promu.yml promu: Use default Go version again 2016-10-11 11:42:05 +02:00
.travis.yml Merge branch 'release-1.7' 2017-09-28 16:46:33 +02:00
CHANGELOG.md *: release v2.0.0-rc.1 2017-10-17 13:51:07 +02:00
circle.yml Move to Go1.9 2017-09-14 18:26:57 +02: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 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 Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md Add maintainers' GitHub usernames to MAINTAINERS.md. 2017-04-25 16:32:23 +10:00
Makefile Fix leak of ticker in remote storage queue manager. 2017-10-09 19:44:03 +01:00
NOTICE Replace handlebars with the simpler and saner mustache library. 2016-11-17 02:33:12 +00:00
README.md Fix "go get" in README (#3288) 2017-10-12 23:15:29 +01:00
VERSION *: release v2.0.0-rc.1 2017-10-17 13:51:07 +02: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.8 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.