Add Metrics for EndpointSlices #1910
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Endpoint Metrics | ||
|
|
||
| | Metric name| Metric type | Labels/tags | Status | | ||
| | ---------- | ----------- | ----------- | ----------- | | ||
| | kube_endpointslice_annotations | Gauge | `endpointslice`=<endpointslice-name> <br> `namespace`=<endpointslice-namespace> <br> `annotation_ENDPOINTSLICE_ANNOTATION`=<ENDPOINTSLICE_ANNOTATION> | EXPERIMENTAL | | ||
| | kube_endpointslice_info | Gauge | `endpointslice`=<endpointslice-name> <br> `namespace`=<endpointslice-namespace> | EXPERIMENTAL | | ||
| | kube_endpointslice_ports | Gauge | `endpointslice`=<endpointslice-name> <br> `namespace`=<endpointslice-namespace> <br> `port_name`=<endpointslice-port-name> <br> `port_protocol`=<endpointslice-port-protocol> <br> `port_number`=<endpointslice-port-number> | EXPERIMENTAL | | ||
| | kube_endpointslice_endpoints | Gauge | `endpointslice`=<endpointslice-name> <br> `namespace`=<endpointslice-namespace> <br> `ready`=<endpointslice-ready> <br> `serving`=<endpointslice-serving> <br> `terminating`=<endpointslice-terminating> <br> `hostname`=<endpointslice-hostname> <br> `targetref_kind`=<endpointslice-targetref-kind> <br> `targetref_name`=<endpointslice-targetref-name> <br> `targetref_namespace`=<endpointslice-targetref-namespace> <br> `nodename`=<endpointslice-nodename> <br> `endpoint_zone`=<endpointslice-zone> | EXPERIMENTAL | | ||
| | kube_endpointslice_labels | Gauge | `endpointslice`=<endpointslice-name> <br> `namespace`=<endpointslice-namespace> <br> `label_ENDPOINTSLICE_LABEL`=<ENDPOINTSLICE_LABEL> | EXPERIMENTAL | | ||
| | kube_endpointslice_created | Gauge | `endpointslice`=<endpointslice-name> <br> `namespace`=<endpointslice-namespace> | EXPERIMENTAL | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,234 @@ | ||||||
| /* | ||||||
| Copyright 2022 The Kubernetes Authors All rights reserved. | ||||||
| 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 store | ||||||
|
|
||||||
| import ( | ||||||
| "context" | ||||||
| "strconv" | ||||||
|
|
||||||
| basemetrics "k8s.io/component-base/metrics" | ||||||
|
|
||||||
| "k8s.io/kube-state-metrics/v2/pkg/metric" | ||||||
| generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator" | ||||||
|
|
||||||
| discoveryv1 "k8s.io/api/discovery/v1" | ||||||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||||||
| "k8s.io/apimachinery/pkg/runtime" | ||||||
| "k8s.io/apimachinery/pkg/watch" | ||||||
| clientset "k8s.io/client-go/kubernetes" | ||||||
| "k8s.io/client-go/tools/cache" | ||||||
| ) | ||||||
|
|
||||||
| var ( | ||||||
| descEndpointSliceAnnotationsName = "kube_endpointslice_annotations" | ||||||
| descEndpointSliceAnnotationsHelp = "Kubernetes annotations converted to Prometheus labels." | ||||||
| descEndpointSliceLabelsName = "kube_endpointslice_labels" | ||||||
| descEndpointSliceLabelsHelp = "Kubernetes labels converted to Prometheus labels." | ||||||
| descEndpointSliceLabelsDefaultLabels = []string{"endpointslice"} | ||||||
| ) | ||||||
|
|
||||||
| func endpointSliceMetricFamilies(allowAnnotationsList, allowLabelsList []string) []generator.FamilyGenerator { | ||||||
| return []generator.FamilyGenerator{ | ||||||
| *generator.NewFamilyGeneratorWithStability( | ||||||
| "kube_endpointslice_info", | ||||||
| "Information about endpointslice.", | ||||||
| metric.Gauge, | ||||||
| basemetrics.ALPHA, | ||||||
| "", | ||||||
| wrapEndpointSliceFunc(func(s *discoveryv1.EndpointSlice) *metric.Family { | ||||||
|
|
||||||
| m := metric.Metric{ | ||||||
| LabelKeys: []string{"addresstype"}, | ||||||
| LabelValues: []string{string(s.AddressType)}, | ||||||
| Value: 1, | ||||||
| } | ||||||
| return &metric.Family{Metrics: []*metric.Metric{&m}} | ||||||
| }), | ||||||
| ), | ||||||
| *generator.NewFamilyGeneratorWithStability( | ||||||
| "kube_endpointslice_created", | ||||||
| "Unix creation timestamp", | ||||||
| metric.Gauge, | ||||||
| basemetrics.ALPHA, | ||||||
| "", | ||||||
| wrapEndpointSliceFunc(func(s *discoveryv1.EndpointSlice) *metric.Family { | ||||||
| ms := []*metric.Metric{} | ||||||
| if !s.CreationTimestamp.IsZero() { | ||||||
| ms = append(ms, &metric.Metric{ | ||||||
| Value: float64(s.CreationTimestamp.Unix()), | ||||||
| }) | ||||||
| } | ||||||
| return &metric.Family{ | ||||||
| Metrics: ms, | ||||||
| } | ||||||
| }), | ||||||
| ), | ||||||
| *generator.NewFamilyGeneratorWithStability( | ||||||
| "kube_endpointslice_endpoints", | ||||||
| "Endpoints attached to the endpointslice.", | ||||||
| metric.Gauge, | ||||||
| basemetrics.ALPHA, | ||||||
| "", | ||||||
| wrapEndpointSliceFunc(func(e *discoveryv1.EndpointSlice) *metric.Family { | ||||||
| m := []*metric.Metric{} | ||||||
| for _, ep := range e.Endpoints { | ||||||
| var ( | ||||||
| labelKeys, | ||||||
| labelValues []string | ||||||
| ) | ||||||
|
|
||||||
| if ep.Conditions.Ready != nil { | ||||||
| labelKeys = append(labelKeys, "ready") | ||||||
| labelValues = append(labelValues, strconv.FormatBool(*ep.Conditions.Ready)) | ||||||
| } | ||||||
| if ep.Conditions.Serving != nil { | ||||||
| labelKeys = append(labelKeys, "serving") | ||||||
| labelValues = append(labelValues, strconv.FormatBool(*ep.Conditions.Serving)) | ||||||
| } | ||||||
| if ep.Conditions.Terminating != nil { | ||||||
| labelKeys = append(labelKeys, "terminating") | ||||||
| labelValues = append(labelValues, strconv.FormatBool(*ep.Conditions.Terminating)) | ||||||
| } | ||||||
|
|
||||||
| if ep.Hostname != nil { | ||||||
| labelKeys = append(labelKeys, "hostname") | ||||||
| labelValues = append(labelValues, *ep.Hostname) | ||||||
| } | ||||||
|
|
||||||
| if ep.TargetRef != nil { | ||||||
| if ep.TargetRef.Kind != "" { | ||||||
| labelKeys = append(labelKeys, "targetref_kind") | ||||||
| labelValues = append(labelValues, ep.TargetRef.Kind) | ||||||
| } | ||||||
| if ep.TargetRef.Name != "" { | ||||||
| labelKeys = append(labelKeys, "targetref_name") | ||||||
| labelValues = append(labelValues, ep.TargetRef.Name) | ||||||
| } | ||||||
| if ep.TargetRef.Namespace != "" { | ||||||
| labelKeys = append(labelKeys, "targetref_namespace") | ||||||
| labelValues = append(labelValues, ep.TargetRef.Namespace) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| if ep.NodeName != nil { | ||||||
| labelKeys = append(labelKeys, "endpoint_nodename") | ||||||
| labelValues = append(labelValues, *ep.NodeName) | ||||||
| } | ||||||
|
|
||||||
| if ep.Zone != nil { | ||||||
| labelKeys = append(labelKeys, "endpoint_zone") | ||||||
| labelValues = append(labelValues, *ep.Zone) | ||||||
| } | ||||||
| labelKeys = append(labelKeys, "address") | ||||||
| for _, address := range ep.Addresses { | ||||||
| newlabelValues := make([]string, len(labelValues)) | ||||||
| copy(newlabelValues, labelValues) | ||||||
| m = append(m, &metric.Metric{ | ||||||
| LabelKeys: labelKeys, | ||||||
| LabelValues: append(newlabelValues, address), | ||||||
| Value: 1, | ||||||
| }) | ||||||
| } | ||||||
| } | ||||||
| return &metric.Family{ | ||||||
| Metrics: m, | ||||||
| } | ||||||
| }), | ||||||
| ), | ||||||
|
|
||||||
| *generator.NewFamilyGeneratorWithStability( | ||||||
| "kube_endpointslice_ports", | ||||||
| "Ports attached to the endpointslice.", | ||||||
| metric.Gauge, | ||||||
| basemetrics.ALPHA, | ||||||
| "", | ||||||
| wrapEndpointSliceFunc(func(e *discoveryv1.EndpointSlice) *metric.Family { | ||||||
| m := []*metric.Metric{} | ||||||
| for _, port := range e.Ports { | ||||||
| m = append(m, &metric.Metric{ | ||||||
| LabelValues: []string{*port.Name, string(*port.Protocol), strconv.FormatInt(int64(*port.Port), 10)}, | ||||||
| LabelKeys: []string{"port_name", "port_protocol", "port_number"}, | ||||||
|
There was a problem hiding this comment.
Suggested change
Prefixing the labels by There was a problem hiding this comment. I noticed afterward that we inherit that choice from the endpoint metrics: https://github.com/kubernetes/kube-state-metrics/blob/master/docs/endpoint-metrics.md. There is not much we can do about it anymore I guess. There was a problem hiding this comment. Yep, initially I would have preferred to keep it shorter as well, then decided to stay consistent with endpoints. |
||||||
| Value: 1, | ||||||
| }) | ||||||
| } | ||||||
| return &metric.Family{ | ||||||
| Metrics: m, | ||||||
| } | ||||||
| }), | ||||||
| ), | ||||||
| *generator.NewFamilyGeneratorWithStability( | ||||||
| descEndpointSliceAnnotationsName, | ||||||
| descEndpointSliceAnnotationsHelp, | ||||||
| metric.Gauge, | ||||||
| basemetrics.ALPHA, | ||||||
| "", | ||||||
| wrapEndpointSliceFunc(func(s *discoveryv1.EndpointSlice) *metric.Family { | ||||||
| annotationKeys, annotationValues := createPrometheusLabelKeysValues("annotation", s.Annotations, allowAnnotationsList) | ||||||
| return &metric.Family{ | ||||||
| Metrics: []*metric.Metric{ | ||||||
| { | ||||||
| LabelKeys: annotationKeys, | ||||||
| LabelValues: annotationValues, | ||||||
| Value: 1, | ||||||
| }, | ||||||
| }, | ||||||
| } | ||||||
| }), | ||||||
| ), | ||||||
| *generator.NewFamilyGeneratorWithStability( | ||||||
| descEndpointSliceLabelsName, | ||||||
| descEndpointSliceLabelsHelp, | ||||||
| metric.Gauge, | ||||||
| basemetrics.ALPHA, | ||||||
| "", | ||||||
| wrapEndpointSliceFunc(func(s *discoveryv1.EndpointSlice) *metric.Family { | ||||||
| labelKeys, labelValues := createPrometheusLabelKeysValues("label", s.Labels, allowLabelsList) | ||||||
| return &metric.Family{ | ||||||
| Metrics: []*metric.Metric{ | ||||||
| { | ||||||
| LabelKeys: labelKeys, | ||||||
| LabelValues: labelValues, | ||||||
| Value: 1, | ||||||
| }, | ||||||
| }, | ||||||
| } | ||||||
| }), | ||||||
| ), | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func wrapEndpointSliceFunc(f func(*discoveryv1.EndpointSlice) *metric.Family) func(interface{}) *metric.Family { | ||||||
| return func(obj interface{}) *metric.Family { | ||||||
| endpointSlice := obj.(*discoveryv1.EndpointSlice) | ||||||
|
|
||||||
| metricFamily := f(endpointSlice) | ||||||
|
|
||||||
| for _, m := range metricFamily.Metrics { | ||||||
| m.LabelKeys, m.LabelValues = mergeKeyValues(descEndpointSliceLabelsDefaultLabels, []string{endpointSlice.Name}, m.LabelKeys, m.LabelValues) | ||||||
| } | ||||||
|
|
||||||
| return metricFamily | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func createEndpointSliceListWatch(kubeClient clientset.Interface, ns string, fieldSelector string) cache.ListerWatcher { | ||||||
| return &cache.ListWatch{ | ||||||
| ListFunc: func(opts metav1.ListOptions) (runtime.Object, error) { | ||||||
| return kubeClient.DiscoveryV1().EndpointSlices(ns).List(context.TODO(), opts) | ||||||
| }, | ||||||
| WatchFunc: func(opts metav1.ListOptions) (watch.Interface, error) { | ||||||
| return kubeClient.DiscoveryV1().EndpointSlices(ns).Watch(context.TODO(), opts) | ||||||
| }, | ||||||
| } | ||||||
| } | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we are plumbing too maybe information inside of this metric. What would you think about moving the conditions, targetref and addresses into their own metrics? There are some precedence to that kind of split with statuses metrics and
kube_endpoint_address.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I decided to combine everything in it that is in https://pkg.go.dev/k8s.io/api/discovery/v1#Endpoint (which is used in
https://pkg.go.dev/k8s.io/api/discovery/v1#EndpointSlice). This would make it easier for users to query it instead of combining two or more metrics. Do you see any downsides?