feature: added AdmissionController metrics (#7711)
* feature: added AdmissionController metrics * fix: flag control on admissionCollector * fix: admission collector disclaimer year and linting
This commit is contained in:
FBLGit
GitHub
parent
43c22c4914
commit
a5bab6a715
7 changed files with 333 additions and 14 deletions
157
internal/ingress/metric/collectors/admission.go
Normal file
157
internal/ingress/metric/collectors/admission.go
Normal file
|
|
@ -0,0 +1,157 @@
|
|||
/*
|
||||
Copyright 2021 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 collectors
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
"k8s.io/klog/v2"
|
||||
)
|
||||
|
||||
// AdmissionCollector stores prometheus metrics of the admission webhook
|
||||
type AdmissionCollector struct {
|
||||
prometheus.Collector
|
||||
|
||||
testedIngressLength prometheus.Gauge
|
||||
testedIngressTime prometheus.Gauge
|
||||
|
||||
renderingIngressLength prometheus.Gauge
|
||||
renderingIngressTime prometheus.Gauge
|
||||
|
||||
admissionTime prometheus.Gauge
|
||||
|
||||
testedConfigurationSize prometheus.Gauge
|
||||
|
||||
constLabels prometheus.Labels
|
||||
labels prometheus.Labels
|
||||
}
|
||||
|
||||
// NewAdmissionCollector creates a new AdmissionCollector instance for the admission collector
|
||||
func NewAdmissionCollector(pod, namespace, class string) *AdmissionCollector {
|
||||
constLabels := prometheus.Labels{
|
||||
"controller_namespace": namespace,
|
||||
"controller_class": class,
|
||||
"controller_pod": pod,
|
||||
}
|
||||
|
||||
am := &AdmissionCollector{
|
||||
constLabels: constLabels,
|
||||
|
||||
labels: prometheus.Labels{
|
||||
"namespace": namespace,
|
||||
"class": class,
|
||||
},
|
||||
|
||||
testedIngressLength: prometheus.NewGauge(
|
||||
prometheus.GaugeOpts{
|
||||
Name: "admission_tested_ingresses",
|
||||
Help: "The length of ingresses processed by the admission controller",
|
||||
Namespace: PrometheusNamespace,
|
||||
ConstLabels: constLabels,
|
||||
}),
|
||||
testedIngressTime: prometheus.NewGauge(
|
||||
prometheus.GaugeOpts{
|
||||
Name: "admission_tested_duration",
|
||||
Help: "The processing duration of the admission controller tests (float seconds)",
|
||||
Namespace: PrometheusNamespace,
|
||||
ConstLabels: constLabels,
|
||||
}),
|
||||
renderingIngressLength: prometheus.NewGauge(
|
||||
prometheus.GaugeOpts{
|
||||
Name: "admission_render_ingresses",
|
||||
Help: "The length of ingresses rendered by the admission controller",
|
||||
Namespace: PrometheusNamespace,
|
||||
ConstLabels: constLabels,
|
||||
}),
|
||||
renderingIngressTime: prometheus.NewGauge(
|
||||
prometheus.GaugeOpts{
|
||||
Name: "admission_render_duration",
|
||||
Help: "The processing duration of ingresses rendering by the admission controller (float seconds)",
|
||||
Namespace: PrometheusNamespace,
|
||||
ConstLabels: constLabels,
|
||||
}),
|
||||
testedConfigurationSize: prometheus.NewGauge(
|
||||
prometheus.GaugeOpts{
|
||||
Namespace: PrometheusNamespace,
|
||||
Name: "admission_config_size",
|
||||
Help: "The size of the tested configuration",
|
||||
ConstLabels: constLabels,
|
||||
}),
|
||||
admissionTime: prometheus.NewGauge(
|
||||
prometheus.GaugeOpts{
|
||||
Name: "admission_roundtrip_duration",
|
||||
Help: "The complete duration of the admission controller at the time to process a new event (float seconds)",
|
||||
Namespace: PrometheusNamespace,
|
||||
ConstLabels: constLabels,
|
||||
}),
|
||||
}
|
||||
return am
|
||||
}
|
||||
|
||||
// Describe implements prometheus.Collector
|
||||
func (am AdmissionCollector) Describe(ch chan<- *prometheus.Desc) {
|
||||
am.testedIngressLength.Describe(ch)
|
||||
am.testedIngressTime.Describe(ch)
|
||||
am.renderingIngressLength.Describe(ch)
|
||||
am.renderingIngressTime.Describe(ch)
|
||||
am.testedConfigurationSize.Describe(ch)
|
||||
am.admissionTime.Describe(ch)
|
||||
}
|
||||
|
||||
// Collect implements the prometheus.Collector interface.
|
||||
func (am AdmissionCollector) Collect(ch chan<- prometheus.Metric) {
|
||||
am.testedIngressLength.Collect(ch)
|
||||
am.testedIngressTime.Collect(ch)
|
||||
am.renderingIngressLength.Collect(ch)
|
||||
am.renderingIngressTime.Collect(ch)
|
||||
am.testedConfigurationSize.Collect(ch)
|
||||
am.admissionTime.Collect(ch)
|
||||
}
|
||||
|
||||
// ByteFormat formats humanReadable bytes
|
||||
func ByteFormat(bytes int64) string {
|
||||
const unit = 1000
|
||||
if bytes < unit {
|
||||
return fmt.Sprintf("%d B", bytes)
|
||||
}
|
||||
div, exp := int64(unit), 0
|
||||
for n := bytes / unit; n >= unit; n /= unit {
|
||||
div *= unit
|
||||
exp++
|
||||
}
|
||||
return fmt.Sprintf("%.1f%cB",
|
||||
float64(bytes)/float64(div), "kMGTPE"[exp])
|
||||
}
|
||||
|
||||
// SetAdmissionMetrics sets the values for AdmissionMetrics that can be called externally
|
||||
func (am *AdmissionCollector) SetAdmissionMetrics(testedIngressLength float64, testedIngressTime float64, renderingIngressLength float64, renderingIngressTime float64, testedConfigurationSize float64, admissionTime float64) {
|
||||
am.testedIngressLength.Set(testedIngressLength)
|
||||
am.testedIngressTime.Set(testedIngressTime)
|
||||
am.renderingIngressLength.Set(renderingIngressLength)
|
||||
am.renderingIngressTime.Set(renderingIngressTime)
|
||||
am.testedConfigurationSize.Set(testedConfigurationSize)
|
||||
am.admissionTime.Set(admissionTime)
|
||||
klog.Infof("processed ingress via admission controller {testedIngressLength:%v testedIngressTime:%vs renderingIngressLength:%v renderingIngressTime:%vs admissionTime:%vs testedConfigurationSize:%v}",
|
||||
testedIngressLength,
|
||||
testedIngressTime,
|
||||
renderingIngressLength,
|
||||
renderingIngressTime,
|
||||
ByteFormat(int64(testedConfigurationSize)),
|
||||
admissionTime,
|
||||
)
|
||||
}
|
||||
122
internal/ingress/metric/collectors/admission_test.go
Normal file
122
internal/ingress/metric/collectors/admission_test.go
Normal file
|
|
@ -0,0 +1,122 @@
|
|||
/*
|
||||
Copyright 2021 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 collectors
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
)
|
||||
|
||||
func TestAdmissionCounters(t *testing.T) {
|
||||
const (
|
||||
metadataFirst = `
|
||||
# HELP nginx_ingress_controller_admission_config_size The size of the tested configuration
|
||||
# TYPE nginx_ingress_controller_admission_config_size gauge
|
||||
# HELP nginx_ingress_controller_admission_roundtrip_duration The complete duration of the admission controller at the time to process a new event (float seconds)
|
||||
# TYPE nginx_ingress_controller_admission_roundtrip_duration gauge
|
||||
`
|
||||
metadataSecond = `
|
||||
# HELP nginx_ingress_controller_admission_render_ingresses The length of ingresses rendered by the admission controller
|
||||
# TYPE nginx_ingress_controller_admission_render_ingresses gauge
|
||||
# HELP nginx_ingress_controller_admission_tested_duration The processing duration of the admission controller tests (float seconds)
|
||||
# TYPE nginx_ingress_controller_admission_tested_duration gauge
|
||||
`
|
||||
metadataThird = `
|
||||
# HELP nginx_ingress_controller_admission_config_size The size of the tested configuration
|
||||
# TYPE nginx_ingress_controller_admission_config_size gauge
|
||||
# HELP nginx_ingress_controller_admission_render_duration The processing duration of ingresses rendering by the admission controller (float seconds)
|
||||
# TYPE nginx_ingress_controller_admission_render_duration gauge
|
||||
# HELP nginx_ingress_controller_admission_render_ingresses The length of ingresses rendered by the admission controller
|
||||
# TYPE nginx_ingress_controller_admission_render_ingresses gauge
|
||||
# HELP nginx_ingress_controller_admission_roundtrip_duration The complete duration of the admission controller at the time to process a new event (float seconds)
|
||||
# TYPE nginx_ingress_controller_admission_roundtrip_duration gauge
|
||||
# HELP nginx_ingress_controller_admission_tested_ingresses The length of ingresses processed by the admission controller
|
||||
# TYPE nginx_ingress_controller_admission_tested_ingresses gauge
|
||||
# HELP nginx_ingress_controller_admission_tested_duration The processing duration of the admission controller tests (float seconds)
|
||||
# TYPE nginx_ingress_controller_admission_tested_duration gauge
|
||||
`
|
||||
)
|
||||
cases := []struct {
|
||||
name string
|
||||
test func(*AdmissionCollector)
|
||||
metrics []string
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "should return 0 as values on a fresh initiated collector",
|
||||
test: func(am *AdmissionCollector) {
|
||||
},
|
||||
want: metadataFirst + `
|
||||
nginx_ingress_controller_admission_config_size{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 0
|
||||
nginx_ingress_controller_admission_roundtrip_duration{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 0
|
||||
`,
|
||||
metrics: []string{"nginx_ingress_controller_admission_config_size", "nginx_ingress_controller_admission_roundtrip_duration"},
|
||||
},
|
||||
{
|
||||
name: "set admission metrics to 1 in all fields and validate next set",
|
||||
test: func(am *AdmissionCollector) {
|
||||
am.SetAdmissionMetrics(1, 1, 1, 1, 1, 1)
|
||||
},
|
||||
want: metadataSecond + `
|
||||
nginx_ingress_controller_admission_render_ingresses{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 1
|
||||
nginx_ingress_controller_admission_tested_duration{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 1
|
||||
`,
|
||||
metrics: []string{"nginx_ingress_controller_admission_render_ingresses", "nginx_ingress_controller_admission_tested_duration"},
|
||||
},
|
||||
{
|
||||
name: "set admission metrics to 5 in all fields and validate all sets",
|
||||
test: func(am *AdmissionCollector) {
|
||||
am.SetAdmissionMetrics(5, 5, 5, 5, 5, 5)
|
||||
},
|
||||
want: metadataThird + `
|
||||
nginx_ingress_controller_admission_config_size{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 5
|
||||
nginx_ingress_controller_admission_render_duration{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 5
|
||||
nginx_ingress_controller_admission_render_ingresses{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 5
|
||||
nginx_ingress_controller_admission_roundtrip_duration{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 5
|
||||
nginx_ingress_controller_admission_tested_ingresses{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 5
|
||||
nginx_ingress_controller_admission_tested_duration{controller_class="nginx",controller_namespace="default",controller_pod="pod"} 5
|
||||
`,
|
||||
metrics: []string{
|
||||
"nginx_ingress_controller_admission_config_size",
|
||||
"nginx_ingress_controller_admission_render_duration",
|
||||
"nginx_ingress_controller_admission_render_ingresses",
|
||||
"nginx_ingress_controller_admission_roundtrip_duration",
|
||||
"nginx_ingress_controller_admission_tested_ingresses",
|
||||
"nginx_ingress_controller_admission_tested_duration",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
am := NewAdmissionCollector("pod", "default", "nginx")
|
||||
reg := prometheus.NewPedanticRegistry()
|
||||
if err := reg.Register(am); err != nil {
|
||||
t.Errorf("registering collector failed: %s", err)
|
||||
}
|
||||
|
||||
c.test(am)
|
||||
|
||||
if err := GatherAndCompare(am, c.want, c.metrics, reg); err != nil {
|
||||
t.Errorf("unexpected collecting result:\n%s", err)
|
||||
}
|
||||
|
||||
reg.Unregister(am)
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue