Go to file
David Kaltschmidt c93e54d240 Adds execution timer stats to the range query
API consumers should be able to get insight into the query run times.
The UI currently measures total roundtrip times. This PR allows for more
fine grained metrics to be exposed.

* adds new timer for total execution time (queue + eval)

* expose new timer, queue timer, and eval timer in stats field of the
 range query response:
```json
{
  "status": "success",
  "data": {
    "resultType": "matrix",
    "result": [],
    "stats": {
      "execQueueTimeNs": 4683,
      "execTotalTimeNs": 2086587,
      "totalEvalTimeNs": 2077851
    }
  }
}
```

* stats field is optional, only set when query parameter `stats` is not
empty

Try it via
```sh
curl 'http://localhost:9090/api/v1/query_range?query=up&start=1486480279&end=1486483879&step=14000&stats=true'
```

Review feedback

* moved query stats json generation to query_stats.go
* use seconds for all query timers
* expose all timers available
* Changed ExecTotalTime string representation from Exec queue total time to Exec total time
2017-11-16 16:05:10 +01:00
.github Update command line flags in issue template (#3317) 2017-10-19 13:59:00 +01:00
cmd Refactor main.go with oklog/pkg/group actors pattern 2017-11-11 12:33:15 +00:00
config Add remote read filter option 2017-11-13 23:30:01 +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 consoles for new metric names. (#3327) 2017-11-07 13:23:45 +00:00
discovery Merge pull request #3458 from grandbora/test-race 2017-11-13 17:57:21 +01:00
docs Add remote read filter option 2017-11-13 23:30:01 +01:00
documentation Fix instructions on updating prometheus.yml for Remote Write Adapter Example (#3422) 2017-11-07 20:02:43 +00: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 now using only github.com/gogo/protobuf 2017-11-02 11:31:57 +00:00
promql Adds execution timer stats to the range query 2017-11-16 16:05:10 +01:00
relabel Stricter Relabel Config Checking for Labeldrop/keep (#2510) 2017-03-18 22:32:08 +01:00
retrieval Fix for #3312 sigpanic in TargetManager (#3420) 2017-11-07 15:56:00 +00:00
rules rules: remove skipped iterations cuz no throttling 2017-11-14 17:33:00 +05:30
scripts now using only github.com/gogo/protobuf 2017-11-02 11:31:57 +00:00
storage Add remote read filter option 2017-11-13 23:30:01 +01:00
template Migrate "golang.org/x/net/context" -> "context" (#3333) 2017-10-24 21:21:42 -07:00
util Adds execution timer stats to the range query 2017-11-16 16:05:10 +01:00
vendor Refactor main.go with oklog/pkg/group actors pattern 2017-11-11 12:33:15 +00:00
web Adds execution timer stats to the range query 2017-11-16 16:05:10 +01:00
.dockerignore New release process using docker, circleci and a centralized 2016-04-18 22:41:04 +02:00
.gitignore updated-gitignore 2017-11-01 21:49:59 +00: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 2.0.0 2017-11-08 08:06:15 +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 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 Remove last mention of GO15VENDOREXPERIMENT 2017-11-13 11:00:30 +00:00
NOTICE Update NOTICE for gogo/protobuf 2017-11-02 15:28:47 +01:00
README.md Remove code climate badges (#3361) 2017-10-27 12:37:00 +00:00
VERSION Release 2.0.0 2017-11-08 08:06:15 +01: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

README.md

Prometheus Build Status

CircleCI Docker Repository on Quay Docker Pulls Go Report Card

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.