Skip to content

Added pub/sub and stream lag metrics export#3898

Merged
vladvildanov merged 9 commits intofeat/observabilityfrom
vv-pubsub-stream-metric-export
Jan 5, 2026
Merged

Added pub/sub and stream lag metrics export#3898
vladvildanov merged 9 commits intofeat/observabilityfrom
vv-pubsub-stream-metric-export

Conversation

@vladvildanov
Copy link
Copy Markdown
Collaborator

Description of change

Please provide a description of the change here.

Pull Request check-list

Please make sure to review and check all of these items:

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request adds observability support for pub/sub and stream lag metrics by introducing new event types and listeners that export metrics when messages are published/received and when stream messages are consumed.

Key Changes

  • Adds OnPubSubMessageEvent and OnStreamMessageReceivedEvent to capture pub/sub and stream operations
  • Implements ExportPubSubMessageMetric and ExportStreamingLagMetric listeners that record metrics for these events
  • Integrates event dispatching into publish, spublish, xreadgroup commands and pub/sub message handling

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
redis/typing.py Adds _event_dispatcher attribute to CommandsProtocol to enable event dispatching in command mixins
redis/observability/recorder.py Fixes indentation for record_streaming_lag call (formatting correction)
redis/event.py Introduces new event classes and metric export listeners for pub/sub and streaming lag tracking
redis/commands/core.py Integrates event dispatching into xreadgroup, publish, and spublish commands
redis/client.py Adds event dispatching for received pub/sub messages in the message handler

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread redis/event.py
Comment thread redis/event.py
Comment thread redis/client.py Outdated
Comment thread redis/client.py Outdated
Comment thread redis/commands/core.py
Comment thread redis/commands/core.py
Comment thread redis/commands/core.py
Comment thread redis/event.py Outdated
Comment thread redis/event.py
vladvildanov and others added 5 commits December 29, 2025 11:55
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Base automatically changed from vv-connection-basic-metric-export to feat/observability January 5, 2026 13:32
Copy link
Copy Markdown
Collaborator

@petyaslavova petyaslavova left a comment

Choose a reason for hiding this comment

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

LGTM.

@vladvildanov vladvildanov merged commit 57cf6d7 into feat/observability Jan 5, 2026
4 checks passed
@vladvildanov vladvildanov deleted the vv-pubsub-stream-metric-export branch January 5, 2026 15:12
vladvildanov added a commit that referenced this pull request Feb 16, 2026
* Added intrastructure and integration point with OTel (#3864)

* Added intrastructure and integration point with OTel

* Added check for enabled metric groups

* Applied comments

* Added export of operation duration metric  (#3881)

* Added stadalone client metrics export

* Added support for cluster client

* Removed unused dispatchers and test

* Added export of resiliency metrics (#3888)

* Added stadalone client metrics export

* Added support for cluster client

* Added error metric export on fail commands for standalone client

* Removed unused dispatchers and test

* Added on error metrics export for cluster

* Added export of maint notification count metric

* Apply comments

* Remove redundant Union

* Added export of connection basic metrics (#3891)

* Added export of connection basic metrics

* Added new error category attribute

* Update tests/test_observability/test_recorder.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update tests/test_observability/test_recorder.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply comments

* Applied comments

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Added pub/sub and stream lag metrics export (#3898)

* Added export of connection basic metrics

* Added new error category attribute

* Added pub/sub and stream lag metrics export

* Added metric export form XREAD

* Update redis/client.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update redis/event.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Applied comments

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Added OTel benchmark test (#3903)

* Added export of connection basic metrics

* Added new error category attribute

* Added pub/sub and stream lag metrics export

* Added metric export form XREAD

* Added benchmark tests

* Added error output

* Added env variable for otel host

* Fixed endpoint

* Added iterations and results averaging

* Use unsecured gRPC

* Added --with-command-metrics argument

* Removed incorrect identation

* Update benchmarks/otel_benchmark.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update benchmarks/otel_benchmark.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update benchmarks/otel_benchmark.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update benchmarks/otel_benchmark.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update benchmarks/otel_benchmark.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Added export of connection advanced metrics (#3910)

* Added export of connection advanced metrics

* Update tests/test_connection_pool.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update redis/observability/metrics.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Refactored kwargs instead of args

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Added CSC metrics export (#3911)

* Added export of connection advanced metrics

* Added CSC metrics export

* Revert changes

* Added observable gauge registry and refactored observables metric export

* Fixed case with trackin non-cachable cache tracking

* Added memory and CPU usage (#3933)

* Added full benchmark tests + fixes

* Added Memory and CPU usage calculation

* Removed events dispatching overhead, refactored metrics attributes (#3934)

* Removed events dispatching overhead, refactored metrics attributes

* Fixed incorrect retry attempts, changed indexes to named parameters

* Fixed issue with connection attribute and metric recording

* Added async recorders and registry (#3950)

* Added async recorders and registry

* Removed async registry

* Added more coverage

* Added bucket override configuration (#3952)

* Added async recorders and registry

* Added bucket override configuration

* Removed async registry

* Added more coverage

* Fixed version constraints, removed ubused imports

* Moved module desription on top of file

* Remove async instrumentations (#3953)

* Fix tests and codestyle

* Fixed missing parameters

* Fixed tests

* Fixed tests

* Fixed tests

* Marked argument as unused

* Fixed tests

* Added missing metric export

* Fixes units and pool name attribute

Signed-off-by: Elena Kolevska <elena@kolevska.com>

* Updated test for pool name attribute

Signed-off-by: Elena Kolevska <elena@kolevska.com>

* Updates more tests

Signed-off-by: Elena Kolevska <elena@kolevska.com>

* Linter

Signed-off-by: Elena Kolevska <elena@kolevska.com>

* Added try...except blocks for recorder functions

* Added documentation

* Updated wordlist

* Update redis/cluster.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update redis/connection.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update redis/connection.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update pyproject.toml

Co-authored-by: Elena Kolevska <elena-kolevska@users.noreply.github.com>

* Codestyle fixes

* Fixed metric export

* Fixed assertions

* Added geo failover metric export

* Codestyle fixes

---------

Signed-off-by: Elena Kolevska <elena@kolevska.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Elena Kolevska <elena@kolevska.com>
Co-authored-by: Elena Kolevska <elena-kolevska@users.noreply.github.com>
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