DOC-6304 DOC-6305 DOC-6306 DOC-6308 Client observability docs#2854
DOC-6304 DOC-6305 DOC-6306 DOC-6308 Client observability docs#2854andy-stark-redis merged 24 commits intomainfrom
Conversation
🛡️ Jit Security Scan Results
✅ No security findings were detected in this PR
Security scan by Jit
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
| you are interested in, although all metrics in the group will be collected even | ||
| if you don't use them. The metrics in each group are described in the |
There was a problem hiding this comment.
although all metrics in the group will be collected even if you don't use them
This is not accurate. We have two metric groups that are enabled by default, (resiliency and connection-basic) and the metrics in those groups are only collected when OTel is enabled.
| visualize the metrics collected by OTel. This provides a target endpoint | ||
| that you specify when you configure the client in your application. The tool then |
There was a problem hiding this comment.
This provides a target endpoint that you specify when you configure the client in your application
We actually push metrics to an otel collector. The otel collector provides an endpoint for Prometheus (or other storage layers) to scrape, and Grafana (or other monitoring tools) can then get the metrics from Prometheus. But it's not accurate to say that we Grafana provides an endpoint we use in the client init.
Co-authored-by: Elena Kolevska <elena-kolevska@users.noreply.github.com>
|
Great - thanks everyone for your input into this! |
4 participants
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:
Note
Medium Risk
Adds new site-wide conditional JS/CSS rendering for observability metrics plus a large JSON spec; regressions could affect page rendering or build/runtime behavior, though changes are gated behind a page flag.
Overview
Adds a new client observability documentation section: an overview page (
/develop/clients/observability) with metric groups/reference, plus new per-client observability guides forgo-redisandredis-py(including new example snippets). Existing Go docs are updated to link to the new dedicated observability page, and the general error-handling guide now points readers to observability instrumentation.Introduces a JSON-backed metric spec (
data/client_obs_metrics.json) and a newotel-metric-groupsshortcode that embeds the JSON and sets ahasOtelMetricsflag. The site base template then conditionally loads newstatic/js/otel-metrics.jsandstatic/css/otel-metrics.cssto transform that embedded JSON into a navigable, styled metrics/attributes reference (with anchors and copy-link behavior).Written by Cursor Bugbot for commit 5c30b13. This will update automatically on new commits. Configure here.