Go to file
Damien Grisonnet b50f9c1c84
Add label scrape limits (#8777)
* scrape: add label limits per scrape

Add three new limits to the scrape configuration to provide some
mechanism to defend against unbound number of labels and excessive
label lengths. If any of these limits are broken by a sample from a
scrape, the whole scrape will fail. For all of these configuration
options, a zero value means no limit.

The `label_limit` configuration will provide a mechanism to bound the
number of labels per-scrape of a certain sample to a user defined limit.
This limit will be tested against the sample labels plus the discovery
labels, but it will exclude the __name__ from the count since it is a
mandatory Prometheus label to which applying constraints isn't
meaningful.

The `label_name_length_limit` and `label_value_length_limit` will
prevent having labels of excessive lengths. These limits also skip the
__name__ label for the same reasons as the `label_limit` option and will
also make the scrape fail if any sample has a label name/value length
that exceed the predefined limits.

Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>

* scrape: add metrics and alert to label limits

Add three gauge, one for each label limit to easily access the
limit set by a certain scrape target.
Also add a counter to count the number of targets that exceeded the
label limits and thus were dropped. This is useful for the
`PrometheusLabelLimitHit` alert that will notify the users that scraping
some targets failed because they had samples exceeding the label limits
defined in the scrape configuration.

Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>

* scrape: apply label limits to __name__ label

Apply limits to the __name__ label that was previously skipped and
truncate the label names and values in the error messages as they can be
very very long.

Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>

* scrape: remove label limits gauges and refactor

Remove `prometheus_target_scrape_pool_label_limit`,
`prometheus_target_scrape_pool_label_name_length_limit`, and
`prometheus_target_scrape_pool_label_value_length_limit` as they are not
really useful since we don't have the information on the labels in it.

Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>
2021-05-06 09:56:21 +01:00
.circleci Update yq checksum 2021-03-30 09:16:15 +02:00
.github Update support link (#8711) 2021-04-12 21:42:06 +01:00
cmd Instrumented circular exemplar storage. (#8712) 2021-04-16 13:44:53 +01:00
config Add label scrape limits (#8777) 2021-05-06 09:56:21 +01:00
console_libraries Make React UI the default, keep old UI under /classic (#8142) 2020-11-03 14:51:48 +01:00
consoles
discovery Merge pull request #8766 from Nick-Triller/consul-sd-always-send-targetgroups 2021-04-30 10:27:41 +02:00
docs Add label scrape limits (#8777) 2021-05-06 09:56:21 +01:00
documentation Add label scrape limits (#8777) 2021-05-06 09:56:21 +01:00
notifier Upgrade prometheus/common to v0.21.0 2021-04-21 12:19:16 +02:00
pkg Update Makefile.common 2021-04-13 09:33:45 +02:00
prompb Update github.com/gogo/protobuf to v1.3.2 2021-02-08 17:30:46 +01:00
promql Merge pull request #8731 from yeya24/update 2021-04-27 00:55:22 +02:00
rules expose rule metrics fields 2021-04-30 13:36:44 -04:00
scrape Add label scrape limits (#8777) 2021-05-06 09:56:21 +01:00
scripts Don't sync if no orb is used 2021-03-31 09:05:59 +02:00
storage Fix some gofmt warnings (#8743) 2021-04-22 08:43:30 -06:00
template Enable parsing strings in humanize functions (#8682) 2021-04-14 00:30:15 +02:00
tsdb tsdb: move exemplar series labels to index entry (#8783) 2021-05-05 18:51:16 +01:00
util Ignore k8s' updateUnfinishedWorkLoop go routine in goleak tests (#8598) 2021-03-29 23:43:09 +02:00
web Upgrade cssnano from v4.1.10 to v4.1.11 (#8759) 2021-04-26 19:14:19 +02:00
.dockerignore
.gitignore add changes per comments, fix tests 2021-03-20 12:38:30 -07:00
.gitpod.yml
.golangci.yml Remove inline Go vendor dir 2021-02-11 11:53:22 +01:00
.promu.yml Use CircleCI parallelism 2021-03-21 12:17:20 +01:00
CHANGELOG.md Revert "Changelog: Add hyperlinks to PRs" 2021-04-07 17:06:45 +02:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Update master branch to main 2021-03-05 15:55:42 +07:00
Dockerfile Fix docker image build 2020-12-16 21:21:22 +01:00
go.mod Add OAuth 2.0 Config (#8761) 2021-04-28 14:47:52 +02:00
go.sum Add OAuth 2.0 Config (#8761) 2021-04-28 14:47:52 +02:00
LICENSE
MAINTAINERS.md Add @dgl as maintainer of promtool 2021-03-08 20:38:57 +01:00
Makefile Increase golint timeout 1m -> 2m (#8469) 2021-02-10 14:02:26 +01:00
Makefile.common Update Makefile.common 2021-04-13 09:33:45 +02:00
NOTICE Add new codemirror-promql-based expression editor (#8634) 2021-03-23 23:55:52 +01:00
README.md Fix the installation from source instruction in README 2021-03-11 16:24:15 +01:00
RELEASE.md Volunteering Myself & Chris for next releases. 2021-02-26 16:06:19 +00:00
SECURITY.md Add SECURITY.md file (#8292) 2021-01-09 09:58:53 +01:00
VERSION Merge release-2.26.0 branch to main. (#8678) 2021-03-31 18:16:37 +01:00

Prometheus

CircleCI Docker Repository on Quay Docker Pulls Go Report Card CII Best Practices Gitpod ready-to-code Fuzzing Status

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 when specified conditions are observed.

The features that distinguish Prometheus from other metrics and monitoring systems are:

  • A multi-dimensional data model (time series defined by metric name and set of key/value dimensions)
  • PromQL, a powerful and flexible query language to leverage this dimensionality
  • No dependency on distributed storage; single server nodes are autonomous
  • An HTTP pull model for time series collection
  • Pushing time series is supported via an intermediary gateway for batch jobs
  • 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.

Docker images

Docker images are available on Quay.io or Docker Hub.

You can launch a Prometheus container for trying it out with

$ docker run --name prometheus -d -p 127.0.0.1:9090:9090 prom/prometheus

Prometheus will now be reachable at http://localhost:9090/.

Building from source

To build Prometheus from source code, first ensure that have a working Go environment with version 1.14 or greater installed. You also need Node.js and Yarn installed in order to build the frontend assets.

You can directly use the go tool to download and install the prometheus and promtool binaries into your GOPATH:

$ GO111MODULE=on go get github.com/prometheus/prometheus/cmd/...
$ prometheus --config.file=your_config.yml

However, when using go get to build Prometheus, Prometheus will expect to be able to read its web assets from local filesystem directories under web/ui/static and web/ui/templates. In order for these assets to be found, you will have to run Prometheus from the root of the cloned repository. Note also that these directories do not include the new experimental React UI unless it has been built explicitly using make assets or make build.

An example of the above configuration file can be found here.

You can also clone the repository yourself and build using make build, which will compile in the web assets so that Prometheus can be run from anywhere:

$ 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 (includes building and compiling in web assets)
  • test: run the tests
  • test-short: run the short tests
  • format: format the source code
  • vet: check the source code for common errors
  • assets: build the new experimental React UI

Building the Docker image

The make docker target is designed for use in our CI system. You can build a docker image locally with the following commands:

$ make promu
$ promu crossbuild -p linux/amd64
$ make common-docker-amd64

NB if you are on a Mac, you will need gnu-tar.

React UI Development

For more information on building, running, and developing on the new React-based UI, see the React app's README.md.

More information

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.