Skip to content

Commit 11b03c5

Browse files
javier-aliagaalicejgibbonsmsfussell
authored
Fix health docs (#4758)
* chore: Fix sidecar health endpoints Signed-off-by: Javier Aliaga <[email protected]> * Update daprdocs/content/en/operations/resiliency/health-checks/sidecar-health.md Co-authored-by: Alice Gibbons <[email protected]> Signed-off-by: Javier Aliaga <[email protected]> * chore: Reword sidecar healths probes Signed-off-by: Javier Aliaga <[email protected]> --------- Signed-off-by: Javier Aliaga <[email protected]> Co-authored-by: Alice Gibbons <[email protected]> Co-authored-by: Mark Fussell <[email protected]>
1 parent d942095 commit 11b03c5

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

daprdocs/content/en/operations/resiliency/health-checks/sidecar-health.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,15 @@ description: Dapr sidecar health checks
99
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:
1010

1111
- Probed for its overall health
12-
- Probed for Dapr sidecar readiness during initialization
12+
- Probed for Dapr sidecar readiness from infrastructure platforms
1313
- Determined for readiness and liveness with Kubernetes
1414

1515
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.
1616

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+
1721
{{% alert title="Note" color="primary" %}}
1822
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" %}}).
1923
{{% /alert %}}
@@ -47,7 +51,6 @@ Currently, the `v1.0/healthz/outbound` endpoint is supported in the:
4751
- [.NET SDK]({{% ref "dotnet-client.md#wait-for-sidecar" %}})
4852
- [Java SDK]({{% ref "java-client.md#wait-for-sidecar" %}})
4953
- [Python SDK]({{% ref "python-client.md#health-timeout" %}})
50-
- [JavaScript SDK](https://github.com/dapr/js-sdk/blob/4189a3d2ad6897406abd766f4ccbf2300c8f8852/src/interfaces/Client/IClientHealth.ts#L14)
5154

5255

5356
## Health endpoint: Integration with Kubernetes
@@ -128,9 +131,9 @@ Dapr has its HTTP health endpoint `/v1.0/healthz` on port 3500. This can be used
128131

129132
## Delay graceful shutdown
130133

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.
132135

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.
134137

135138
Applicable annotations or CLI flags include:
136139

@@ -145,4 +148,4 @@ Learn more about these and how to use them in the [Annotations and arguments gui
145148

146149
- [Endpoint health API]({{% ref health_api.md %}})
147150
- [Actor health API]({{% ref "actors_api.md#health-check" %}})
148-
- [Kubernetes probe configuration parameters](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
151+
- [Kubernetes probe configuration parameters](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)

0 commit comments

Comments
 (0)