Log errors that occur during /explain
#134
Merged
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.
What
Make an OpenTelemetry log event when the queries to
/explain
encounter an error.How
OpenTelemetry log events are simply events with the field
meta.signal_type = "log"
, and otherwise adhering to the semantic conventions of logs, see https://opentelemetry.io/docs/specs/otel/logs/data-model/.Similarly, we set
error = true
, which both Honeycomb and Jaeger recognizes in the UI.The
tracing::event!(..)
macro captures the place in the code where it was called. Therefore I have opted to not try and abstract over making error-log events, as that information becomes just noise otherwise.The
body
attribute of the event/log is just the Display'd Error message. Depending on the future uses we want for these log messages we will probably amend them with more attributes/ more information.In Jaeger:
In Honeycomb: