You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I recently submitted open-telemetry/opentelemetry-python#1113 to fix a missing line from the docs, but I've been digging more into this and I'm not sure that was the right choice.
server = intercept_server(server, server_interceptor())
It turns out that the instrument() method there does some magic by wrapping grpc.server in the same way my added line does. The reason I added this line in the docs, was that I wasn't calling grpc.server()after this instrument() call, I'd already created the server some lines before. And then nothing worked until I specifically called the wrapper.
So as the docs are written, this probably needs a revert, but also as they're written, nothing makes it clear what hidden effects are actually going on here, and so it's really easy to miss. Like I did.
So my bug report is that this very very basic example isn't enough for someone to go on for anything but running the basic example itself, especially when there isn't really any other useful documentation on how these components work, and there are many hidden behind-the-scenes effects that aren't immediately clear.
The text was updated successfully, but these errors were encountered:
I recently submitted open-telemetry/opentelemetry-python#1113 to fix a missing line from the docs, but I've been digging more into this and I'm not sure that was the right choice.
The docs have this sequence:
I added this line in open-telemetry/opentelemetry-python#1113:
It turns out that the
instrument()
method there does some magic by wrappinggrpc.server
in the same way my added line does. The reason I added this line in the docs, was that I wasn't callinggrpc.server()
after thisinstrument()
call, I'd already created the server some lines before. And then nothing worked until I specifically called the wrapper.So as the docs are written, this probably needs a revert, but also as they're written, nothing makes it clear what hidden effects are actually going on here, and so it's really easy to miss. Like I did.
So my bug report is that this very very basic example isn't enough for someone to go on for anything but running the basic example itself, especially when there isn't really any other useful documentation on how these components work, and there are many hidden behind-the-scenes effects that aren't immediately clear.
The text was updated successfully, but these errors were encountered: