kubernetes
/
kube-state-metrics
mirror of https://github.com/kubernetes/kube-state-metrics.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixup! fix: add `readyz` endpoint

This commit is contained in:
Pranshu Srivastava 2024-07-05 18:27:48 +05:30
parent dae1f062c0
commit b980579e08
No known key found for this signature in database
GPG Key ID: 63938388A4528764
9 changed files with 27 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -346,11 +346,11 @@ After running the above, if you see `Clusterrolebinding "cluster-admin-binding"
#### Healthcheck Endpoints
The following healthcheck endpoints are available, some of which are used to determine the result of the aforementioned probes:
The following healthcheck endpoints are available (`self` refers to the telemetry port, while `main` refers to the exposition port):
* `/healthz`: Returns a 200 status code if the application is running. We recommend to use this for the startup probe.
* `/livez`: Returns a 200 status code if the application is not affected by an outage of the Kubernetes API Server. We recommend to using this for the liveness probe.
* `/readyz`: Returns a 200 status code if the application is ready to accept traffic. We recommend using this for the readiness probe.
* `/healthz` (exposed on `main`): Returns a 200 status code if the application is running. We recommend to use this for the startup probe.
* `/livez` (exposed on `main`): Returns a 200 status code if the application is not affected by an outage of the Kubernetes API Server. We recommend to using this for the liveness probe.
* `/readyz` (exposed on `self`): Returns a 200 status code if the application is ready to accept traffic. We recommend using this for the readiness probe.
Note that it is discouraged to use the telemetry metrics endpoint for any probe when proxying the exposition data.

8
README.md.tpl
View File

@ -347,11 +347,11 @@ After running the above, if you see `Clusterrolebinding "cluster-admin-binding"
#### Healthcheck Endpoints
The following healthcheck endpoints are available, some of which are used to determine the result of the aforementioned probes:
The following healthcheck endpoints are available (`self` refers to the telemetry port, while `main` refers to the exposition port):
* `/healthz`: Returns a 200 status code if the application is running. We recommend to use this for the startup probe.
* `/livez`: Returns a 200 status code if the application is not affected by an outage of the Kubernetes API Server. We recommend to using this for the liveness probe.
* `/readyz`: Returns a 200 status code if the application is ready to accept traffic. We recommend using this for the readiness probe.
* `/healthz` (exposed on `main`): Returns a 200 status code if the application is running. We recommend to use this for the startup probe.
* `/livez` (exposed on `main`): Returns a 200 status code if the application is not affected by an outage of the Kubernetes API Server. We recommend to using this for the liveness probe.
* `/readyz` (exposed on `self`): Returns a 200 status code if the application is ready to accept traffic. We recommend using this for the readiness probe.
Note that it is discouraged to use the telemetry metrics endpoint for any probe when proxying the exposition data.

2
examples/autosharding/statefulset.yaml
View File

@ -50,7 +50,7 @@ spec:
readinessProbe:
httpGet:
path: /readyz
port: http-metrics
port: telemetry
initialDelaySeconds: 5
timeoutSeconds: 5
securityContext:

2
examples/daemonsetsharding/daemonset.yaml
View File

@ -45,7 +45,7 @@ spec:
readinessProbe:
httpGet:
path: /readyz
port: http-metrics
port: telemetry
initialDelaySeconds: 5
timeoutSeconds: 5
securityContext:

2
examples/daemonsetsharding/deployment-no-node-pods.yaml
View File

@ -40,7 +40,7 @@ spec:
readinessProbe:
httpGet:
path: /readyz
port: http-metrics
port: telemetry
initialDelaySeconds: 5
timeoutSeconds: 5
securityContext:

2
examples/daemonsetsharding/deployment.yaml
View File

@ -39,7 +39,7 @@ spec:
readinessProbe:
httpGet:
path: /readyz
port: http-metrics
port: telemetry
initialDelaySeconds: 5
timeoutSeconds: 5
securityContext:

2
examples/standard/deployment.yaml
View File

@ -37,7 +37,7 @@ spec:
readinessProbe:
httpGet:
path: /readyz
port: http-metrics
port: telemetry
initialDelaySeconds: 5
timeoutSeconds: 5
securityContext:

2
jsonnet/kube-state-metrics/kube-state-metrics.libsonnet
View File

@ -196,7 +196,7 @@
path: '/livez',
} },
readinessProbe: { timeoutSeconds: 5, initialDelaySeconds: 5, httpGet: {
port: "http-metrics",
port: "telemetry",
path: '/readyz',
} },
};

16
pkg/app/server.go
View File

@ -42,6 +42,7 @@ import (
versionCollector "github.com/prometheus/client_golang/prometheus/collectors/version"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/client_golang/prometheus/testutil"
"github.com/prometheus/common/version"
"github.com/prometheus/exporter-toolkit/web"
@ -377,6 +378,18 @@ func buildTelemetryServer(registry prometheus.Gatherer) *http.ServeMux {
// Add metricsPath
mux.Handle(metricsPath, promhttp.HandlerFor(registry, promhttp.HandlerOpts{ErrorLog: promLogger{}}))
// Add readyzPath
mux.Handle(readyzPath, http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
count, err := testutil.GatherAndCount(registry)
if err != nil || count == 0 {
w.WriteHeader(http.StatusServiceUnavailable)
w.Write([]byte(http.StatusText(http.StatusServiceUnavailable)))
return
}
w.WriteHeader(http.StatusOK)
w.Write([]byte(http.StatusText(http.StatusOK)))
}))
// Add index
landingConfig := web.LandingConfig{
Name: "kube-state-metrics",
@ -426,9 +439,6 @@ func buildMetricsServer(m *metricshandler.MetricsHandler, durationObserver prome
// Add livezPath
mux.Handle(livezPath, handleClusterDelegationForProber(client, livezPath))
// Add readyzPath
mux.Handle(readyzPath, handleClusterDelegationForProber(client, readyzPath))
// Add healthzPath
mux.Handle(healthzPath, handleClusterDelegationForProber(client, healthzPath))