Skip to content

Commit 3654bc6

Browse files
committed
update docs
1 parent 88cacd6 commit 3654bc6

File tree

4 files changed

+41
-2
lines changed

4 files changed

+41
-2
lines changed

docs/docs/how-tos/setup-healthcheck.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ description: Set up healthchecks with Kuberhealthy
66

77
::: warning
88

9-
This feature is in beta status. It should be used with caution.
9+
This feature is in beta status. It should be used with caution.
1010

1111
:::
1212

1313
# Overview
1414

15-
Nebari integrates [Kuberhealthy](https://kuberhealthy.github.io/kuberhealthy/) to perform internal healthchecks on Nebari. This is an extensible Kubernetes native framework for continuous synthetic testing. Kuberhealthy is set up to export metrics to
15+
Nebari integrates [Kuberhealthy](https://kuberhealthy.github.io/kuberhealthy/) to perform internal healthchecks on Nebari. This is an extensible Kubernetes native framework for continuous synthetic testing. Kuberhealthy is set up to export metrics to Prometheus. This allows them to be seen in Grafana.
1616

1717
# Enabling
1818

@@ -35,3 +35,10 @@ For example: To see the uptime for the conda-store service, you can run:
3535
in Grafana, which will show you the following chart.
3636

3737
![Grafana chart showing the uptime for conda store](/img/how-tos/nebari-healthchecks.png)
38+
39+
To see what other healthchecks are available, you can use the metric explorer in Grafana. Select the metric type of `kuberhealthy_check` and the label filter of `check`. The values list will be a list of the checks that
40+
have metrics available.
41+
42+
![Display of available kuberhealthy metrics in Grafana](/img/how-tos/nebari-healthchecks1.png)
43+
44+
> Note: if you have previously deployed Nebari without healthchecks, You may need to restart your Prometheus service to get it to pick up the kuberhealthy metrics.
53.6 KB
Loading

package-lock.json

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"devDependencies": {
3+
"prettier": "3.3.3"
4+
}
5+
}

0 commit comments

Comments
 (0)