Skip to content

Conversation

robert113289
Copy link
Contributor

@robert113289 robert113289 commented Sep 22, 2025

Summary

This Pull Request introduces updates to the Datadog integration documentation for the Apollo Router. The changes aim to provide clearer, more structured instructions for setting up telemetry with Datadog, expanding on connection methods, configuration guides, and monitoring capabilities.

Main Changes

  • Sidebar Updates: Restructures and adds links to the new documentaion.
  • New Documentation:
    • Connecting to Datadog: Explains various connection methods (e.g., OpenTelemetry Collector, Datadog Agent).
    • Dashboard Template: Provides instructions for using preconfigured Datadog dashboards.
    • Router Instrumentation: Details settings for enhancing APM views, including error tracking and resource naming.
    • OpenTelemetry Collector Configuration: Comprehensive guide on setting up the collector.
  • Enhancements to Existing Documentation:
    • Added links to new documentation to drive home the organization.
    • Move some router instrumentation from the datadog-agent-traces page to the new router-instrumentation page.

Note worthy

  • I explicitly mentioned ddot and agentless as methods to connect to Datadog, despite the fact that our own documentation for these methods is not yet available. Agentless support is currently in the backlog, and ddot requires a combination of OTEL collector and agent configurations. In the interim, the combined documentation from Datadog and our own will be sufficient.

RR-305


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • PR description explains the motivation for the change and relevant context for reviewing
  • PR description links appropriate GitHub/Jira tickets (creating when necessary)
  • Changeset is included for user-facing changes
  • Changes are compatible[^1]
  • Documentation[^2] completed
  • Performance impact assessed and acceptable
  • Metrics and logs are added[^3] and documented
  • Tests added and passing[^4]
    • Unit tests
    • Integration tests
    • Manual tests, as necessary

Exceptions
This is a docs only PR. Checklist items around Unit testing and router compatibility need not appy.

Copy link
Contributor

@robert113289, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

@apollo-librarian
Copy link

apollo-librarian bot commented Sep 22, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

5 new, 3 changed, 0 removed
+ graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/connecting-to-datadog/index.mdx
+ graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/connecting-to-datadog/otel-collector.mdx
+ graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/index.mdx
+ graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/router-instrumentation.mdx
+ graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/observing-and-monitoring/dashboard-template.mdx
* graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/connecting-to-datadog/datadog-agent/datadog-agent-metrics.mdx
* graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/connecting-to-datadog/datadog-agent/datadog-agent-traces.mdx
* graphos/routing/(latest)/_sidebar.yaml

Build ID: 30564f93bcb5bcd157c64fcd
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/30564f93bcb5bcd157c64fcd

@robert113289 robert113289 changed the title Kirkum/rr 305 datadog docs Datadog Docs Enhancement Sep 25, 2025
@SharkBaitDLS SharkBaitDLS force-pushed the kirkum/RR-305-datadog-docs branch 4 times, most recently from 33c3b78 to d442d4c Compare September 25, 2025 22:00
\# Main Changes
* Sidebar Updates: Restructures and adds links to the new documentaion.
* New Documentation:
   * Connecting to Datadog: Explains various connection methods (e.g., OpenTelemetry Collector, Datadog Agent).
   * Dashboard Template: Provides instructions for using preconfigured Datadog dashboards.
   * Router Instrumentation: Details settings for enhancing APM views, including error tracking and resource naming.
   * OpenTelemetry Collector Configuration: Comprehensive guide on setting up the collector.
* Enhancements to Existing Documentation:
   * Added links to new documentation to drive home the organization.
   * Move some router instrumentation from the datadog-agent-traces page to the new router-instrumentation page.

\# Noteworthy
* I explicitly mentioned ddot and agentless as methods to connect to Datadog, despite the fact that our own documentation for these methods is not yet available. Agentless support is currently in the backlog, and ddot requires a combination of OTEL collector and agent configurations. In the interim, the combined documentation from Datadog and our own will be sufficient.

Co-authored-by: Isaac M. Good <[email protected]>
@SharkBaitDLS SharkBaitDLS force-pushed the kirkum/RR-305-datadog-docs branch from d442d4c to b346521 Compare September 25, 2025 22:00
@SharkBaitDLS SharkBaitDLS marked this pull request as ready for review September 25, 2025 22:04
@SharkBaitDLS SharkBaitDLS requested a review from a team as a code owner September 25, 2025 22:04
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