Skip to content

[DOCS-13310] Cross-link load balancer health check guidance - #39376

Open
maycmlee wants to merge 2 commits into
masterfrom
may/docs-13310-lb-health-check-crosslink
Open

[DOCS-13310] Cross-link load balancer health check guidance#39376
maycmlee wants to merge 2 commits into
masterfrom
may/docs-13310-lb-health-check-crosslink

Conversation

@maycmlee

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Fixes DOCS-13310

VM-based Worker deployments behind a load balancer need the load balancer's health check pointed at the Worker's /health endpoint, but the setup steps for that (DD_OP_API_ENABLED, DD_OP_API_ADDRESS) and the load balancer health check recommendation lived in two separate, unlinked docs.

  • In the scaling guide's load balancer configuration recommendations, link to the existing health check endpoint setup steps.
  • In the health check endpoint doc, add a reverse link to the load balancer configuration recommendations, and clarify that the default Kubernetes liveness/readiness probes use a TCP socket check on the Worker API port rather than the /health endpoint.

Merge readiness

  • Ready for merge

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Drafted with Claude Code: pulled ticket details from Jira, located the relevant doc sections, and made the cross-linking edits.

Additional notes

…sed Workers

Link the load balancer health check recommendation in the scaling
guide to the existing health check endpoint setup steps, and add a
reverse link back. Also clarify that the default Kubernetes probes
use a TCP socket check rather than the /health endpoint.
@maycmlee
maycmlee requested a review from a team as a code owner August 20, 2026 20:35
@maycmlee maycmlee added the WORK IN PROGRESS No review needed, it's a wip ;) label Aug 20, 2026
Co-authored-by: May Lee <may.lee@datadoghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

WORK IN PROGRESS No review needed, it's a wip ;)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant