Skip to content

Update documentation to match APM template changes#8843

Merged
SharkBaitDLS merged 1 commit intodevfrom
rr-396-apm-doc-updates
Feb 2, 2026
Merged

Update documentation to match APM template changes#8843
SharkBaitDLS merged 1 commit intodevfrom
rr-396-apm-doc-updates

Conversation

@SharkBaitDLS
Copy link
Copy Markdown
Contributor

@SharkBaitDLS SharkBaitDLS commented Jan 30, 2026

The template now includes the overhead metric as a default so we include
it in the recommended configuration.

Also fix the Subscriptions heading to be at the correct nesting level
instead of being a subheader under Uplink.


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 compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Metrics and logs are added3 and documented
  • Tests added and passing4
    • Unit tests
    • Integration tests
    • Manual tests, as necessary

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices.

  4. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

The template now includes the overhead metric as a default so we include
it in the recommended configuration.

Also fix the Subscriptions heading to be at the correct nesting level
instead of being a subheader under Uplink.
@SharkBaitDLS SharkBaitDLS requested a review from a team as a code owner January 30, 2026 01:09
@github-actions
Copy link
Copy Markdown
Contributor

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

@apollo-librarian
Copy link
Copy Markdown
Contributor

apollo-librarian bot commented Jan 30, 2026

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 2 changed, 0 removed
* graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/router-instrumentation.mdx
* graphos/routing/(latest)/observability/router-telemetry-otel/enabling-telemetry/standard-instruments.mdx

Build ID: 20804e5b6758e6ad01fd6b75
Build Logs: View logs

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

Copy link
Copy Markdown
Contributor

@pragl pragl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@SharkBaitDLS SharkBaitDLS merged commit 3b69a79 into dev Feb 2, 2026
15 checks passed
@SharkBaitDLS SharkBaitDLS deleted the rr-396-apm-doc-updates branch February 2, 2026 16:17
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.

2 participants