diff --git a/content/en/observability_pipelines/advanced_configurations.md b/content/en/observability_pipelines/advanced_configurations.md index 5c8cabcc0f1c6..8e4cef2f2ce75 100644 --- a/content/en/observability_pipelines/advanced_configurations.md +++ b/content/en/observability_pipelines/advanced_configurations.md @@ -48,6 +48,16 @@ To set bootstrap options, do one of the following: The following is a list of bootstrap options, their related pipeline environment variables, and which variables have a higher precedence (priority). +`api` +: **Pipeline environment variable**: `DD_OP_API_ENABLED` +: **Priority**: `DD_OP_API_ENABLED` +: An example configuration: +:     `api`:
        `enabled`: `true`
        `address`: `"127.0.0.1:8686" # optional` +: Note: Setting `address` is optional. It is the network address to which the API should bind. If you're running the Worker in a Docker container, bind to `0.0.0.0`. Otherwise, the API is not exposed outside of the container. +: **Description**: Enable the Observability Pipelines Worker API so you can see the Worker's processes with the `tap` or `top` command. See [Run, tap, or top the Worker][8] for more information. If you are using the Helm charts provided when you [set up a pipeline][7], then the API has already been enabled. Otherwise, make sure the environment variable `DD_OP_API_ENABLED` is set to `true` in `/etc/observability-pipelines-worker/bootstrap.yaml`, which: +: - Sets up the API to listen on `localhost` and port `8686`, which is what the CLI for `tap` is expecting. +: - Exposes the `/health` endpoint. Configure a load balancer's health check with the `/health` endpoint to check that the Worker is up and running. + `api_key` : **Pipeline environment variable**: `DD_API_KEY` : **Priority**: `DD_API_KEY` @@ -105,3 +115,5 @@ The following is a list of bootstrap options, their related pipeline environment [4]: /agent/configuration/proxy/?tab=linux#environment-variables [5]: https://en.wikipedia.org/wiki/HTTP_tunnel [6]: /agent/remote_config/ +[7]: /observability_pipelines/set_up_pipelines/ +[8]: /observability_pipelines/install_the_worker/worker_commands/#run-tap-or-top-the-worker \ No newline at end of file diff --git a/content/en/observability_pipelines/troubleshooting.md b/content/en/observability_pipelines/troubleshooting.md index 2b6960e453374..de4c6d38ed5c0 100644 --- a/content/en/observability_pipelines/troubleshooting.md +++ b/content/en/observability_pipelines/troubleshooting.md @@ -23,7 +23,9 @@ If you can access your Observability Pipelines Workers locally, use the `tap` co ### Enable the Observability Pipelines Worker API - The Observability Pipelines Worker API allows you to interact with the Worker's processes with the `tap` command. If you are using the Helm charts provided when you [set up a pipeline][4], then the API has already been enabled. Otherwise, make sure the environment variable `DD_OP_API_ENABLED` is set to `true` in `/etc/observability-pipelines-worker/bootstrap.yaml`. See [Bootstrap options][5] for more information. This sets up the API to listen on `localhost` and port `8686`, which is what the CLI for `tap` is expecting. + The Observability Pipelines Worker API allows you to interact with the Worker's processes with the `tap` and `top` command. If you are using the Helm charts provided when you [set up a pipeline][4], then the API has already been enabled. Otherwise, make sure the environment variable `DD_OP_API_ENABLED` is set to `true` in `/etc/observability-pipelines-worker/bootstrap.yaml`. See [Bootstrap options][5] for more information. This sets up the API to listen on `localhost` and port `8686`, which is what the CLI for `tap` is expecting. + + **Note**: When `DD_OP_API_ENABLED` is set to `true`, the `/health` endpoint is also exposed. Configure load balancers to use the `/health` API endpoint to check that the Worker is up and running. ### Use `top` to find the component ID