Skip to content

Update enable health endpoint section #31832

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: may/obs-pipelines-restructure
Choose a base branch
from
Open

Update enable health endpoint section #31832

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions ...ty_pipelines/configuration/install_the_worker/advanced_worker_configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ further_reading:

## Overview

This document explains [bootstrapping](#bootstrap-options) for the Observability Pipelines Worker and how to [enable the liveness and readiness probe](#enable-liveness-and-readiness-probe).
This document explains [bootstrapping](#bootstrap-options) for the Observability Pipelines Worker and how to [enable the health check endpoint and the liveness and readiness probes](#enable-the-health-check-endpoint-and-the-liveness-and-readiness-probes).

## Bootstrap Options

Expand Down Expand Up @@ -105,9 +105,13 @@ The following is a list of bootstrap options, their related pipeline environment
: <li style="list-style-type: '- '">The Observability Pipelines Worker cannot route external requests through reverse proxies, such as HAProxy and NGINX.</li>
: <li style="list-style-type: '- '">The <code>DD_PROXY_HTTP(S)</code> and <code>HTTP(S)_PROXY</code> environment variables need to be already exported in your environment for the Worker to resolve them. They cannot be prepended to the Worker installation script.</li>

## Enable liveness and readiness probe
## Enable the health check endpoint and the liveness and readiness probes

Configure your load balancer's health check with the `/heath` endpoint to check that the Worker is up and running. To expose the `/health` endpoint, you must set `DD_OP_API_ENABLED` to `true` and set the `DD_OP_API_ADDRESS` to `0.0.0.0:8686`. An example configuration:
Configure your load balancer's health check with the `/heath` endpoint to check that the Worker is up and running.

For Kubernetes, the liveness and readiness probes are already enabled in the [helm chart][9] and [values.yaml][10] file.

For other installations such as VM-based ones, you must set `DD_OP_API_ENABLED` to `true` and set the `DD_OP_API_ADDRESS` to `0.0.0.0:8686` to expose the `/health` endpoint. An example configuration:

```
api:
Expand All @@ -127,3 +131,5 @@ api:
[6]: /remote_configuration
[7]: /observability_pipelines/configuration/set_up_pipelines/
[8]: /observability_pipelines/configuration/install_the_worker/worker_commands/#run-tap-or-top-the-worker
[9]: https://github.com/DataDog/helm-charts/blob/main/charts/observability-pipelines-worker/values.yaml#L33-L40
[10]: https://github.com/DataDog/helm-charts/blob/main/charts/observability-pipelines-worker/values.yaml#L303-L329
Loading