Add caller information to main API for improved telemetry #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The message bus will already produce activity start/stop for key API invocations (Execute/Notify). This telemetry currently includes the [recommended span code attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/span-general.md#source-code-attributes), but it will log the Merq locations for those. This means that monitoring the activities for a message bus Execute/Notify invocation will reveal source attributes that belong to Merq, rather than the actual place where those invocations happened. It would be much more useful to have the telemetry attributes be associated with the caller than the bus itself in these cases. By propagating these automatically (for example, a bus.Execute where the command handler performs bus.Notify) we can precisely know where a given event handler delivery action originated in the actual upstream call to the bus itself, revealing a key codepath that can be invaluable for diagnostics. From the point of view of the activity and telemetry, at least with regards to these source code attributes, the bus becomes "transparent" in a way. This is more useful than monitoring method and line # for the bus implementation itself. Closes #102
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The message bus will already produce activity start/stop for key API invocations (Execute/Notify). This telemetry currently includes the recommended span code attributes, but it will log the Merq locations for those.
This means that monitoring the activities for a message bus Execute/Notify invocation will reveal source attributes that belong to Merq, rather than the actual place where those invocations happened. It would be much more useful to have the telemetry attributes be associated with the caller than the bus itself in these cases. By propagating these automatically (for example, a bus.Execute where the command handler performs bus.Notify) we can precisely know where a given event handler delivery action originated in the actual upstream call to the bus itself, revealing a key codepath that can be invaluable for diagnostics.
From the point of view of the activity and telemetry, at least with regards to these source code attributes, the bus becomes "transparent" in a way. This is more useful than monitoring method and line # for the bus implementation itself.
Closes #102