forked from kubernetes/kube-state-metrics
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for the ServiceAccount resource (Ref: kubernetes#1717)
- Loading branch information
1 parent
26c8890
commit 24d5185
Showing
9 changed files
with
349 additions
and
1 deletion.
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
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,11 @@ | ||
| # Service Metrics | ||
|
|
||
| | Metric name | Metric type | Description | Unit (where applicable) | Labels/tags | Status | | ||
| |---------------------------------------|-------------|--------------------------------------------------------------------------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | ||
| | kube_serviceaccount_info | Gauge | Information about a service account | | `namespace`=<serviceaccount-namespace> <br> `serviceaccount`=<serviceaccount-name> <br> `uid`=<serviceaccount-uid> <br> `automount_token`=<serviceaccount-automount-token> | EXPERIMENTAL | | ||
| | kube_serviceaccount_created | Gauge | Unix creation timestamp | | `namespace`=<serviceaccount-namespace> <br> `serviceaccount`=<serviceaccount-name> <br> `uid`=<serviceaccount-uid> | EXPERIMENTAL | | ||
| | kube_serviceaccount_deleted | Gauge | Unix deletion timestamp | | `namespace`=<serviceaccount-namespace> <br> `serviceaccount`=<serviceaccount-name> <br> `uid`=<serviceaccount-uid> | EXPERIMENTAL | | ||
| | kube_serviceaccount_secret | Gauge | Secret being referenced by a service account | | `namespace`=<serviceaccount-namespace> <br> `serviceaccount`=<serviceaccount-name> <br> `uid`=<serviceaccount-uid> <br> `name`=<secret-name> | EXPERIMENTAL | | ||
| | kube_serviceaccount_image_pull_secret | Gauge | Secret being referenced by a service account for the purpose of pulling images | | `namespace`=<serviceaccount-namespace> <br> `serviceaccount`=<serviceaccount-name> <br> `uid`=<serviceaccount-uid> <br> `name`=<secret-name> | EXPERIMENTAL | | ||
| | kube_serviceaccount_annotations | Gauge | Kubernetes annotations converted to Prometheus labels | | `namespace`=<serviceaccount-namespace> <br> `serviceaccount`=<serviceaccount-name> <br> `uid`=<serviceaccount-uid> <br> `annotation_SERVICE_ACCOUNT_ANNOTATION`=<SERVICE_ACCOUNT_ANNOTATION> | EXPERIMENTAL | | ||
| | kube_serviceaccount_labels | Gauge | Kubernetes labels converted to Prometheus labels | | `namespace`=<serviceaccount-namespace> <br> `serviceaccount`=<serviceaccount-name> <br> `uid`=<serviceaccount-uid> <br> `label_SERVICE_ACCOUNT_LABEL`=<SERVICE_ACCOUNT_LABEL> | 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| /* | ||
| 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" | ||
|
|
||
| v1 "k8s.io/api/core/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" | ||
|
|
||
| "k8s.io/kube-state-metrics/v2/pkg/metric" | ||
| generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator" | ||
| ) | ||
|
|
||
| var ( | ||
| descServiceAccountLabelsDefaultLabels = []string{"namespace", "serviceaccount", "uid"} | ||
| ) | ||
|
|
||
| func serviceAccountMetricFamilies(allowAnnotationsList, allowLabelsList []string) []generator.FamilyGenerator { | ||
| return []generator.FamilyGenerator{ | ||
| createServiceAccountInfoFamilyGenerator(), | ||
| createServiceAccountCreatedFamilyGenerator(), | ||
| createServiceAccountDeletedFamilyGenerator(), | ||
| createServiceAccountSecretFamilyGenerator(), | ||
| createServiceAccountImagePullSecretFamilyGenerator(), | ||
| createServiceAccountAnnotationsGenerator(allowAnnotationsList), | ||
| createServiceAccountLabelsGenerator(allowLabelsList), | ||
| } | ||
| } | ||
|
|
||
| func createServiceAccountInfoFamilyGenerator() generator.FamilyGenerator { | ||
| return *generator.NewFamilyGenerator( | ||
| "kube_serviceaccount_info", | ||
| "Information about a service account", | ||
| metric.Gauge, | ||
| "", | ||
| wrapServiceAccountFunc(func(sa *v1.ServiceAccount) *metric.Family { | ||
| var labelKeys []string | ||
| var labelValues []string | ||
|
|
||
| if sa.AutomountServiceAccountToken != nil { | ||
| labelKeys = append(labelKeys, "automount_token") | ||
| labelValues = append(labelValues, strconv.FormatBool(*sa.AutomountServiceAccountToken)) | ||
| } | ||
|
|
||
| return &metric.Family{ | ||
| Metrics: []*metric.Metric{{ | ||
| LabelKeys: labelKeys, | ||
| LabelValues: labelValues, | ||
| Value: 1, | ||
| }}, | ||
| } | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| func createServiceAccountCreatedFamilyGenerator() generator.FamilyGenerator { | ||
| return *generator.NewFamilyGenerator( | ||
| "kube_serviceaccount_created", | ||
| "Unix creation timestamp", | ||
| metric.Gauge, | ||
| "", | ||
| wrapServiceAccountFunc(func(sa *v1.ServiceAccount) *metric.Family { | ||
| var ms []*metric.Metric | ||
|
|
||
| if !sa.CreationTimestamp.IsZero() { | ||
| ms = append(ms, &metric.Metric{ | ||
| LabelKeys: []string{}, | ||
| LabelValues: []string{}, | ||
| Value: float64(sa.CreationTimestamp.Unix()), | ||
| }) | ||
| } | ||
|
|
||
| return &metric.Family{ | ||
| Metrics: ms, | ||
| } | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| func createServiceAccountDeletedFamilyGenerator() generator.FamilyGenerator { | ||
| return *generator.NewFamilyGenerator( | ||
| "kube_serviceaccount_deleted", | ||
| "Unix deletion timestamp", | ||
| metric.Gauge, | ||
| "", | ||
| wrapServiceAccountFunc(func(sa *v1.ServiceAccount) *metric.Family { | ||
| var ms []*metric.Metric | ||
|
|
||
| if sa.DeletionTimestamp != nil && !sa.DeletionTimestamp.IsZero() { | ||
| ms = append(ms, &metric.Metric{ | ||
| LabelKeys: []string{}, | ||
| LabelValues: []string{}, | ||
| Value: float64(sa.DeletionTimestamp.Unix()), | ||
| }) | ||
| } | ||
|
|
||
| return &metric.Family{ | ||
| Metrics: ms, | ||
| } | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| func createServiceAccountSecretFamilyGenerator() generator.FamilyGenerator { | ||
| return *generator.NewFamilyGenerator( | ||
| "kube_serviceaccount_secret", | ||
| "Secret being referenced by a service account", | ||
| metric.Gauge, | ||
| "", | ||
| wrapServiceAccountFunc(func(sa *v1.ServiceAccount) *metric.Family { | ||
| var ms []*metric.Metric | ||
|
|
||
| for _, s := range sa.Secrets { | ||
| ms = append(ms, &metric.Metric{ | ||
| LabelKeys: []string{"name"}, | ||
| LabelValues: []string{s.Name}, | ||
| Value: 1, | ||
| }) | ||
| } | ||
|
|
||
| return &metric.Family{ | ||
| Metrics: ms, | ||
| } | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| func createServiceAccountImagePullSecretFamilyGenerator() generator.FamilyGenerator { | ||
| return *generator.NewFamilyGenerator( | ||
| "kube_serviceaccount_image_pull_secret", | ||
| "Secret being referenced by a service account for the purpose of pulling images", | ||
| metric.Gauge, | ||
| "", | ||
| wrapServiceAccountFunc(func(sa *v1.ServiceAccount) *metric.Family { | ||
| var ms []*metric.Metric | ||
|
|
||
| for _, s := range sa.ImagePullSecrets { | ||
| ms = append(ms, &metric.Metric{ | ||
| LabelKeys: []string{"name"}, | ||
| LabelValues: []string{s.Name}, | ||
| Value: 1, | ||
| }) | ||
| } | ||
|
|
||
| return &metric.Family{ | ||
| Metrics: ms, | ||
| } | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| func createServiceAccountAnnotationsGenerator(allowAnnotations []string) generator.FamilyGenerator { | ||
| return *generator.NewFamilyGenerator( | ||
| "kube_serviceaccount_annotations", | ||
| "Kubernetes annotations converted to Prometheus labels.", | ||
| metric.Gauge, | ||
| "", | ||
| wrapServiceAccountFunc(func(sa *v1.ServiceAccount) *metric.Family { | ||
| annotationKeys, annotationValues := createPrometheusLabelKeysValues("annotation", sa.Annotations, allowAnnotations) | ||
| m := metric.Metric{ | ||
| LabelKeys: annotationKeys, | ||
| LabelValues: annotationValues, | ||
| Value: 1, | ||
| } | ||
| return &metric.Family{ | ||
| Metrics: []*metric.Metric{&m}, | ||
| } | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| func createServiceAccountLabelsGenerator(allowLabelsList []string) generator.FamilyGenerator { | ||
| return *generator.NewFamilyGenerator( | ||
| "kube_serviceaccount_labels", | ||
| "Kubernetes labels converted to Prometheus labels.", | ||
| metric.Gauge, | ||
| "", | ||
| wrapServiceAccountFunc(func(sa *v1.ServiceAccount) *metric.Family { | ||
| labelKeys, labelValues := createPrometheusLabelKeysValues("label", sa.Labels, allowLabelsList) | ||
| m := metric.Metric{ | ||
| LabelKeys: labelKeys, | ||
| LabelValues: labelValues, | ||
| Value: 1, | ||
| } | ||
| return &metric.Family{ | ||
| Metrics: []*metric.Metric{&m}, | ||
| } | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| func wrapServiceAccountFunc(f func(*v1.ServiceAccount) *metric.Family) func(interface{}) *metric.Family { | ||
| return func(obj interface{}) *metric.Family { | ||
| serviceAccount := obj.(*v1.ServiceAccount) | ||
|
|
||
| metricFamily := f(serviceAccount) | ||
|
|
||
| for _, m := range metricFamily.Metrics { | ||
| m.LabelKeys, m.LabelValues = mergeKeyValues(descServiceAccountLabelsDefaultLabels, []string{serviceAccount.Namespace, serviceAccount.Name, string(serviceAccount.UID)}, m.LabelKeys, m.LabelValues) | ||
| } | ||
|
|
||
| return metricFamily | ||
| } | ||
| } | ||
|
|
||
| func createServiceAccountListWatch(kubeClient clientset.Interface, ns string, fieldSelector string) cache.ListerWatcher { | ||
| return &cache.ListWatch{ | ||
| ListFunc: func(opts metav1.ListOptions) (runtime.Object, error) { | ||
| opts.FieldSelector = fieldSelector | ||
| return kubeClient.CoreV1().ServiceAccounts(ns).List(context.TODO(), opts) | ||
| }, | ||
| WatchFunc: func(opts metav1.ListOptions) (watch.Interface, error) { | ||
| opts.FieldSelector = fieldSelector | ||
| return kubeClient.CoreV1().ServiceAccounts(ns).Watch(context.TODO(), opts) | ||
| }, | ||
| } | ||
| } |
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,88 @@ | ||
| /* | ||
| 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 ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| v1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/utils/pointer" | ||
|
|
||
| generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator" | ||
| ) | ||
|
|
||
| func TestServiceAccountStore(t *testing.T) { | ||
| cases := []generateMetricsTestCase{ | ||
| { | ||
| Obj: &v1.ServiceAccount{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "serviceAccountName", | ||
| CreationTimestamp: metav1.Time{Time: time.Unix(1500000000, 0)}, | ||
| DeletionTimestamp: &metav1.Time{Time: time.Unix(3000000000, 0)}, | ||
| Namespace: "serviceAccountNS", | ||
| UID: "serviceAccountUID", | ||
| }, | ||
| AutomountServiceAccountToken: pointer.Bool(true), | ||
| Secrets: []v1.ObjectReference{ | ||
| { | ||
| APIVersion: "v1", | ||
| Kind: "Secret", | ||
| Name: "secretName", | ||
| Namespace: "serviceAccountNS", | ||
| }, | ||
| }, | ||
| ImagePullSecrets: []v1.LocalObjectReference{ | ||
| { | ||
| Name: "imagePullSecretName", | ||
| }, | ||
| }, | ||
| }, | ||
| Want: ` | ||
| # HELP kube_serviceaccount_info Information about a service account | ||
| # HELP kube_serviceaccount_created Unix creation timestamp | ||
| # HELP kube_serviceaccount_deleted Unix deletion timestamp | ||
| # HELP kube_serviceaccount_secret Secret being referenced by a service account | ||
| # HELP kube_serviceaccount_image_pull_secret Secret being referenced by a service account for the purpose of pulling images | ||
| # TYPE kube_serviceaccount_info gauge | ||
| # TYPE kube_serviceaccount_created gauge | ||
| # TYPE kube_serviceaccount_deleted gauge | ||
| # TYPE kube_serviceaccount_secret gauge | ||
| # TYPE kube_serviceaccount_image_pull_secret gauge | ||
| kube_serviceaccount_info{namespace="serviceAccountNS",serviceaccount="serviceAccountName",uid="serviceAccountUID",automount_token="true"} 1 | ||
| kube_serviceaccount_created{namespace="serviceAccountNS",serviceaccount="serviceAccountName",uid="serviceAccountUID"} 1.5e+09 | ||
| kube_serviceaccount_deleted{namespace="serviceAccountNS",serviceaccount="serviceAccountName",uid="serviceAccountUID"} 3e+09 | ||
| kube_serviceaccount_secret{namespace="serviceAccountNS",serviceaccount="serviceAccountName",uid="serviceAccountUID",name="secretName"} 1 | ||
| kube_serviceaccount_image_pull_secret{namespace="serviceAccountNS",serviceaccount="serviceAccountName",uid="serviceAccountUID",name="imagePullSecretName"} 1`, | ||
| MetricNames: []string{ | ||
| "kube_serviceaccount_info", | ||
| "kube_serviceaccount_created", | ||
| "kube_serviceaccount_deleted", | ||
| "kube_serviceaccount_secret", | ||
| "kube_serviceaccount_image_pull_secret", | ||
| }, | ||
| }, | ||
| } | ||
| for i, c := range cases { | ||
| c.Func = generator.ComposeMetricGenFuncs(serviceAccountMetricFamilies(c.AllowAnnotationsList, c.AllowLabelsList)) | ||
| c.Headers = generator.ExtractMetricFamilyHeaders(serviceAccountMetricFamilies(c.AllowAnnotationsList, c.AllowLabelsList)) | ||
| if err := c.run(); err != nil { | ||
| t.Errorf("unexpected collecting result in %vth run:\n%s", i, err) | ||
| } | ||
| } | ||
| } |
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,4 @@ | ||
| apiVersion: v1 | ||
| kind: ServiceAccount | ||
| metadata: | ||
| name: test-service-account |