open-telemetry / open-telemetry/opentelemetry-python-contrib

fix(grpc): auto-instrument gRPC seems breaking Pub/Sub streaming pull of exactly once delivery

Open
#2,893 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
1.1k
Forks
1.1k
Avg merge
4d 15h
Merged PRs (30d)
16

Description

I apologize for not having a minimum reproducible test case.
It is unclear to me how auto-instrumentation of gRPC affects Pub/Sub.
Perhaps it has something to do with google.cloud.pubsub_v1.subscriber.message.Message.
So this ticket is just for the record.
Hope experts may shed some light on it.

Describe your environment

(Docker official image python:3.10-slim-bookworm)
OS: slim-bookworm
Python version: 3.10
Package version: 0.48b0

What happened?

https://cloud.google.com/pubsub/docs/exactly-once-delivery#pull_subscription_2
The line below isn't responding (such that the callback isn't working)

streaming_pull_future.result(timeout=timeout)
Steps to Reproduce
Expected Result

The callback should work

Actual Result

The line below isn't responding (such that the callback isn't working)

streaming_pull_future.result(timeout=timeout)
Additional context

No response

Would you like to implement a fix?

No

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the linked Pub/Sub exactly-once delivery example in Python 3.10 with gRPC auto-instrumentation enabled. Investigate why streaming_pull_future.result(timeout=timeout) does not return and whether the callback is invoked; the work is done when the callback responds after a message is sent.

Written by the indexing model from the issue text.

Assessment

Tech stack
grpc, python
Domain
cloud, distributed-systems
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.