elastic / elastic/apm-agent-python

Support for setting the execution context after import time to support late gevent patching

Offen
#894 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
agent-python feature
Vorherrschende Sprache
Python
Sterne
431
Forks
239
Ø Merge
5 T. 10 Std.
Gemergte PRs (30 T.)
7

Beschreibung

**Is your feature request related to a problem? Please describe.**
I'm working with a legacy codebase that imports some code, forks and does gevent monkey patching, then imports a bunch more code. I'm running into an issue where `elasticapm.traces.execution_context` is initialized at import time during the first phase, using the not-monkeypatched `threading.local` / `contextvars`, which causes transactions / spans to be linked to the wrong requests.

**Describe the solution you'd like**
Since fixing my codebase to not import the logging code is rather involved, I am looking for a safe way to either re-initialize the current execution context or assign it to a newly constructed instance. Ideally, I would be able to do something like

```py
set_execution_context(ThreadLocalContext())
```

after I know gevent has done its patching. This would also open the door for using custom execution context implementations, if someone ever wanted to do that.

This seems like it would be a bit tricky to implement in the library as it is now, since there is a lot of
```py
from elasticapm.traces import execution_context
```
which AFAIK makes it impractical to do something like `elasticapm.traces.execution_context = Blah()` due to the multiple names [thing](https://docs.python.org/3/library/unittest.mock.html#where-to-patch).

**Describe alternatives you've considered**
I've converted our setup code to use only local imports for elasticapm (in functions executed after I know gevent has finished patching), which works okay. It's a little fragile, though - if anyone ever imports elasticapm without the proper guards things could break again.

I think this might be specific to our codebase - we should really be patching gevent before we import things anyway. Feel free to close if this doesn't seem worth the effort, since I have a pretty solid work-around. Love the library and great work. 😄

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, nachzuverfolgen, wie elasticapm.traces.execution_context initialisiert wird und wie seine importierten Namen im gesamten Paket verwendet werden. Untersuche eine sichere Möglichkeit, diesen Kontext nach dem Patching durch gevent zu ersetzen oder neu zu initialisieren, und überprüfe anschließend, dass Transaktionen und Spans den neuen Kontext verwenden, ohne bestehende Imports zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
observability-sre
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.