mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-24 04:06:03 +00:00
Merge pull request #111771 from logicalhan/health-check-metrics
add metrics for health checks (for later use in apiserver)
This commit is contained in:
Kubernetes Prow Robot
GitHub
commit
6e14428e4e
@ -0,0 +1,95 @@
|
||||
/*
|
||||
Copyright 2022 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 health
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
|
||||
k8smetrics "k8s.io/component-base/metrics"
|
||||
"k8s.io/component-base/metrics/legacyregistry"
|
||||
)
|
||||
|
||||
type HealthcheckStatus string
|
||||
|
||||
const (
|
||||
Success HealthcheckStatus = "success"
|
||||
Error HealthcheckStatus = "error"
|
||||
Pending HealthcheckStatus = "pending"
|
||||
)
|
||||
|
||||
type HealthcheckType string
|
||||
|
||||
const (
|
||||
Livez HealthcheckType = "livez"
|
||||
Readyz HealthcheckType = "readyz"
|
||||
Healthz HealthcheckType = "healthz"
|
||||
)
|
||||
|
||||
var (
|
||||
// healthcheck is a Prometheus Gauge metrics used for recording the results of a k8s healthcheck.
|
||||
healthcheck = k8smetrics.NewGaugeVec(
|
||||
&k8smetrics.GaugeOpts{
|
||||
Namespace: "k8s",
|
||||
Name: "healthcheck",
|
||||
Help: "This metric records the result of a single healthcheck.",
|
||||
StabilityLevel: k8smetrics.ALPHA,
|
||||
},
|
||||
[]string{"name", "type", "status"},
|
||||
)
|
||||
|
||||
// healthchecksTotal is a Prometheus Counter metrics used for counting the results of a k8s healthcheck.
|
||||
healthchecksTotal = k8smetrics.NewCounterVec(
|
||||
&k8smetrics.CounterOpts{
|
||||
Namespace: "k8s",
|
||||
Name: "healthchecks_total",
|
||||
Help: "This metric records the results of all healthcheck.",
|
||||
StabilityLevel: k8smetrics.ALPHA,
|
||||
},
|
||||
[]string{"name", "type", "status"},
|
||||
)
|
||||
statuses = []HealthcheckStatus{Success, Error, Pending}
|
||||
statusSet = map[HealthcheckStatus]struct{}{Success: {}, Error: {}, Pending: {}}
|
||||
checkSet = map[HealthcheckType]struct{}{Livez: {}, Readyz: {}, Healthz: {}}
|
||||
)
|
||||
|
||||
func init() {
|
||||
legacyregistry.MustRegister(healthcheck)
|
||||
legacyregistry.MustRegister(healthchecksTotal)
|
||||
}
|
||||
|
||||
func ResetHealthMetrics() {
|
||||
healthcheck.Reset()
|
||||
healthchecksTotal.Reset()
|
||||
}
|
||||
|
||||
func ObserveHealthcheck(ctx context.Context, name string, healthcheckType HealthcheckType, status HealthcheckStatus) error {
|
||||
if _, ok := statusSet[status]; !ok {
|
||||
return errors.New("not a valid healthcheck status")
|
||||
}
|
||||
if _, ok := checkSet[healthcheckType]; !ok {
|
||||
return errors.New("not a valid healthcheck type")
|
||||
}
|
||||
for _, s := range statuses {
|
||||
if status != s {
|
||||
healthcheck.WithContext(ctx).WithLabelValues(name, string(healthcheckType), string(s)).Set(0)
|
||||
}
|
||||
}
|
||||
healthchecksTotal.WithContext(ctx).WithLabelValues(name, string(healthcheckType), string(status)).Inc()
|
||||
healthcheck.WithContext(ctx).WithLabelValues(name, string(healthcheckType), string(status)).Set(1)
|
||||
return nil
|
||||
}
|
||||
@ -0,0 +1,111 @@
|
||||
/*
|
||||
Copyright 2022 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 health
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"k8s.io/component-base/metrics/legacyregistry"
|
||||
"k8s.io/component-base/metrics/testutil"
|
||||
)
|
||||
|
||||
var (
|
||||
testedMetrics = []string{"k8s_healthcheck", "k8s_healthchecks_total"}
|
||||
)
|
||||
|
||||
func TestObserveHealthcheck(t *testing.T) {
|
||||
defer legacyregistry.Reset()
|
||||
defer ResetHealthMetrics()
|
||||
initialState := Error
|
||||
healthcheckName := "healthcheck-a"
|
||||
initialOutput := `
|
||||
# HELP k8s_healthcheck [ALPHA] This metric records the result of a single healthcheck.
|
||||
# TYPE k8s_healthcheck gauge
|
||||
k8s_healthcheck{name="healthcheck-a",status="error",type="healthz"} 1
|
||||
k8s_healthcheck{name="healthcheck-a",status="pending",type="healthz"} 0
|
||||
k8s_healthcheck{name="healthcheck-a",status="success",type="healthz"} 0
|
||||
# HELP k8s_healthchecks_total [ALPHA] This metric records the results of all healthcheck.
|
||||
# TYPE k8s_healthchecks_total counter
|
||||
k8s_healthchecks_total{name="healthcheck-a",status="error",type="healthz"} 1
|
||||
`
|
||||
testCases := []struct {
|
||||
desc string
|
||||
name string
|
||||
hcType HealthcheckType
|
||||
hcStatus HealthcheckStatus
|
||||
want string
|
||||
}{
|
||||
{
|
||||
desc: "test pending",
|
||||
name: healthcheckName,
|
||||
hcType: Healthz,
|
||||
hcStatus: Pending,
|
||||
want: `
|
||||
# HELP k8s_healthcheck [ALPHA] This metric records the result of a single healthcheck.
|
||||
# TYPE k8s_healthcheck gauge
|
||||
k8s_healthcheck{name="healthcheck-a",status="error",type="healthz"} 0
|
||||
k8s_healthcheck{name="healthcheck-a",status="pending",type="healthz"} 1
|
||||
k8s_healthcheck{name="healthcheck-a",status="success",type="healthz"} 0
|
||||
# HELP k8s_healthchecks_total [ALPHA] This metric records the results of all healthcheck.
|
||||
# TYPE k8s_healthchecks_total counter
|
||||
k8s_healthchecks_total{name="healthcheck-a",status="error",type="healthz"} 1
|
||||
k8s_healthchecks_total{name="healthcheck-a",status="pending",type="healthz"} 1
|
||||
`,
|
||||
},
|
||||
{
|
||||
desc: "test success",
|
||||
name: healthcheckName,
|
||||
hcType: Healthz,
|
||||
hcStatus: Success,
|
||||
want: `
|
||||
# HELP k8s_healthcheck [ALPHA] This metric records the result of a single healthcheck.
|
||||
# TYPE k8s_healthcheck gauge
|
||||
k8s_healthcheck{name="healthcheck-a",status="error",type="healthz"} 0
|
||||
k8s_healthcheck{name="healthcheck-a",status="pending",type="healthz"} 0
|
||||
k8s_healthcheck{name="healthcheck-a",status="success",type="healthz"} 1
|
||||
# HELP k8s_healthchecks_total [ALPHA] This metric records the results of all healthcheck.
|
||||
# TYPE k8s_healthchecks_total counter
|
||||
k8s_healthchecks_total{name="healthcheck-a",status="error",type="healthz"} 1
|
||||
k8s_healthchecks_total{name="healthcheck-a",status="success",type="healthz"} 1
|
||||
`,
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range testCases {
|
||||
t.Run(test.desc, func(t *testing.T) {
|
||||
defer ResetHealthMetrics()
|
||||
// let's first record an error as initial state
|
||||
err := ObserveHealthcheck(context.Background(), test.name, test.hcType, initialState)
|
||||
if err != nil {
|
||||
t.Errorf("unexpected err: %v", err)
|
||||
}
|
||||
if err := testutil.GatherAndCompare(legacyregistry.DefaultGatherer, strings.NewReader(initialOutput), testedMetrics...); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
// now record that we successfully purge state
|
||||
err = ObserveHealthcheck(context.Background(), test.name, test.hcType, test.hcStatus)
|
||||
if err != nil {
|
||||
t.Errorf("unexpected err: %v", err)
|
||||
}
|
||||
if err := testutil.GatherAndCompare(legacyregistry.DefaultGatherer, strings.NewReader(test.want), testedMetrics...); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user