Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add intitial healthcheck docs #515

Merged
merged 11 commits into from
Sep 16, 2024
25 changes: 25 additions & 0 deletions docs/docs/how-tos/setup-healthcheck.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Overview
dcmcand marked this conversation as resolved.
Show resolved Hide resolved

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
dcmcand marked this conversation as resolved.
Show resolved Hide resolved

# Enabling

Healthchecks are currently considered a beta feature that we are testing. Due to this, they are disabled by default. To enable healthchecks, add the following configuration under the `monitoring` configuration in your `nebari-config.yaml`.

```yaml
monitoring:
healthchecks:
enabled: true
```

# Checking Healthcheck statuses
dcmcand marked this conversation as resolved.
Show resolved Hide resolved

All healthchecks are exported as metrics to Prometheus and can be viewed in Grafana.

For example: To see the uptime for the conda-store service, you can run:

`1 - (sum(count_over_time(kuberhealthy_check{check="dev/conda-store-http-check", status="0"}[30d])) OR vector(0))/(sum(count_over_time(kuberhealthy_check{check="dev/conda-store-http-check", status="1"}[30d])) * 100)`

in Grafana, which will show you the following chart.

![Grafana chart showing the uptime for conda store](/img/how-tos/nebari-healthchecks.png)
dcmcand marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ module.exports = {
"how-tos/nebari-extension-system",
"how-tos/telemetry",
"how-tos/setup-monitoring",
"how-tos/setup-healthcheck",
"how-tos/access-logs-loki",
"how-tos/use-gpus",
"how-tos/develop-local-packages",
Expand Down
Binary file added docs/static/img/how-tos/nebari-healthchecks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading