/
monitoring.go
303 lines (286 loc) · 16.8 KB
/
monitoring.go
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
// Copyright 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package kubeapiserver
import (
"bytes"
"strings"
"text/template"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
)
// TODO: The etcd_object_counts metric is removed in K8s 1.25 (https://github.com/kubernetes/kubernetes/pull/110337). Remove this metric when we remove support for K8s 1.25.
// TODO: The etcd_db_total_size_in_bytes metric is renamed to apiserver_storage_db_total_size_in_bytes in K8s 1.26 (https://github.com/kubernetes/kubernetes/pull/113310). Remove this metric when we remove support for K8s 1.26.
// TODO: The apiserver_storage_db_total_size_in_bytes metric is replaced by apiserver_storage_size_bytes in K8s 1.28 (https://github.com/kubernetes/kubernetes/pull/118812). Remove this metric when we remove support for K8s 1.28.
const (
monitoringPrometheusJobName = "kube-apiserver"
monitoringMetricAuthenticationAttempts = "authentication_attempts"
monitoringMetricAuthenticatedUserRequests = "authenticated_user_requests"
monitoringMetricApiserverAdmissionControllerAdmissionDurationSeconds = "apiserver_admission_controller_admission_duration_seconds_.+"
monitoringMetricApiserverAdmissionWebhookAdmissionDurationSeconds = "apiserver_admission_webhook_admission_duration_seconds_.+"
monitoringMetricApiserverAdmissionStepAdmissionDurationSeconds = "apiserver_admission_step_admission_duration_seconds_.+"
monitoringMetricApiserverAdmissionWebhookRejectionCount = "apiserver_admission_webhook_rejection_count"
monitoringMetricApiserverAuditEventTotal = "apiserver_audit_event_total"
monitoringMetricApiserverAuditErrorTotal = "apiserver_audit_error_total"
monitoringMetricApiserverAuditRequestsRejectedTotal = "apiserver_audit_requests_rejected_total"
monitoringMetricApiserverLatencySeconds = "apiserver_latency_seconds"
monitoringMetricApiserverCRDWebhookConversionDurationSeconds = "apiserver_crd_webhook_conversion_duration_seconds_.+"
monitoringMetricApiserverCurrentInflightRequests = "apiserver_current_inflight_requests"
monitoringMetricApiserverCurrentInqueueRequests = "apiserver_current_inqueue_requests"
monitoringMetricApiserverLongrunningRequests = "apiserver_longrunning_requests"
monitoringMetricApiserverResponseSizes = "apiserver_response_sizes_.+"
monitoringMetricApiserverRegisteredWatchers = "apiserver_registered_watchers"
monitoringMetricApiserverRequestDurationSeconds = "apiserver_request_duration_seconds_.+"
monitoringMetricApiserverRequestDurationSecondsBucket = "apiserver_request_duration_seconds_bucket"
monitoringMetricApiserverRequestTerminationsTotal = "apiserver_request_terminations_total"
monitoringMetricApiserverRequestTotal = "apiserver_request_total"
monitoringMetricApiserverRequestCount = "apiserver_request_count"
monitoringMetricApiserverStorageTransformationDurationSeconds = "apiserver_storage_transformation_duration_seconds_.+"
monitoringMetricApiserverStorageTransformationOperationsTotal = "apiserver_storage_transformation_operations_total"
monitoringMetricApiserverInitEventsTotal = "apiserver_init_events_total"
monitoringMetricApiserverWatchEventsSizes = "apiserver_watch_events_sizes_.+"
monitoringMetricApiserverWatchEventsTotal = "apiserver_watch_events_total"
monitoringMetricApiserverWatchDuration = "apiserver_watch_duration"
monitoringMetricEtcdDbTotalSizeInBytes = "etcd_db_total_size_in_bytes"
monitoringMetricApiserverStorageDbTotalSizeInBytes = "apiserver_storage_db_total_size_in_bytes"
monitoringMetricApiserverStorageSizeBytes = "apiserver_storage_size_bytes"
monitoringMetricEtcdObjectCounts = "etcd_object_counts"
monitoringMetricApiserverStorageObjects = "apiserver_storage_objects"
monitoringMetricEtcdRequestDurationSeconds = "etcd_request_duration_seconds_.+"
monitoringMetricGo = "go_.+"
monitoringMetricProcessMaxFds = "process_max_fds"
monitoringMetricProcessOpenFds = "process_open_fds"
monitoringMetricWatchCacheCapacityIncreaseTotal = "watch_cache_capacity_increase_total"
monitoringMetricWatchCacheCapacityDecreaseTotal = "watch_cache_capacity_decrease_total"
monitoringMetricWatchCacheCapacity = "watch_cache_capacity"
monitoringmetricApiserverCacheList = "apiserver_cache_list_.+"
monitoringmetricApiserverStorageList = "apiserver_storage_list_.+"
// TODO: Replace below hard-coded job name of the Blackbox Exporter once its deployment has been refactored.
monitoringAlertingRules = `groups:
- name: kube-apiserver.rules
rules:
- alert: ApiServerNotReachable
expr: probe_success{job="blackbox-apiserver"} == 0
for: 5m
labels:
service: ` + v1beta1constants.DeploymentNameKubeAPIServer + `
severity: blocker
type: seed
visibility: all
annotations:
description: "API server not reachable via external endpoint: {{ $labels.instance }}."
summary: API server not reachable (externally).
- alert: KubeApiserverDown
expr: absent(up{job="` + monitoringPrometheusJobName + `"} == 1)
for: 5m
labels:
service: ` + v1beta1constants.DeploymentNameKubeAPIServer + `
severity: blocker
type: seed
visibility: operator
annotations:
description: All API server replicas are down/unreachable, or all API server could not be found.
summary: API server unreachable.
- alert: KubeApiServerTooManyOpenFileDescriptors
expr: 100 * ` + monitoringMetricProcessOpenFds + `{job="` + monitoringPrometheusJobName + `"} / ` + monitoringMetricProcessMaxFds + ` > 50
for: 30m
labels:
service: ` + v1beta1constants.DeploymentNameKubeAPIServer + `
severity: warning
type: seed
visibility: owner
annotations:
description: 'The API server ({{ $labels.instance }}) is using {{ $value }}% of the available file/socket descriptors.'
summary: 'The API server has too many open file descriptors'
- alert: KubeApiServerTooManyOpenFileDescriptors
expr: 100 * ` + monitoringMetricProcessOpenFds + `{job="` + monitoringPrometheusJobName + `"} / ` + monitoringMetricProcessMaxFds + `{job="` + monitoringPrometheusJobName + `"} > 80
for: 30m
labels:
service: ` + v1beta1constants.DeploymentNameKubeAPIServer + `
severity: critical
type: seed
visibility: owner
annotations:
description: 'The API server ({{ $labels.instance }}) is using {{ $value }}% of the available file/socket descriptors.'
summary: 'The API server has too many open file descriptors'
# Some verbs excluded because they are expected to be long-lasting:
# WATCHLIST is long-poll, CONNECT is "kubectl exec".
- alert: KubeApiServerLatency
expr: histogram_quantile(0.99, sum without (instance,resource,subresource) (rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `{subresource!~"log|portforward|exec|proxy|attach",verb!~"CONNECT|WATCHLIST|WATCH|PROXY proxy"}[5m]))) > 3
for: 30m
labels:
service: ` + v1beta1constants.DeploymentNameKubeAPIServer + `
severity: warning
type: seed
visibility: owner
annotations:
description: Kube API server latency for verb {{ $labels.verb }} is high. This could be because the shoot workers and the control plane are in different regions. 99th percentile of request latency is greater than 3 seconds.
summary: Kubernetes API server latency is high
# TODO(wyb1): replace with better metrics in the future
- record: shoot:` + monitoringMetricApiserverWatchDuration + `:quantile
expr: histogram_quantile(0.2, sum(rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `{verb="WATCH",resource=~"configmaps|deployments|secrets|daemonsets|services|nodes|pods|namespaces|endpoints|statefulsets|clusterroles|roles"}[5m])) by (le,scope,resource))
labels:
quantile: "0.2"
- record: shoot:` + monitoringMetricApiserverWatchDuration + `:quantile
expr: histogram_quantile(0.5, sum(rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `{verb="WATCH",resource=~"configmaps|deployments|secrets|daemonsets|services|nodes|pods|namespaces|endpoints|statefulsets|clusterroles|roles"}[5m])) by (le,scope,resource))
labels:
quantile: "0.5"
- record: shoot:` + monitoringMetricApiserverWatchDuration + `:quantile
expr: histogram_quantile(0.9, sum(rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `{verb="WATCH",resource=~"configmaps|deployments|secrets|daemonsets|services|nodes|pods|namespaces|endpoints|statefulsets|clusterroles|roles"}[5m])) by (le,scope,resource))
labels:
quantile: "0.9"
- record: shoot:` + monitoringMetricApiserverWatchDuration + `:quantile
expr: histogram_quantile(0.2, sum(rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `{verb="WATCH",group=~".+garden.+"}[5m])) by (le,scope,resource))
labels:
quantile: "0.2"
- record: shoot:` + monitoringMetricApiserverWatchDuration + `:quantile
expr: histogram_quantile(0.5, sum(rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `{verb="WATCH",group=~".+garden.+"}[5m])) by (le,scope,resource))
labels:
quantile: "0.5"
- record: shoot:` + monitoringMetricApiserverWatchDuration + `:quantile
expr: histogram_quantile(0.9, sum(rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `{verb="WATCH",group=~".+garden.+"}[5m])) by (le,scope,resource))
labels:
quantile: "0.9"
### API auditlog ###
- alert: KubeApiServerTooManyAuditlogFailures
expr: sum(rate (` + monitoringMetricApiserverAuditErrorTotal + `{plugin!="log",job="` + monitoringPrometheusJobName + `"}[5m])) / sum(rate(` + monitoringMetricApiserverAuditEventTotal + `{job="` + monitoringPrometheusJobName + `"}[5m])) > bool 0.02 == 1
for: 15m
labels:
service: auditlog
severity: warning
type: seed
visibility: operator
annotations:
description: 'The API servers cumulative failure rate in logging audit events is greater than 2%.'
summary: 'The kubernetes API server has too many failed attempts to log audit events'
- record: shoot:` + monitoringMetricApiserverAuditEventTotal + `:sum
expr: sum(rate(` + monitoringMetricApiserverAuditEventTotal + `{job="` + monitoringPrometheusJobName + `"}[5m]))
- record: shoot:` + monitoringMetricApiserverAuditErrorTotal + `:sum
expr: sum(rate(` + monitoringMetricApiserverAuditErrorTotal + `{plugin!="log",job="` + monitoringPrometheusJobName + `"}[5m]))
### API latency ###
- record: ` + monitoringMetricApiserverLatencySeconds + `:quantile
expr: histogram_quantile(0.99, sum without (instance, pod) (rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `[5m])))
labels:
quantile: "0.99"
- record: ` + monitoringMetricApiserverLatencySeconds + `:quantile
expr: histogram_quantile(0.9, sum without (instance, pod) (rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `[5m])))
labels:
quantile: "0.9"
- record: ` + monitoringMetricApiserverLatencySeconds + `:quantile
expr: histogram_quantile(0.5, sum without (instance, pod) (rate(` + monitoringMetricApiserverRequestDurationSecondsBucket + `[5m])))
labels:
quantile: "0.5"
- record: shoot:kube_apiserver:sum_by_pod
expr: sum(up{job="` + monitoringPrometheusJobName + `"}) by (pod)
### API failure rate ###
- alert: ApiserverRequestsFailureRate
expr: max(sum by(instance,resource,verb) (rate(` + monitoringMetricApiserverRequestTotal + `{code=~"5.."}[10m])) / sum by(instance,resource,verb) (rate(` + monitoringMetricApiserverRequestTotal + `[10m]))) * 100 > 10
for: 30m
labels:
service: ` + v1beta1constants.DeploymentNameKubeAPIServer + `
severity: warning
type: seed
visibility: operator
annotations:
description: The API Server requests failure rate exceeds 10%.
summary: Kubernetes API server failure rate is high
`
)
var (
monitoringAllowedMetrics = []string{
monitoringMetricAuthenticationAttempts,
monitoringMetricAuthenticatedUserRequests,
monitoringMetricApiserverAdmissionControllerAdmissionDurationSeconds,
monitoringMetricApiserverAdmissionWebhookAdmissionDurationSeconds,
monitoringMetricApiserverAdmissionStepAdmissionDurationSeconds,
monitoringMetricApiserverAdmissionWebhookRejectionCount,
monitoringMetricApiserverAuditEventTotal,
monitoringMetricApiserverAuditErrorTotal,
monitoringMetricApiserverAuditRequestsRejectedTotal,
monitoringMetricApiserverLatencySeconds,
monitoringMetricApiserverCRDWebhookConversionDurationSeconds,
monitoringMetricApiserverCurrentInflightRequests,
monitoringMetricApiserverCurrentInqueueRequests,
monitoringMetricApiserverLongrunningRequests,
monitoringMetricApiserverResponseSizes,
monitoringMetricApiserverRegisteredWatchers,
monitoringMetricApiserverRequestDurationSeconds,
monitoringMetricApiserverRequestTerminationsTotal,
monitoringMetricApiserverRequestTotal,
monitoringMetricApiserverRequestCount,
monitoringMetricApiserverStorageTransformationDurationSeconds,
monitoringMetricApiserverStorageTransformationOperationsTotal,
monitoringMetricApiserverInitEventsTotal,
monitoringMetricApiserverWatchEventsSizes,
monitoringMetricApiserverWatchEventsTotal,
monitoringMetricEtcdDbTotalSizeInBytes,
monitoringMetricApiserverStorageDbTotalSizeInBytes,
monitoringMetricApiserverStorageSizeBytes,
monitoringMetricEtcdObjectCounts,
monitoringMetricApiserverStorageObjects,
monitoringMetricEtcdRequestDurationSeconds,
monitoringMetricGo,
monitoringMetricProcessMaxFds,
monitoringMetricProcessOpenFds,
monitoringMetricWatchCacheCapacityIncreaseTotal,
monitoringMetricWatchCacheCapacityDecreaseTotal,
monitoringMetricWatchCacheCapacity,
monitoringmetricApiserverCacheList,
monitoringmetricApiserverStorageList,
}
// TODO: Replace below hard-coded paths to Prometheus certificates once its deployment has been refactored.
monitoringScrapeConfigTmpl = `job_name: ` + monitoringPrometheusJobName + `
scheme: https
kubernetes_sd_configs:
- role: endpoints
namespaces:
names: [{{ .namespace }}]
tls_config:
insecure_skip_verify: true
authorization:
type: Bearer
credentials_file: /var/run/secrets/gardener.cloud/shoot/token/token
relabel_configs:
- source_labels:
- __meta_kubernetes_service_name
- __meta_kubernetes_endpoint_port_name
action: keep
regex: ` + v1beta1constants.DeploymentNameKubeAPIServer + `;` + ServicePortName + `
- action: labelmap
regex: __meta_kubernetes_service_label_(.+)
- source_labels: [ __meta_kubernetes_pod_name ]
target_label: pod
metric_relabel_configs:
- source_labels: [ __name__ ]
action: keep
regex: ^(` + strings.Join(monitoringAllowedMetrics, "|") + `)$
`
monitoringScrapeConfigTemplate *template.Template
)
func init() {
var err error
monitoringScrapeConfigTemplate, err = template.New("monitoring-scrape-config").Parse(monitoringScrapeConfigTmpl)
utilruntime.Must(err)
}
// ScrapeConfigs returns the scrape configurations for Prometheus.
func (k *kubeAPIServer) ScrapeConfigs() ([]string, error) {
var scrapeConfig bytes.Buffer
if err := monitoringScrapeConfigTemplate.Execute(&scrapeConfig, map[string]interface{}{"namespace": k.namespace}); err != nil {
return nil, err
}
return []string{scrapeConfig.String()}, nil
}
// AlertingRules returns the alerting rules for AlertManager.
func (k *kubeAPIServer) AlertingRules() (map[string]string, error) {
return map[string]string{"kube-apiserver.rules.yaml": monitoringAlertingRules}, nil
}