chore: add labels to metrics #1433
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,80 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
|
|
||
| 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 controllers | ||
|
|
||
| import ( | ||
| "context" | ||
| "runtime" | ||
|
|
||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/metric" | ||
| "go.opentelemetry.io/otel/metric/global" | ||
| ) | ||
|
|
||
| const ( | ||
| scope = "sigs.k8s.io/secrets-store-csi-driver" | ||
| ) | ||
|
|
||
| var ( | ||
| providerKey = "provider" | ||
| osTypeKey = "os_type" | ||
| runtimeOS = runtime.GOOS | ||
| namespaceKey = "namespace" | ||
| spcKey = "secret_provider_class" | ||
| ) | ||
|
|
||
| type reporter struct { | ||
| syncK8sSecretTotal metric.Int64Counter | ||
| syncK8sSecretDuration metric.Float64Histogram | ||
| } | ||
|
|
||
| type StatsReporter interface { | ||
| ReportSyncSecretCtMetric(ctx context.Context, provider, namespace, spc string) | ||
| ReportSyncSecretDuration(ctx context.Context, duration float64) | ||
| } | ||
|
|
||
| func newStatsReporter() (StatsReporter, error) { | ||
| var err error | ||
|
|
||
| r := &reporter{} | ||
| meter := global.Meter(scope) | ||
|
|
||
| if r.syncK8sSecretTotal, err = meter.Int64Counter("sync_k8s_secret", metric.WithDescription("Total number of k8s secrets synced")); err != nil { | ||
| return nil, err | ||
| } | ||
| if r.syncK8sSecretDuration, err = meter.Float64Histogram("sync_k8s_secret_duration_sec", metric.WithDescription("Distribution of how long it took to sync k8s secret")); err != nil { | ||
| return nil, err | ||
| } | ||
| return r, nil | ||
| } | ||
|
|
||
| func (r reporter) ReportSyncSecretCtMetric(ctx context.Context, provider, namespace, spc string) { | ||
| opt := metric.WithAttributes( | ||
| attribute.Key(providerKey).String(provider), | ||
| attribute.Key(osTypeKey).String(runtimeOS), | ||
| attribute.Key(namespaceKey).String(namespace), | ||
|
There was a problem hiding this comment. Don't use attributes with unbounded value domains (kubernetes/kubernetes#102523) |
||
| attribute.Key(spcKey).String(spc), | ||
| ) | ||
| r.syncK8sSecretTotal.Add(ctx, 1, opt) | ||
| } | ||
|
|
||
| func (r reporter) ReportSyncSecretDuration(ctx context.Context, duration float64) { | ||
| opt := metric.WithAttributes( | ||
| attribute.Key(osTypeKey).String(runtimeOS), | ||
|
Comment on lines
+76
to
+77
|
||
| ) | ||
| r.syncK8sSecretDuration.Record(ctx, duration, opt) | ||
| } | ||
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
Oops, something went wrong.
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.
The os key attribute is not relevant for the sync controller because it's a Kubernetes API object. The only reason it's used in driver metrics is to show the os runtime for the mount operation.