| 1 |
/* |
| 2 |
Copyright 2025 The Kubernetes Authors. |
| 3 |
|
| 4 |
Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 |
you may not use this file except in compliance with the License. |
| 6 |
You may obtain a copy of the License at |
| 7 |
|
| 8 |
http://www.apache.org/licenses/LICENSE-2.0 |
| 9 |
|
| 10 |
Unless required by applicable law or agreed to in writing, software |
| 11 |
distributed under the License is distributed on an "AS IS" BASIS, |
| 12 |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 |
See the License for the specific language governing permissions and |
| 14 |
limitations under the License. |
| 15 |
*/ |
| 16 |
|
| 17 |
package validation |
| 18 |
|
| 19 |
import ( |
| 20 |
"k8s.io/component-base/metrics" |
| 21 |
"k8s.io/component-base/metrics/legacyregistry" |
| 22 |
) |
| 23 |
|
| 24 |
const ( |
| 25 |
namespace = "apiserver" // Keep it consistent; apiserver is handling it |
| 26 |
subsystem = "validation" |
| 27 |
) |
| 28 |
|
| 29 |
// ValidationMetrics is the interface for validation metrics. |
| 30 |
type ValidationMetrics interface { |
| 31 |
IncDeclarativeValidationMismatchMetric() |
| 32 |
IncDeclarativeValidationPanicMetric() |
| 33 |
Reset() |
| 34 |
} |
| 35 |
|
| 36 |
var validationMetricsInstance = &validationMetrics{ |
| 37 |
DeclarativeValidationMismatchCounter: metrics.NewCounter( |
| 38 |
&metrics.CounterOpts{ |
| 39 |
Namespace: namespace, |
| 40 |
Subsystem: subsystem, |
| 41 |
Name: "declarative_validation_mismatch_total", |
| 42 |
Help: "Number of times declarative validation results differed from handwritten validation results for core types.", |
| 43 |
StabilityLevel: metrics.BETA, |
| 44 |
}, |
| 45 |
), |
| 46 |
DeclarativeValidationPanicCounter: metrics.NewCounter( |
| 47 |
&metrics.CounterOpts{ |
| 48 |
Namespace: namespace, |
| 49 |
Subsystem: subsystem, |
| 50 |
Name: "declarative_validation_panic_total", |
| 51 |
Help: "Number of times declarative validation has panicked during validation.", |
| 52 |
StabilityLevel: metrics.BETA, |
| 53 |
}, |
| 54 |
), |
| 55 |
} |
| 56 |
|
| 57 |
// Metrics provides access to validation metrics. |
| 58 |
var Metrics ValidationMetrics = validationMetricsInstance |
| 59 |
|
| 60 |
func init() { |
| 61 |
legacyregistry.MustRegister(validationMetricsInstance.DeclarativeValidationMismatchCounter) |
| 62 |
legacyregistry.MustRegister(validationMetricsInstance.DeclarativeValidationPanicCounter) |
| 63 |
} |
| 64 |
|
| 65 |
type validationMetrics struct { |
| 66 |
DeclarativeValidationMismatchCounter *metrics.Counter |
| 67 |
DeclarativeValidationPanicCounter *metrics.Counter |
| 68 |
} |
| 69 |
|
| 70 |
// Reset resets the validation metrics. |
| 71 |
func (m *validationMetrics) Reset() { |
| 72 |
m.DeclarativeValidationMismatchCounter.Reset() |
| 73 |
m.DeclarativeValidationPanicCounter.Reset() |
| 74 |
} |
| 75 |
|
| 76 |
// IncDeclarativeValidationMismatchMetric increments the counter for the declarative_validation_mismatch_total metric. |
| 77 |
func (m *validationMetrics) IncDeclarativeValidationMismatchMetric() { |
| 78 |
m.DeclarativeValidationMismatchCounter.Inc() |
| 79 |
} |
| 80 |
|
| 81 |
// IncDeclarativeValidationPanicMetric increments the counter for the declarative_validation_panic_total metric. |
| 82 |
func (m *validationMetrics) IncDeclarativeValidationPanicMetric() { |
| 83 |
m.DeclarativeValidationPanicCounter.Inc() |
| 84 |
} |
| 85 |
|
| 86 |
func ResetValidationMetricsInstance() { |
| 87 |
validationMetricsInstance.Reset() |
| 88 |
} |