[DOCS-11538] Add enable liveness and readiness probe (#30810)

* add info

* Apply suggestions from code review

Co-authored-by: Alicia Scott <[email protected]>

---------

Co-authored-by: Alicia Scott <[email protected]>

Author: maycmlee

content/en/observability_pipelines/advanced_configurations.md

@@ -26,7 +26,7 @@ further_reading:
 
 ## Overview
 
-This document explains bootstrapping for the Observability Pipelines Worker.
+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).
 
 ## Bootstrap Options
 
@@ -54,9 +54,8 @@ The following is a list of bootstrap options, their related pipeline environment
 : An example configuration:
 : &nbsp;&nbsp;&nbsp;&nbsp;`api`:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`enabled`: `true`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`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.
+: **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`. This sets up the API to listen on `localhost` and port `8686`, which is what the CLI for `tap` is expecting.
+<br><br>See [Enable liveness and readiness probe](#enable-liveness-and-readiness-probe) on how to expose the `/health` endpoint.
 
 `api_key`
 : **Pipeline environment variable**: `DD_API_KEY`
@@ -105,6 +104,16 @@ 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
+
+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:
+
+```
+api:
+  enabled: true
+  address: "0.0.0.0.1:8686"
+```
+
 ## Further reading
 
 {{< partial name="whats-next/whats-next.html" >}}

content/en/observability_pipelines/troubleshooting.md

@@ -25,7 +25,7 @@ If you can access your Observability Pipelines Workers locally, use the `tap` co
 
  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.
+ **Note**: See [Enable liveness and readiness probe][15] for instructions on how to expose the `/health` endpoint. After the endpoint is 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
 
@@ -143,3 +143,4 @@ If the Worker is not starting, Worker logs are not sent to Datadog and are not v
 [12]: https://app.datadoghq.com/logs
 [13]: /observability_pipelines/install_the_worker/worker_commands/
 [14]: https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/security_guide/sec-port_forwarding#sec-Adding_a_Port_to_Redirect
+[15]: /observability_pipelines/advanced_configurations/#enable-liveness-and-readiness-probe