[DOCS-15393] Consolidate OpenTelemetry hostname recommendations - #39301
Draft
brett0000FF wants to merge 6 commits into
Draft
[DOCS-15393] Consolidate OpenTelemetry hostname recommendations#39301brett0000FF wants to merge 6 commits into
brett0000FF wants to merge 6 commits into
Conversation
Expand the Hostname and Tagging page into a canonical reference covering hostname recommendations for each OpenTelemetry ingestion path: DDOT Collector on Kubernetes, OTLP ingestion by the Datadog Agent, direct OTLP intake for serverless workloads, and the standalone Collector with the Datadog Exporter. - Add a linked summary table of recommendations by ingestion path - Split cloud resource detector lists per platform, including separate ECS on EC2 and ECS Fargate configurations - Add pointers to the canonical page from the DDOT DaemonSet, serverless, Agent OTLP ingestion, and hostname mapping pages
Contributor
Reorganize the recommendations around where telemetry is collected relative to the workload, rather than by installation page: - Agent or DDOT Collector co-located with the workload - Node-level Collector sending to a gateway - Collector on each host with the Datadog Exporter - Direct OTLP intake without a host Also: - Correct the DDOT hostname explanation. DDOT runs inside the Datadog Agent, so the duplicate-host case is conflicting hostname attributes on incoming telemetry, not co-location. - Document datadog.host.name as the explicit override. - Name Fargate, gateway, and managed platform workflows. Fargate spans two topologies, so each section points to the other. - Drop the unrelated cardinality setting from the override example. - Restore h3 on the exporter reference headings so they appear in the table of contents, and split that reference material into its own section. - Use "Infrastructure Host List" and keep the danger callout. - Add reciprocal links from troubleshooting, the DDOT gateway page, and managed platforms.
"Topology" was not established vocabulary in these docs, and it needed a justifying sentence to earn its place. The four section titles already distinguish the cases, so the grouping does not need naming. Avoided "deployment pattern" as the replacement: the DDOT install pages already use it for the narrower Agent-vs-Gateway distinction, which cuts across this four-way split. Section anchor is now #hostname-recommendations; inbound links updated.
The four groups overlapped: a Collector DaemonSet forwarding to a gateway matched two of them, and the Agent and DDOT Collector were combined even though they call for different actions. Split into five paths a reader can self-select from: Agent OTLP ingestion, DDOT exporting directly, any Collector exporting through a gateway, the OpenTelemetry Collector with the Datadog Exporter, and direct OTLP intake. Also: - Scope the host-based guidance so it no longer covers Fargate. ECS Fargate does not support host-based deployments, so the Agent runs as a sidecar and the Agent hostname advice does not apply there. - Correct the ECS Fargate attribute source: infraattributes needs aws.ecs.task.arn from the SDK's ECS detector, not a Collector-side [env, ecs] resourcedetection processor. - Remove the duplicated statement of the organizing axis from Overview. - Use "host tag inheritance" to match the rest of the docs.
- Make the Datadog Exporter path explicitly exclusive in both the table label and the heading, so it does not overlap the gateway path. - Fix a self-contradictory sentence: setting datadog.host.name is itself setting an attribute, so it cannot be the remedy for not controlling emitted attributes. State the override directly instead. - Replace "these workloads have no host to identify" with what is actually true: these paths do not use a host-based Agent or Collector.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Fixes DOCS-15393
Hostname guidance for OpenTelemetry was spread across several pages. This expands Hostname and Tagging into a canonical reference, so there is one page to point users to.
Follow-up
A customer-facing metric for hostname issues is not covered yet.
Merge readiness
For Datadog employees:
<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./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Reviewed with Codex. Link targets, anchors, and shortcode balance were verified against the documentation source; factual claims were checked against the existing pages they consolidate.
Additional notes