attempt to base64 decode invalid DDIds #1656
Merged
Conversation
This file contains hidden or 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
…s with their infrastructure and avoid breaking the trace lineage
richardstartin
force-pushed
the
rgs/base64-ddid
branch
2 times, most recently
from
0479918 to
20f65b4
Compare
devinsba
reviewed
Jul 6, 2020
Comment on lines
+65
to
+80
| } catch (NumberFormatException e) { | ||
| // we have reports of Kakfa mirror maker base64 encoding record headers | ||
| // attempting to base64 decode the ids here rather than in the Kafka instrumentation | ||
| // helps users understand they have a problem without making other users pay for it | ||
| if (null != s) { | ||
| try { | ||
| String decoded = new String(BASE64.decode(s), StandardCharsets.ISO_8859_1); | ||
| log.debug( | ||
| "id {} was base 64 encoded to {}, it was decoded but this indicates there is a problem elsewhere in your system", | ||
| decoded, | ||
| s); | ||
| return DDId.create(parseUnsignedLong(decoded), decoded); | ||
| } catch (Exception ignored) { | ||
|
|
||
| } | ||
| } |
There was a problem hiding this comment.
I'm just wondering if considering this is a special case, we should add this catch block to the place that extracts the headers into a context, perhaps by creating a second TextMapExtractAdapter to handle the failure case
There was a problem hiding this comment.
I addressed that in the description of the PR.
devinsba
approved these changes
Jul 6, 2020
richardstartin
force-pushed
the
rgs/base64-ddid
branch
from
e588dfa to
914c761
Compare
tylerbenson
approved these changes
Jul 6, 2020
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.
This one comes from a support issue where Kafka Mirrormaker was reportedly base64 encoding Kafka headers, and the user was complaining that we wouldn't parse the trace IDs. I've investigated and there is no way to detect that this has happened, except trying to base64 decode the headers. Doing this "just in case" in the Kafka instrumentation would give other users a significant performance regression so we don't want to do this unless absolutely necessary. This isn't really the tracer's fault and the user needs to prevent infrastructure from mangling header data, but attempting to base64 decode in a catch block in
DDId.fromhelps the user diagnose and fix their problem, avoids breaking trace lineage if they can't fix it right away, whilst preventing other users from paying for it.