Expose basic Otel classes and funtions to be importable through redis.observability to match the examples in the readthedocs#3996
Merged
petyaslavova merged 3 commits intomasterfrom Mar 16, 2026
Conversation
🛡️ Jit Security Scan Results
✅ No security findings were detected in this PR
Security scan by Jit
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a package initializer for redis.observability so the OpenTelemetry observability API can be imported from the package root, matching the ReadTheDocs examples and addressing #3992.
Changes:
- Introduces
redis/observability/__init__.pyto re-export key observability symbols (OTelConfig,MetricGroup,TelemetryOption,ObservabilityInstance,get_observability_instance,reset_observability_instance). - Adds basic usage documentation in the module docstring.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
petyaslavova
force-pushed
the
ps_fix_otel_init_py_to_expose_base_objects
branch
from
dd198d1 to
cc8e3c4
Compare
….observability to match the examples in the readthedocs
petyaslavova
force-pushed
the
ps_fix_otel_init_py_to_expose_base_objects
branch
from
cc8e3c4 to
b8a70d1
Compare
vladvildanov
approved these changes
Mar 12, 2026
petyaslavova
added a commit
that referenced
this pull request
Mar 23, 2026
….observability to match the examples in the readthedocs (#3996)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3992
Note
Low Risk
Low risk: this only adds a public re-export surface (
__init__.py) plus tests, with no changes to runtime observability behavior.Overview
redis.observabilityis turned into a documented public entrypoint by re-exporting core OpenTelemetry-facing types and helpers (OTelConfig,MetricGroup,TelemetryOption, and theget/reset_observability_instanceAPIs) via__all__.Adds unit tests to ensure these symbols are correctly re-exported and accessible, preventing future regressions in the public import paths used by the docs.
Written by Cursor Bugbot for commit 86656b3. This will update automatically on new commits. Configure here.