Skip to content

docs: update Redis metric from connections to clients#8587

Merged
carodewig merged 1 commit intodevfrom
docs/update-redis-clients-metric
Dec 19, 2025
Merged

docs: update Redis metric from connections to clients#8587
carodewig merged 1 commit intodevfrom
docs/update-redis-clients-metric

Conversation

@apollo-mateuswgoettems
Copy link
Contributor


Description

This PR updates the Redis cache metrics documentation to use the correct metric name apollo.router.cache.redis.clients instead of the deprecated apollo.router.cache.redis.connections.

Motivation

The apollo.router.cache.redis.connections metric was replaced with apollo.router.cache.redis.clients in PR #8161. The observability documentation for response caching still referenced the old metric name.

Changes

  • Updated docs/source/routing/performance/caching/response-caching/observability.mdx to reference apollo.router.cache.redis.clients
  • Description changed from "Number of active Redis connections" to "Number of Redis clients active" to match the standard-instruments.mdx documentation

References

Checklist

  • 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

  • Changeset: Not needed - documentation-only fix for already released changes
  • Metrics/logs: Not applicable - updating existing metric documentation
  • Tests: Not applicable - documentation change only

Notes

This is a straightforward documentation fix to align with the metric name change that was already implemented in the codebase.

Footnotes

  1. No compatibility concerns - documentation only

  2. This PR is the documentation update itself

  3. No new metrics - updating reference to existing metric

  4. Documentation changes don't require code tests

@apollo-mateuswgoettems apollo-mateuswgoettems requested a review from a team as a code owner November 11, 2025 14:26
@apollo-librarian
Copy link

apollo-librarian bot commented Nov 11, 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/response-caching/observability.mdx

Build ID: 7a33bb00cdec88efffbcb8a6
Build Logs: View logs

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

@apollo-mateuswgoettems apollo-mateuswgoettems changed the title update Redis metric from connections to clients docs: update Redis metric from connections to clients Nov 11, 2025
@github-actions
Copy link
Contributor

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

@apollo-mateuswgoettems apollo-mateuswgoettems added documentation Improvements or additions to documentation support The support label should be used for when Support opens a PR to make a doc change labels Nov 24, 2025
Copy link
Contributor

@carodewig carodewig left a comment

Choose a reason for hiding this comment

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

Sorry for the delay on this - good catch!

@carodewig carodewig merged commit bffd191 into dev Dec 19, 2025
15 checks passed
@carodewig carodewig deleted the docs/update-redis-clients-metric branch December 19, 2025 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation support The support label should be used for when Support opens a PR to make a doc change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants