Add tracing to Memcached and Kafka operations #125
Merged
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
Wraps get and set with `cache.get` and `cache.set` spans respectively. The get span includes the key as an attribute and the set span includes the key, value, and expiration. This adds a `MonadTracer` constraint to all caching functions, but that should be manageable since most apps using `freckle-app` and caching will have it there for `Freckle.App.Database.runDB` anyway.
This only adds topic name to the attributes, since how to deal with multiple values and a keying function would be somewhat arbitrary. We'll leave out that behavior for now and possibly add something later when we start to use this and decide what we'd want.
This adds an outer span, and inner spans for decoding and handling the message. In order for spans to be correctly marked as error with exception details, you need to "throw through" the `inSpan` function, so I had to do that refactor too. This ultimately worked out simpler by avoiding nested eithers and moving error handling concerns out of the main body.
pbrisbin
changed the title
stackptr
approved these changes
Oct 25, 2023
Throwing exceptions through `inSpan` is what causes them to be marked as errors. Therefore, we should avoid throwing the `KafkaResponseError` that represents a polling timeout that way.
| "cache.set" | ||
| clientSpanArguments | ||
| { Trace.attributes = | ||
| HashMap.fromList |
There was a problem hiding this comment.
Offtopic/unimportant, but any interest in adding GHC.Exts.fromList to the prelude? Could have spared you an import here.
There was a problem hiding this comment.
I'm into it. I've been trying to migrate SomeModule.toList to the (already prelude-available) one from Data.Foldable as a similar simplification.
chris-martin
approved these changes
Oct 26, 2023
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.
Fix import order
b82b2d7
Add kind-related helpers for SpanArguments
02c522f
Use trace kind Client for runDB span
6ee57d5
Add tracing to Memcached operations
b4fe410
Add tracing to Kafka.Producer operations
59f17ae
This only adds topic name to the attributes, since how to deal with
multiple values and a keying function would be somewhat arbitrary. We'll
leave out that behavior for now and possibly add something later when we
start to use this and decide what we'd want.
Add tracing to Kafka.Consumer operations
d8ad053
This adds an outer span, and inner spans for decoding and handling the
message.
In order for spans to be correctly marked as error with exception
details, you need to "throw through" the
inSpanfunction, so I had todo that refactor too. This ultimately worked out simpler by avoiding
nested eithers and moving error handling concerns out of the main body.
Fixup OpenTelemetry module documentation
6b978ed
Set env to disable traceing in specs