Optionally record why a sample decision was made #503
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
MikeGoldsmith
added
type: enhancement
kentquirk
force-pushed
the
kent.add-rule-name
branch
from
bbe58bb to
4b5d31b
Compare
MikeGoldsmith
approved these changes
Sep 7, 2022
There was a problem hiding this comment.
Overall, looks good. I've left some minor feedback 👍🏻
What do you think about a consistent template for reason strings?
eg
"deterministic/always"
"deterministic/chance"
"totalthroughput/{key}"
"dynamic/{key}"
"emadynamic/{key}"
"rules/span/{rule_name}"
"rules/trace/no_rule"
"rules/invalid_scope/{rule_name}
config_complete.toml
Outdated
Comment on lines
116
to
117
| # AddRuleReasonToTrace causes traces that are sent to Honeycomb to include a field `meta.refinery.reason`, | ||
| # which will contain text indicating which rule was evaluated that caused the trace to be included. |
There was a problem hiding this comment.
Suggested change
| # AddRuleReasonToTrace causes traces that are sent to Honeycomb to include a field `meta.refinery.reason`, | |
| # which will contain text indicating which rule was evaluated that caused the trace to be included. | |
| # AddRuleReasonToTrace causes traces that are sent to Honeycomb to include the field `meta.refinery.reason`, | |
| # that contains text indicating which rule was evaluated that caused the trace to be included. |
collect/collect.go
Outdated
| @@ -456,7 +456,7 @@ func (i *InMemCollector) send(trace *types.Trace) { | |||
| } | |||
|
|
|||
| // make sampling decision and update the trace | |||
| rate, shouldSend := sampler.GetSampleRate(trace) | |||
| rate, shouldSend, why := sampler.GetSampleRate(trace) | |||
There was a problem hiding this comment.
nit: for consistency, could we also call the result parameter reason? (This would incur a few changes throughout the PR)
|
I like all of your suggestions. Thanks, will implement. |
kentquirk
force-pushed
the
kent.add-rule-name
branch
from
92145de to
b5965f0
Compare
MikeGoldsmith
approved these changes
Sep 7, 2022
ghost
pushed a commit
to opsramp/tracing-proxy
that referenced
this pull request
Jul 5, 2024
## Which problem is this PR solving? - Fixes honeycombio#473 ## Short description of the changes - Adds a config flag, `AddRuleReasonToTrace` that adds a new field to traces called `meta.refinery.reason`, which is a string field that contains information about the sampler(s) that made a trace decision. If it was a rule-based sampler, it includes the rule name. - Also removes unnecessary build flags that were causing tests not to run. - Updates README and config file
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.
Which problem is this PR solving?
Short description of the changes
AddRuleReasonToTracethat adds a new field to traces calledmeta.refinery.reason, which is a string field that contains information about the sampler(s) that made a trace decision. If it was a rule-based sampler, it includes the rule name.