Automatic propagation of scope with gevent and gunicorn

[lucas03]

Environment

Which SDK and version?
sentry-sdk==0.20.2
gevent==21.1.2
gunicorn==20.0.4

Steps to Reproduce

I have this code:

from gevent import monkey
monkey.patch_all()

import os
import bottle
import gevent
import sentry_sdk
from sentry_sdk.integrations.threading import ThreadingIntegration

sentry_kwargs = {
    "environment": "sentry-test",
    "ignore_errors": ["greenlet.GreenletExit"],
    "dsn": os.environ["SENTRY_DSN"],
    "integrations": [ThreadingIntegration(propagate_hub=True)]
}
sentry_sdk.init(**sentry_kwargs)


@bottle.route('/request')
def request():
    with sentry_sdk.configure_scope() as scope:
        scope.set_tag("url", bottle.request.path)
        print(sentry_sdk.Hub.current.scope)
        print(sentry_sdk.Hub.current.scope._tags)
        gevent.spawn(_request_call)
        return {}


def _request_call():
    print(sentry_sdk.Hub.current.scope)
    print(sentry_sdk.Hub.current.scope._tags)

Expected Result

I would expect ThreadingIntegration(propagate_hub=True) would propagate scope to gevent, but it seems it's not the case.

Actual Result

<Scope id=0x111b31438 name=bottle>
{'url': '/request'}
<Scope id=0x1117296d8 name=None>
{}

[untitaker]

Automatic hub propagation only works for threads, not gevent green threads. Do this instead:

hub = Hub(sentry_sdk.Hub.current)
gevent.spawn(lambda: _request_call(hub))

def _request_call(hub):
    with hub:
        ...

[lucas03]

yes, that is what you referred to on discord and I should have linked the doc here, sorry about that.

However this solution requires method calls to accept hub as an argument. I believe this makes programing more complex for developers and it's easier to make a mistake with this manual hub passing.

Is there no plan to add automatic support for green threads in the future?

[untitaker]

@lucas03 we have no immediate plans right now, we can consider it in the future but right now we also don't have it for asyncio either.

I'll leave this open as feature request.

[github-actions]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

---

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

[jnafzig]

I'm also trying to figure out how to include spans inside my gevent threads. I got this wrapping function working using the example from @untitaker

def wrap_in_sentry_span(func: Callable, span_name: str | None = None) -> Callable:
    """Wrap a function in a sentry span"""
    hub = sentry_sdk.Hub(sentry_sdk.Hub.current)
    @wraps(func)
    def wrapper(*args, **kwargs):
        with hub:
            with sentry_sdk.start_span(name=span_name or func.__name__):
                return func(*args, **kwargs)

    return wrapper

Then I start my gevent threads something like this:

threads = [
    gevent.spawn(
        wrap_in_sentry_span(evaluate_rule, span_name=rule["name"]),
        rule,
    for rule in ruleset_rules
]

gevent.joinall(threads, raise_error=False, timeout=10)

This all seems to work. However, it sounds like support for Hub is being deprecated. I tried to follow the migration guide and ended up with this:

def wrap_in_sentry_span(func: Callable, span_name: str | None = None) -> Callable:
    """Wrap a function in a sentry span"""
    my_isolation_scope = sentry_sdk.isolation_scope()
    @wraps(func)
    def wrapper(*args, **kwargs):
        with sentry_sdk.scope.use_isolation_scope(my_isolation_scope):
            with sentry_sdk.start_span(name=span_name or func.__name__):
                return func(*args, **kwargs)

    return wrapper

But this ends up throwing a "'_GeneratorContextManager' object has no attribute 'span'".

I realize this is an old thread, but basically I'm curious what the equivalent of this example would be in 2.x?

hub = Hub(sentry_sdk.Hub.current)
gevent.spawn(lambda: _request_call(hub))

def _request_call(hub):
    with hub:
        ...

Or any other guidance/suggestions on what I might be missing.