Skip to content

DOC-6304 DOC-6305 DOC-6306 DOC-6308 Client observability docs#2854

Open
andy-stark-redis wants to merge 19 commits intomainfrom
DOC-6302-otel-overview
Open

DOC-6304 DOC-6305 DOC-6306 DOC-6308 Client observability docs#2854
andy-stark-redis wants to merge 19 commits intomainfrom
DOC-6302-otel-overview

Conversation

@andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Mar 5, 2026

Don't be deceived by the branch name, the epic for this is actually DOC-6304 :-) node-redis will have support for this soon, but I'll make a separate PR for the docs to merge when it is released.

A few things to consider:

  • I've attempted to give a brief flavour of the tracing process, but let me know if you think it's too much or not detailed enough.
  • The attribute badges seem like they might be useful to users, but maybe they're intended more as an internal guide for implementation?
  • I've added links to the observability docs from a few relevant places, but if you can think of any other pages that should have links then let me know.

Note

Medium Risk
Adds new site-wide shortcode + conditional JS/CSS to render a large metrics spec from JSON, which could affect build/runtime rendering and page performance if misconfigured. Content-only changes elsewhere are low risk.

Overview
Introduces Redis client observability documentation: a new overview page (/develop/clients/observability) with an auto-generated metrics reference, plus new client-specific Observability guides for go-redis and redis-py with runnable example snippets.

Adds a new otel-metric-groups shortcode backed by data/client_obs_metrics.json, along with new static/js/otel-metrics.js + static/css/otel-metrics.css and baseof.html conditional loading to render the JSON into a navigable, human-friendly metrics/attributes view.

Updates related docs to point readers at observability (error-handling logging section, Go production usage link fix, and a new Redis-Py production-usage recommendation), and adjusts clients/patterns page weight to change navigation ordering.

Written by Cursor Bugbot for commit 0504666. This will update automatically on new commits. Configure here.

@andy-stark-redis andy-stark-redis requested review from a team and mortensi March 5, 2026 13:48
@andy-stark-redis andy-stark-redis self-assigned this Mar 5, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label Mar 5, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

DOC-6302

@jit-ci
Copy link

jit-ci bot commented Mar 5, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

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

Just one nitpick.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants