Skip to content

fix(docs): correct schema load duration to apollo.router.schema.load.duration#7582

Merged
lrlna merged 3 commits intodevfrom
lrlna/fix-shema-load-metric-docs
Jun 2, 2025
Merged

fix(docs): correct schema load duration to apollo.router.schema.load.duration#7582
lrlna merged 3 commits intodevfrom
lrlna/fix-shema-load-metric-docs

Conversation

@lrlna
Copy link
Member

@lrlna lrlna commented May 28, 2025

The in-memory cache documentation was referencing an incorrect metric to track schema load times. Previously it was referred to as apollo.router.schema.loading.time, where the metric being emitted by the router since router@2.0.0 is apollo.router.schema.load.duration. This is now fixed in the docs.


Checklist

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

  • 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

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.

@lrlna lrlna requested a review from a team as a code owner May 28, 2025 12:04
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented May 28, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 1 changed, 0 removed
* graphos/routing/(latest)/performance/caching/in-memory.mdx

Build ID: ba9e541f471d3a68d8be0dfc

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

@lrlna lrlna changed the title fix(docs): correct mention of schema load duration to `apollo.router.… fix(docs): correct schema load duration to apollo.router.schema.load.duration May 28, 2025
@lrlna lrlna requested review from bnjjj and goto-bus-stop May 28, 2025 12:06
@lrlna lrlna enabled auto-merge (squash) June 2, 2025 08:43
@lrlna lrlna merged commit b17521b into dev Jun 2, 2025
15 checks passed
@lrlna lrlna deleted the lrlna/fix-shema-load-metric-docs branch June 2, 2025 08:59
@abernix abernix mentioned this pull request Jul 1, 2025
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.

3 participants