apm-agent-python icon indicating copy to clipboard operation
apm-agent-python copied to clipboard

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

Open Aloshi opened this issue 5 years ago • 1 comments

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

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

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.

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. 😄

Aloshi avatar Aug 03 '20 19:08 Aloshi

I think this would be doable if we changed elasticapm.traces.execution_context to basically be a getter for the execution context that has been set. Then we could proved a setter for the execution context that could be set or updated any time.

That said, I don't see this being very high priority, but I think we can definitely leave this open. Thanks for the request!

basepi avatar Aug 05 '20 15:08 basepi