From c468b9b23f0bfb1c4bc1806dd139657cd74879fc Mon Sep 17 00:00:00 2001 From: May Lee Date: Wed, 24 Sep 2025 15:37:23 -0400 Subject: [PATCH] update --- .../advanced_worker_configurations.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/content/en/observability_pipelines/configuration/install_the_worker/advanced_worker_configurations.md b/content/en/observability_pipelines/configuration/install_the_worker/advanced_worker_configurations.md index 649e8f22ea4d3..32c9cfe74b6c8 100644 --- a/content/en/observability_pipelines/configuration/install_the_worker/advanced_worker_configurations.md +++ b/content/en/observability_pipelines/configuration/install_the_worker/advanced_worker_configurations.md @@ -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 @@ -105,9 +105,13 @@ The following is a list of bootstrap options, their related pipeline environment :
  • The Observability Pipelines Worker cannot route external requests through reverse proxies, such as HAProxy and NGINX.
    • :
  • The DD_PROXY_HTTP(S) and HTTP(S)_PROXY 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.
    • -## 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: @@ -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 \ No newline at end of file