Datadog Docs Enhancement

[robert113289]

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.

[apollo-librarian]

✅ 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: a5a1f85c3aee2a747e060bae
Build Logs: View logs

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

[mabuyo]

These guides are really great, thanks team! I don't have much subject matter knowledge here so recommend having an SME review for technical accuracy. My review focused on navigating around and information structure.

Do we also need to add anything in the YAML config doc for telemetry? https://www.apollographql.com/docs/graphos/routing/configuration/yaml#telemetry

[lrlna]

I think this needs a few small corrections, but is overall looking really good!

[mabuyo]

Left some last minor comments but overall looks great! Thank you! 🙌🏽

[lrlna]

Thank you! These are going to be heaps helpful