You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: daprdocs/content/en/operations/resiliency/health-checks/sidecar-health.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,15 @@ description: Dapr sidecar health checks
9
9
Dapr provides a way to determine its health using an [HTTP `/healthz` endpoint]({{% ref health_api.md %}}). With this endpoint, the *daprd* process, or sidecar, can be:
10
10
11
11
- Probed for its overall health
12
-
- Probed for Dapr sidecar readiness during initialization
12
+
- Probed for Dapr sidecar readiness from infrastructure platforms
13
13
- Determined for readiness and liveness with Kubernetes
14
14
15
15
In this guide, you learn how the Dapr `/healthz` endpoint integrates with health probes from the application hosting platform (for example, Kubernetes) as well as the Dapr SDKs.
16
16
17
+
{{% alert title="Important" color="warning" %}}
18
+
**Do not depend on the `/healthz` endpoint in your application code**. Having your application depend on the `/healthz` endpoint will fail for some cases (such as apps using Actor and Workflow APIs) and is considered bad practice in others as it creates a circular dependency. The `/healthz` endpoint is designed for infrastructure health checks (like Kubernetes probes), not for application-level health validation.
19
+
{{% /alert %}}
20
+
17
21
{{% alert title="Note" color="primary" %}}
18
22
Dapr actors also have a health API endpoint where Dapr probes the application for a response to a signal from Dapr that the actor application is healthy and running. See [actor health API]({{% ref "actors_api.md#health-check" %}}).
19
23
{{% /alert %}}
@@ -47,7 +51,6 @@ Currently, the `v1.0/healthz/outbound` endpoint is supported in the:
@@ -128,9 +131,9 @@ Dapr has its HTTP health endpoint `/v1.0/healthz` on port 3500. This can be used
128
131
129
132
## Delay graceful shutdown
130
133
131
-
Dapr accepts a [`dapr.io/block-shutdown-duration` annotation or `--dapr-block-shutdown-duration` CLI flag]({{% ref arguments-annotations-overview.md %}}), which delays the full shutdown procedure for the specified duration, or until the app reports as unhealthy, whichever is sooner.
134
+
Dapr accepts a [`dapr.io/block-shutdown-duration` annotation or `--dapr-block-shutdown-duration` CLI flag]({{% ref arguments-annotations-overview.md %}}), which delays the full shutdown procedure for the specified duration, or until the app reports as unhealthy, whichever is sooner.
132
135
133
-
During this period, all subscriptions and input bindings are closed. This is useful for applications that need to use the Dapr APIs as part of their own shutdown procedure.
136
+
During this period, all subscriptions and input bindings are closed. This is useful for applications that need to use the Dapr APIs as part of their own shutdown procedure.
134
137
135
138
Applicable annotations or CLI flags include:
136
139
@@ -145,4 +148,4 @@ Learn more about these and how to use them in the [Annotations and arguments gui
145
148
146
149
- [Endpoint health API]({{% ref health_api.md %}})
147
150
- [Actor health API]({{% ref "actors_api.md#health-check" %}})
0 commit comments