helm-prometheus-exporter

Overview

helm-prometheus-exporter is an generalized helm template helps you deploy most prometheus exporters in Kubernetes at ease. You will get all features if you have Prometheus Operator installed. But you can also go without it.

The Chart will install the following objects:

• Deployment: the exporter itself, configed by env or args.
• Service: the exporter service exposing port named metrics for prometheus
• ServiceMonitor: (optional) defines monitoring rule for prometheus
• PrometheusRule: (optional) defines the prometheus alerting rules, with an default UP alert for the exporter itself.

Usage

1. install the chart

helm repo add kehao95 https://kehao95.github.io/helm-prometheus-exporter/

2. get an values template from the chart

helm show values kehao95/prometheus-exporter > my-exporter.yaml

3. edit the values according to the document of the exporter you are about to install.

exporter: 
  # the exporter image
  image: my/exporter
  tag: latest
  pullPolicy: IfNotPresent
  # the exporter's listen port 
  # eg: danielqsj/kafka-exporter has default port at 9308
  port: 9308
  # config the exporter with args or envs
  args: []
    # - --kafka.server=kafka:9092
  env: []
    # - FOO=bar

service:
  type: ClusterIP
  clusterIP: ""
  port: 80
  
# the serviceMonitor 
serviceMonitor:
  enabled: true
  interval: 30s

# the PrometheusRules
prometheusRule:
  enabled: true
  # default PrometheusName of prometheus-operator is "k8s"
  prometheusName: k8s 
  rules: 
  - alert: sample alert
    expr: up > 0
    labels:
      severity: critical
      runbookUrl: https://example.com

4. install it with helm

# install to `monitoring` namespace
helm install -n monitoring my-exporter prometheus-exporter -f my-exporter.yaml
# upgrade
helm upgrade -n monitoring my-exporter prometheus-exporter -f my-exporter.yaml

Examples:

exporter	exporter.image	exporter.port
blackbox_exporter	prom/blackbox-exporter	9115
kafka-exporter	danielqsj/kafka_exporter	9308
redis_exporter	oliver006/redis_exporter	9121
rabbitmq-exporter	kbudde/rabbitmq-exporter	9419
stackdriver-exporter	prometheuscommunity/stackdriver-exporter	9255

Why this project?

Basically all promtheus exporters work the same way in general, which make the project possible:

An exporter configed to extract the metric for a particular system then expose an /metrics endpoint for Promtheus to scrape. Then we need to add scrping config and alerting rules for prometheus to make the system work.

Project Prometheus Operator has made great progress in configuring/managing Prometheus in a Kubernetes way. So we can standardize the whole process (deploy the exporter/config scraping/setup alerting rules) in a generic template.