Skip to content

Commit

Permalink
Update docs/sources/reference/http/_index.md
Browse files Browse the repository at this point in the history
Co-authored-by: Clayton Cornell <[email protected]>
  • Loading branch information
ptodev and clayton-cornell authored Dec 2, 2024
1 parent 91659a0 commit dec0c62
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/sources/reference/http/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ unhealthy components: math.add
```

{{< admonition type="note" >}}
The `/-/healthy` endpoint is not suitable for a [Kubernetes liveness probe][k8s-liveness].
The `/-/healthy` endpoint isn't suitable for a [Kubernetes liveness probe][k8s-liveness].

An Alloy instance which reports as unhealthy should not necessarily be restarted.
For example, a component may be unhealthy due to invalid configuration or due to an unavailable external resource.
An {{< param "PRODUCT_NAME" >}} instance that reports as unhealthy should not necessarily be restarted.
For example, a component may be unhealthy due to an invalid configuration or an unavailable external resource.
In this case, restarting {{< param "PRODUCT_NAME" >}} would not fix the problem.
A restart may even make it worse, because it would could stop the flow of telemetry in healthy pipelines.
A restart may make it worse, because it would could stop the flow of telemetry in healthy pipelines.

[k8s-liveness]: https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/
{{< /admonition >}}
Expand Down

0 comments on commit dec0c62

Please sign in to comment.