From b17f7e798c71c40d6a63c78c8d52faf67df110fd Mon Sep 17 00:00:00 2001 From: adamkpickering Date: Wed, 8 Jan 2020 17:23:40 -0700 Subject: [PATCH] stable/prometheus Updated README.md with instructions for configuring pod scraping (#19379) * Updated README.md with instructions for configuring pod scraping Signed-off-by: Adam Pickering * Updated chart version to latest. Signed-off-by: Adam Pickering * Bumped version to be in sync... again Signed-off-by: Adam Pickering * Bumped chart version Signed-off-by: Adam Pickering * Bumped version again Signed-off-by: Adam Pickering --- stable/prometheus/Chart.yaml | 2 +- stable/prometheus/README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/stable/prometheus/Chart.yaml b/stable/prometheus/Chart.yaml index 4afd7cbe3c..274bf68b96 100755 --- a/stable/prometheus/Chart.yaml +++ b/stable/prometheus/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v1 name: prometheus -version: 9.7.4 +version: 9.7.5 appVersion: 2.13.1 description: Prometheus is a monitoring system and time series database. home: https://prometheus.io/ diff --git a/stable/prometheus/README.md b/stable/prometheus/README.md index dd2ca4794e..d7a2ef639e 100644 --- a/stable/prometheus/README.md +++ b/stable/prometheus/README.md @@ -90,6 +90,34 @@ Assuming you have an existing release of the prometheus chart, named `prometheus Old data will be available when you query the new prometheus instance. +## Scraping Pod Metrics via Annotations + +This chart uses a default configuration that causes prometheus +to scrape a variety of kubernetes resource types, provided they have the correct annotations. +In this section we describe how to configure pods to be scraped; +for information on how other resource types can be scraped you can +do a `helm template` to get the kubernetes resource definitions, +and then reference the prometheus configuration in the ConfigMap against the prometheus documentation +for [relabel_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config) +and [kubernetes_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config). + +In order to get prometheus to scrape pods, you must add annotations to the the pods as below: + +``` +metadata: + annotations: + prometheus.io/scrape: "true" + prometheus.io/path: /metrics + prometheus.io/port: "8080" +spec: +... +``` + +You should adjust `prometheus.io/path` based on the URL that your pod serves metrics from. +`prometheus.io/port` should be set to the port that your pod serves metrics from. +Note that the values for `prometheus.io/scrape` and `prometheus.io/port` must be +enclosed in double quotes. + ## Configuration The following table lists the configurable parameters of the Prometheus chart and their default values.