Skip to content

Point Kubernetes Explorer OpenTelemetry setup at reference configurations - #39308

Draft
brett0000FF wants to merge 1 commit into
masterfrom
brett.blue/otel-explorer-setup-refactor
Draft

Point Kubernetes Explorer OpenTelemetry setup at reference configurations#39308
brett0000FF wants to merge 1 commit into
masterfrom
brett.blue/otel-explorer-setup-refactor

Conversation

@brett0000FF

Copy link
Copy Markdown
Collaborator

What does this PR do? What is the motivation?

This one needs input from the feature owners before it goes anywhere — it changes how the setup is documented, not just how it reads.

The OpenTelemetry tab of the Kubernetes Explorer page currently walks through several configuration fragments, then a Helm install step, then another fragment that requires editing the values file and redeploying, and finally links to a complete reference configuration. Readers end up with two competing paths to follow.

This PR replaces the fragments with a pointer to the Kubernetes Metrics setup guide and its maintained cluster-collector.yaml and daemonset-collector.yaml reference configurations, keeping a summary of what the Cluster Collector configuration does for Kubernetes Explorer: the kubernetesObjects preset, the 3m k8sobjects interval, resourcedetection, and orchestrator_explorer.

It also recommends the kubernetesAttributes Helm preset for custom Collector configurations that don't need custom metadata extraction or pod association, rather than copying a long processor block.

Open questions for reviewers:

  • The tab no longer contains a copy-pasteable Collector configuration. Is delegating to the reference configs the right call for a setup that just went GA?
  • The Kubernetes Metrics path installs kube-state-metrics and two Collectors. Kubernetes Explorer alone only needs the Cluster Collector, so readers who want just the Explorer follow a heavier setup than they strictly need.

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 Codex, then reviewed with Claude Code. Claude verified each claim about the reference configurations and Helm presets against the upstream DataDog/opentelemetry-examples files and the pinned opentelemetry-collector chart templates.

Additional notes

The reference configurations in DataDog/opentelemetry-examples still define the Kubernetes Attributes processor explicitly rather than using the kubernetesAttributes preset. That looks intentional (they customize metadata extraction and pod association), but simplifying them is a possible follow-up in that repo.

Note that DOCS-15427 asks for a site-availability header on this same tab, since the feature isn't available on US1-FED or US2-FED. That change would touch the section this PR restructures.

Replace the step-by-step configuration fragments on the OpenTelemetry
tab with a pointer to the Kubernetes Metrics setup guide and its
maintained cluster and node Collector reference configurations, and
summarize what the Cluster Collector configuration does for Kubernetes
Explorer.

Recommend the kubernetesAttributes Helm preset for custom Collector
configurations that do not need custom metadata extraction or pod
association.
@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant