Skip to content

monitoring

Feature state: 0.7.0

monitoring value in Kubedeploy allows controlling the parameters for deploying ServiceMonitor or PodMonitor objects.

Note

ServiceMonitor and PodMonitor objects are part of CRD definitions of Prometheus operator. Your cluster must have them installed first. If CRD is detected as missing, chart will skip their deployment.

Available values for monitoring in Kubedeploy:

monitoring:
  enabled: false # (1)
  labels: {} # (2)
  targetLabels: [] # (3)
  scrapePort: metrics # (4)
  scrapePath: /metrics # (5)
  scrapeInterval: 20s # (6)
  scrapeTimeout: 15s # (7)
  scheme: http # (8)
  tlsConfig: {} # (9)
  metricRelabelings: [] # (10)
  relabelings: [] # (11)
  1. Enable monitoring.
  2. Provide additional labels to the ServiceMonitor metadata
  3. Additional metric labels
  4. Provide named service port used for scraping
  5. Provide HTTP path to scrape for metrics.
  6. Provide interval at which metrics should be scraped
  7. Timeout after which the scrape is ended (must be less than scrapeInterval)
  8. HTTP scheme to use for scraping.
  9. TLS configuration to use when scraping the endpoint
  10. Provide additional metricRelabelings to apply to samples before ingestion.
  11. Provide additional relabelings to apply to samples before scraping

Info

If service.enabled is True, chart will generate ServiceMonitor object, otherwise PodMonitor will be used.

Enable metrics scraping for exporter container

values.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
nameOverride: my-app
image:
  repository: nginx
  tag: latest

ports:
  - containerPort: 80
    name: http
    protocol: TCP

additionalContainers:
  enabled: true
  containers:
    - name: metrics-exporter
      repository: nginx/nginx-prometheus-exporter
      tag: latest
      args:
        - -nginx.scrape-uri=http://localhost:80/stub_status
      ports:
        - containerPort: 9113
          name: metrics
          protocol: TCP

monitoring:
  enabled: true
Deploy command
helm install webapp sysbee/kubedeploy -f values.yaml

In this simple example our additionalContainer is used as metrics exporter. Since it already exports metrics on port named metrics, all we need to do is enable monitoring and leave all the other values on default.

Enable metrics scraping for built-in application metrics

values.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
nameOverride: my-app
image:
  repository: nginx
  tag: latest

ports:
  - containerPort: 80
    name: http
    protocol: TCP

monitoring:
  enabled: true
  scrapePort: http
  scrapePath: /custom/metrics/url
Deploy command
helm install webapp sysbee/kubedeploy -f values.yaml

If our application has built in metrics exporter on custom route, we can modify monitoring scrapePort and scrapePath.

See also: