Puppet Class: prometheus::server

Defined in:
manifests/server.pp

Overview

Parameters:

  • image (String) (defaults to: 'prom/prometheus')
  • version (String) (defaults to: '2.2.1')
  • reloader_image (String) (defaults to: 'jimmidyson/configmap-reload')
  • reloader_version (String) (defaults to: '0.1')
  • retention (String) (defaults to: '720h')
  • port (Integer[1025,65535]) (defaults to: 9090)
  • external_url (String) (defaults to: '')
  • persistent_volume (Boolean) (defaults to: false)
  • persistent_volume_size (Integer) (defaults to: 15)
  • kubernetes_token_file (String) (defaults to: '/var/run/secrets/kubernetes.io/serviceaccount/token')
  • kubernetes_ca_file (String) (defaults to: '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt')
  • external_labels (Hash[String,String]) (defaults to: {})


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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
# File 'manifests/server.pp', line 1

class prometheus::server (
  String $image = 'prom/prometheus',
  String $version = '2.2.1',
  String $reloader_image = 'jimmidyson/configmap-reload',
  String $reloader_version = '0.1',
  String $retention = '720h',  # 30 days
  Integer[1025,65535] $port = 9090,
  String $external_url = '',
  Boolean $persistent_volume = false,
  Integer $persistent_volume_size = 15,
  String $kubernetes_token_file = '/var/run/secrets/kubernetes.io/serviceaccount/token',
  String $kubernetes_ca_file = '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt',
  Hash[String,String] $external_labels = {},
)
{
  require ::kubernetes
  include ::prometheus

  $namespace = $::prometheus::namespace

  $authorization_mode = $::kubernetes::_authorization_mode
  if member($authorization_mode, 'RBAC'){
    $rbac_enabled = true
  } else {
    $rbac_enabled = false
  }

  if versioncmp($::kubernetes::version, '1.6.0') >= 0 {
    $version_before_1_6 = false
  } else {
    $version_before_1_6 = true
  }

  kubernetes::apply{'prometheus-server':
    manifests => [
      template('prometheus/prometheus-ns.yaml.erb'),
      template('prometheus/prometheus-deployment.yaml.erb'),
      template('prometheus/prometheus-svc.yaml.erb'),
    ],
  }

  kubernetes::apply{'prometheus-config':
      type => 'concat',
  }

  kubernetes::apply_fragment { 'prometheus-config-header':
      content => template('prometheus/prometheus-config-header.yaml.erb'),
      order   => 0,
      target  => 'prometheus-config',
  }

  kubernetes::apply_fragment { 'prometheus-config-prometheus-file':
      content => '  prometheus.yaml: |-',
      order   => 100,
      target  => 'prometheus-config',
  }

  kubernetes::apply_fragment { 'prometheus-config-prometheus-rules':
      content => template('prometheus/prometheus-config-rules.yaml.erb'),
      order   => 200,
      target  => 'prometheus-config',
  }

  kubernetes::apply_fragment { 'prometheus-config-global':
      content => template('prometheus/prometheus-config-global.yaml.erb'),
      order   => 300,
      target  => 'prometheus-config',
  }

  kubernetes::apply_fragment { 'prometheus-config-global-pre-scrape-config':
      content => '    scrape_configs:',
      order   => 400,
      target  => 'prometheus-config',
  }

  $external_scrape_targets_only = $::prometheus::external_scrape_targets_only
  if ! $external_scrape_targets_only {
    # Scrape config for API servers.
    #
    # Kubernetes exposes API servers as endpoints to the default/kubernetes
    # service so this uses `endpoints` role and uses relabelling to only keep
    # the endpoints associated with the default/kubernetes service using the
    # default named port `https`. This works for single API server deployments as
    # well as HA API server deployments.
    prometheus::scrape_config { 'kubernetes-apiservers':
      order  =>  100,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'endpoints',
        }],
        'tls_config'            => {
          'ca_file' => $kubernetes_ca_file,
        },
        'bearer_token_file'     => $kubernetes_token_file,
        'scheme'                => 'https',
        'relabel_configs'       => [{
          'source_labels' => ['__meta_kubernetes_namespace', '__meta_kubernetes_service_name', '__meta_kubernetes_endpoint_port_name'],
          'action'        => 'keep',
          'regex'         => 'default;kubernetes;https',
        }],
      }
    }

    # Scrape config for master's schedulers and controller manager (kubelet).
    #
    # Rather than connecting directly to the node, the scrape is proxied though the
    # Kubernetes apiserver.  This means it will work if Prometheus is running out of
    # cluster, or can't connect to nodes for some other reason (e.g. because of
    # firewalling).
    prometheus::scrape_config { 'kubernetes-schedulers':
      order  =>  110,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'node',
        }],
        'tls_config'            => {
          'ca_file' => $kubernetes_ca_file,
        },
        'bearer_token_file'     => $kubernetes_token_file,
        'scheme'                => 'https',
        'relabel_configs'       => [{
            'source_labels' => ['__meta_kubernetes_node_label_role'],
            'action'        => 'keep',
            'regex'         => 'master',
        },{
          'action' => 'labelmap',
          'regex'  => '__meta_kubernetes_node_label_(.+)',
        },{
          'target_label' => '__address__',
          'replacement'  => 'kubernetes.default.svc:443',
        }, {
          'source_labels' => ['__meta_kubernetes_node_name'],
          'regex'         => '(.+)',
          'target_label'  => '__metrics_path__',
          'replacement'   => '/api/v1/nodes/${1}:10251/proxy/metrics',
        }],
      }
    }
    prometheus::scrape_config { 'kubernetes-controller-managers':
      order  =>  110,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'node',
        }],
        'tls_config'            => {
          'ca_file' => $kubernetes_ca_file,
        },
        'bearer_token_file'     => $kubernetes_token_file,
        'scheme'                => 'https',
        'relabel_configs'       => [{
          'source_labels' => ['__meta_kubernetes_node_label_role'],
          'action'        => 'keep',
          'regex'         => 'master',
        },{
          'action' => 'labelmap',
          'regex'  => '__meta_kubernetes_node_label_(.+)',
        },{
          'target_label' => '__address__',
          'replacement'  => 'kubernetes.default.svc:443',
        }, {
          'source_labels' => ['__meta_kubernetes_node_name'],
          'regex'         => '(.+)',
          'target_label'  => '__metrics_path__',
          'replacement'   => '/api/v1/nodes/${1}:10252/proxy/metrics',
        }],
      }
    }

    # Scrape config for nodes (kubelet).
    #
    # Rather than connecting directly to the node, the scrape is proxied though the
    # Kubernetes apiserver.  This means it will work if Prometheus is running out of
    # cluster, or can't connect to nodes for some other reason (e.g. because of
    # firewalling).
    prometheus::scrape_config { 'kubernetes-nodes':
      order  =>  110,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'node',
        }],
        'tls_config'            => {
          'ca_file' => $kubernetes_ca_file,
        },
        'bearer_token_file'     => $kubernetes_token_file,
        'scheme'                => 'https',
        'relabel_configs'       => [{
          'action' => 'labelmap',
          'regex'  => '__meta_kubernetes_node_label_(.+)',
        },{
          'target_label' => '__address__',
          'replacement'  => 'kubernetes.default.svc:443',
        }, {
          'source_labels' => ['__meta_kubernetes_node_name'],
          'regex'         => '(.+)',
          'target_label'  => '__metrics_path__',
          'replacement'   => '/api/v1/nodes/${1}/proxy/metrics',
        }],
      }
    }


    # Scrape config for Kubelet cAdvisor.
    #
    # This is required for Kubernetes 1.7.3 and later, where cAdvisor metrics
    # (those whose names begin with 'container_') have been removed from the
    # Kubelet metrics endpoint.  This job scrapes the cAdvisor endpoint to
    # retrieve those metrics.
    #
    # In Kubernetes 1.7.0-1.7.2, these metrics are only exposed on the cAdvisor
    # HTTP endpoint; use "replacement: /api/v1/nodes/${1}:4194/proxy/metrics"
    # in that case (and ensure cAdvisor's HTTP server hasn't been disabled with
    # the --cadvisor-port=0 Kubelet flag).
    #
    # This job is not necessary and should be removed in Kubernetes 1.6 and
    # earlier versions, or it will cause the metrics to be scraped twice.
    prometheus::scrape_config { 'kubernetes-nodes-cadvisor':
      order  =>  120,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'node',
        }],
        'tls_config'            => {
          'ca_file' => $kubernetes_ca_file,
        },
        'bearer_token_file'     => $kubernetes_token_file,
        'scheme'                => 'https',
        'relabel_configs'       => [{
          'action' => 'labelmap',
          'regex'  => '__meta_kubernetes_node_label_(.+)',
        },{
          'target_label' => '__address__',
          'replacement'  => 'kubernetes.default.svc:443',
        }, {
          'source_labels' => ['__meta_kubernetes_node_name'],
          'regex'         => '(.+)',
          'target_label'  => '__metrics_path__',
          'replacement'   => '/api/v1/nodes/${1}/proxy/metrics/cadvisor',
        }],
      }
    }

    # Scrape config for service endpoints.
    #
    # The relabeling allows the actual service scrape endpoint to be configured
    # via the following annotations:
    #
    # * `prometheus.io/scrape`: Only scrape services that have a value of `true`
    # * `prometheus.io/scheme`: If the metrics endpoint is secured then you will need
    # to set this to `https` & most likely set the `tls_config` of the scrape config.
    # * `prometheus.io/path`: If the metrics path is not `/metrics` override this.
    # * `prometheus.io/port`: If the metrics are exposed on a different port to the
    # service then set this appropriately.
    prometheus::scrape_config { 'kubernetes-service-endpoints':
      order  =>  200,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'endpoints',
        }],

        'relabel_configs'       => [
          {
            'source_labels' => ['__meta_kubernetes_service_annotation_prometheus_io_scrape'],
            'action'        => 'keep',
            'regex'         => true,
          },
          {
            'source_labels' => ['__meta_kubernetes_service_annotation_prometheus_io_scheme'],
            'action'        => 'replace',
            'target_label'  => '__scheme__',
            'regex'         => '(https?)',
          },
          {
            'source_labels' => ['__meta_kubernetes_service_annotation_prometheus_io_path'],
            'action'        => 'replace',
            'target_label'  => '__metrics_path__',
            'regex'         => '(.+)',
          },
          {
            'source_labels' => ['__address__', '__meta_kubernetes_service_annotation_prometheus_io_port'],
            'action'        => 'replace',
            'target_label'  => '__address__',
            'regex'         => '(.+)(?::\d+);(\d+)',
            'replacement'   => '$1:$2',
          },
          {
            'action' => 'labelmap',
            'regex'  => '__meta_kubernetes_service_label_(.+)',
          },
          {
            'source_labels' => ['__meta_kubernetes_namespace'],
            'action'        => 'replace',
            'target_label'  => 'kubernetes_namespace',
          },
          {
            'source_labels' => ['__meta_kubernetes_service_name'],
            'action'        => 'replace',
            'target_label'  => 'kubernetes_name',
          }
        ]
      }
    }

    # Example scrape config for probing services via the Blackbox Exporter.
    #
    # The relabeling allows the actual service scrape endpoint to be configured
    # via the following annotations:
    #
    # * `prometheus.io/probe`: Only probe services that have a value of `true`
    prometheus::scrape_config { 'kubernetes-services':
      order  =>  210,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'service'
        }],
        'metrics_path'          => '/probe',
        'params'                => {
          'module' => ['http_2xx'],
        },
        'relabel_configs'       => [
          {
            'source_labels' => ['__meta_kubernetes_service_annotation_prometheus_io_probe'],
            'action'        => 'keep',
            'regex'         => true,
          },
          {
            'source_labels' => ['__address__'],
            'target_label'  => '__param_target',
          },
          {
            'target_label' => '__address__',
            'replacement'  => 'blackbox-exporter',
          },
          {
            'source_labels' => ['__param_target'],
            'target_label'  => 'instance',
          },
          {
            'action' => 'labelmap',
            'regex'  => '__meta_kubernetes_service_label_(.+)',
          },
          {
            'source_labels' => ['__meta_kubernetes_service_namespace'],
            'target_label'  => 'kubernetes_namespace',
          },
          {
            'source_labels' => ['__meta_kubernetes_service_name'],
            'target_label'  => 'kubernetes_name',
          },
        ]
      },
    }


    # Example scrape config for probing ingresses via the Blackbox Exporter.
    #
    # The relabeling allows the actual ingress scrape endpoint to be configured
    # via the following annotations:
    #
    # * `prometheus.io/probe`: Only probe ingresses that have a value of `true`
    prometheus::scrape_config { 'kubernetes-ingresses':
      order  =>  220,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'ingress'
        }],
        'metrics_path'          => '/probe',
        'params'                => {
          'module' => ['http_2xx'],
        },
        'relabel_configs'       => [
          {
            'source_labels' => ['__meta_kubernetes_ingress_annotation_prometheus_io_probe'],
            'action'        => 'keep',
            'regex'         => true,
          },
          {
            'source_labels' => ['__meta_kubernetes_ingress_scheme','__address__','__meta_kubernetes_ingress_path'],
            'target_label'  => '__param_target',
            'regex'         => '(.+);(.+);(.+)',
            'replacement'   => '${1}://${2}${3}',
          },
          {
            'target_label' => '__address__',
            'replacement'  => 'blackbox-exporter',
          },
          {
            'source_labels' => ['__param_target'],
            'target_label'  => 'instance',
          },
          {
            'action' => 'labelmap',
            'regex'  => '__meta_kubernetes_ingress_label_(.+)',
          },
          {
            'source_labels' => ['__meta_kubernetes_ingress_namespace'],
            'target_label'  => 'kubernetes_namespace',
          },
          {
            'source_labels' => ['__meta_kubernetes_ingress_name'],
            'target_label'  => 'kubernetes_name',
          },
        ]
      },
    }

    # Example scrape config for pods
    #
    # The relabeling allows the actual pod scrape endpoint to be configured via the
    # following annotations:
    #
    # * `prometheus.io/scrape`: Only scrape pods that have a value of `true`
    # * `prometheus.io/path`: If the metrics path is not `/metrics` override this.
    # * `prometheus.io/port`: Scrape the pod on the indicated port instead of the
    # pod's declared ports (default is a port-free target if none are declared).
    prometheus::scrape_config { 'kubernetes-pods':
      order  =>  230,
      config => {
        'kubernetes_sd_configs' => [{
          'role' => 'pod'
        }],
        'relabel_configs'       => [
          {
            'source_labels' => ['__meta_kubernetes_pod_annotation_prometheus_io_scrape'],
            'action'        => 'keep',
            'regex'         => true,
          },
          {
            'source_labels' => ['__meta_kubernetes_pod_annotation_prometheus_io_path'],
            'action'        => 'replace',
            'target_label'  => '__metrics_path__',
            'regex'         => '(.+)',
          },
          {
            'source_labels' => ['__address__', '__meta_kubernetes_pod_annotation_prometheus_io_port'],
            'action'        => 'replace',
            'regex'         => '([^:]+)(?::\d+)?;(\d+)',
            'replacement'   => '${1}:${2}',
            'target_label'  => '__address__',
          },
          {
            'action' => 'labelmap',
            'regex'  => '__meta_kubernetes_pod_label_(.+)',
          },
          {
            'source_labels' => ['__meta_kubernetes_namespace'],
            'action'        => 'replace',
            'target_label'  => 'kubernetes_namespace',
          },
          {
            'source_labels' => ['__meta_kubernetes_pod_name'],
            'action'        => 'replace',
            'target_label'  => 'kubernetes_pod_name',
          }
        ]
      }
    }
  }

  kubernetes::apply{'prometheus-rules':
      type => 'concat',
  }

  kubernetes::apply_fragment { 'prometheus-rules-header':
      content => template('prometheus/prometheus-rules-header.yaml.erb'),
      order   => 0,
      target  => 'prometheus-rules',
  }


  prometheus::rule { 'ScrapeEndpointDown':
    expr        => '(up == 0 AND up {job != "kubernetes-apiservers"})',
    for         => '2m',
    summary     => '{{$labels.instance}}: Scrape target is down',
    description => '{{$labels.instance}}: Target down for job {{$labels.job}}',
  }

  prometheus::rule { 'ContainerScrapeError':
    expr        => '(container_scrape_error) != 0',
    for         => '2m',
    summary     => '{{$labels.instance}}: Container scrape error',
    description => '{{$labels.instance}}: Failed to scrape container, metrics will not be updated',
  }
}