feat: add sampling attributes for jaeger remote sampler #8073
+412
−78
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,7 +61,7 @@ type samplingStrategyParser interface { | |
| // | ||
| // Sampler invokes the updaters while holding a lock on the main sampler. | ||
| type samplerUpdater interface { | ||
| Update(sampler trace.Sampler, strategy any, samplerOptions ...samplerOptionFunc) (modified trace.Sampler, err error) | ||
| } | ||
|
|
||
| // Sampler is a delegating sampler that polls a remote server | ||
|
|
@@ -174,7 +174,7 @@ func (s *Sampler) UpdateSampler() { | |
| // NB: this function should only be called while holding a Write lock. | ||
| func (s *Sampler) updateSamplerViaUpdaters(strategy any) error { | ||
| for _, updater := range s.updaters { | ||
| sampler, err := updater.Update(s.sampler, strategy, s.samplerOptions...) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
@@ -192,7 +192,7 @@ func (s *Sampler) updateSamplerViaUpdaters(strategy any) error { | |
| type probabilisticSamplerUpdater struct{} | ||
|
|
||
| // Update implements Update of samplerUpdater. | ||
| func (*probabilisticSamplerUpdater) Update(sampler trace.Sampler, strategy any, samplerOptions ...samplerOptionFunc) (trace.Sampler, error) { | ||
| type response interface { | ||
| GetProbabilisticSampling() *jaeger_api_v2.ProbabilisticSamplingStrategy | ||
| } | ||
|
|
@@ -205,7 +205,7 @@ func (*probabilisticSamplerUpdater) Update(sampler trace.Sampler, strategy any) | |
| } | ||
| return sampler, nil | ||
| } | ||
| return newProbabilisticSampler(probabilistic.SamplingRate, samplerOptions...), nil | ||
| } | ||
| } | ||
| return nil, nil | ||
|
|
@@ -217,7 +217,7 @@ func (*probabilisticSamplerUpdater) Update(sampler trace.Sampler, strategy any) | |
| type rateLimitingSamplerUpdater struct{} | ||
|
|
||
| // Update implements Update of samplerUpdater. | ||
| func (*rateLimitingSamplerUpdater) Update(sampler trace.Sampler, strategy any, samplerOptions ...samplerOptionFunc) (trace.Sampler, error) { | ||
| type response interface { | ||
| GetRateLimitingSampling() *jaeger_api_v2.RateLimitingSamplingStrategy | ||
| } | ||
|
|
@@ -229,7 +229,7 @@ func (*rateLimitingSamplerUpdater) Update(sampler trace.Sampler, strategy any) ( | |
| rl.Update(rateLimit) | ||
| return rl, nil | ||
| } | ||
| return newRateLimitingSampler(rateLimit, samplerOptions...), nil | ||
| } | ||
| } | ||
| return nil, nil | ||
|
|
@@ -245,7 +245,7 @@ type perOperationSamplerUpdater struct { | |
| } | ||
|
|
||
| // Update implements Update of samplerUpdater. | ||
| func (u *perOperationSamplerUpdater) Update(sampler trace.Sampler, strategy any, samplerOptions ...samplerOptionFunc) (trace.Sampler, error) { | ||
| type response interface { | ||
| GetOperationSampling() *jaeger_api_v2.PerOperationSamplingStrategies | ||
| } | ||
|
|
@@ -260,7 +260,7 @@ func (u *perOperationSamplerUpdater) Update(sampler trace.Sampler, strategy any) | |
| MaxOperations: u.MaxOperations, | ||
| OperationNameLateBinding: u.OperationNameLateBinding, | ||
| Strategies: operations, | ||
| }, samplerOptions...), nil | ||
| } | ||
| } | ||
| return nil, nil | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package jaegerremote_test | ||
|
|
||
| import ( | ||
| "encoding/binary" | ||
| "testing" | ||
| "time" | ||
|
|
||
| jaeger_api_v2 "github.com/jaegertracing/jaeger-idl/proto-gen/api_v2" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/sdk/trace" | ||
| oteltrace "go.opentelemetry.io/otel/trace" | ||
|
|
||
| "go.opentelemetry.io/contrib/samplers/jaegerremote" | ||
| "go.opentelemetry.io/contrib/samplers/jaegerremote/internal/testutils" | ||
| ) | ||
|
|
||
| const ( | ||
| testDefaultSamplingProbability = 0.5 | ||
| testMaxID = uint64(1) << 63 | ||
| ) | ||
|
|
||
| func TestRemotelyControlledSampler_WithAttributesOn(t *testing.T) { | ||
| agent, err := testutils.StartMockAgent() | ||
| require.NoError(t, err) | ||
|
|
||
| remoteSampler := jaegerremote.New( | ||
| "client app", | ||
| jaegerremote.WithSamplingServerURL("http://"+agent.SamplingServerAddr()), | ||
| jaegerremote.WithSamplingRefreshInterval(time.Minute), | ||
| jaegerremote.WithAttributesOn(), | ||
| ) | ||
| remoteSampler.Close() // stop timer-based updates, we want to call them manually | ||
| defer agent.Close() | ||
|
|
||
| var traceID oteltrace.TraceID | ||
| binary.BigEndian.PutUint64(traceID[8:], testMaxID-20) | ||
|
|
||
| t.Run("probabilistic", func(t *testing.T) { | ||
| agent.AddSamplingStrategy("client app", | ||
| &jaeger_api_v2.SamplingStrategyResponse{ | ||
| StrategyType: jaeger_api_v2.SamplingStrategyType_PROBABILISTIC, | ||
| ProbabilisticSampling: &jaeger_api_v2.ProbabilisticSamplingStrategy{ | ||
| SamplingRate: testDefaultSamplingProbability, | ||
| }, | ||
| }) | ||
| remoteSampler.UpdateSampler() | ||
|
|
||
| result := remoteSampler.ShouldSample(trace.SamplingParameters{TraceID: traceID}) | ||
| assert.Equal(t, trace.RecordAndSample, result.Decision) | ||
| assert.Equal(t, []attribute.KeyValue{attribute.String("jaeger.sampler.type", "probabilistic"), attribute.Float64("jaeger.sampler.param", 0.5)}, result.Attributes) | ||
| }) | ||
|
|
||
| t.Run("ratelimitng", func(t *testing.T) { | ||
| agent.AddSamplingStrategy("client app", | ||
| &jaeger_api_v2.SamplingStrategyResponse{ | ||
| StrategyType: jaeger_api_v2.SamplingStrategyType_RATE_LIMITING, | ||
| RateLimitingSampling: &jaeger_api_v2.RateLimitingSamplingStrategy{ | ||
| MaxTracesPerSecond: 1, | ||
| }, | ||
| }) | ||
| remoteSampler.UpdateSampler() | ||
|
|
||
| result := remoteSampler.ShouldSample(trace.SamplingParameters{TraceID: traceID}) | ||
| assert.Equal(t, trace.RecordAndSample, result.Decision) | ||
| assert.Equal(t, []attribute.KeyValue{attribute.String("jaeger.sampler.type", "ratelimiting"), attribute.Float64("jaeger.sampler.param", 1)}, result.Attributes) | ||
| }) | ||
|
|
||
| t.Run("per operation", func(t *testing.T) { | ||
| agent.AddSamplingStrategy("client app", | ||
| &jaeger_api_v2.SamplingStrategyResponse{OperationSampling: &jaeger_api_v2.PerOperationSamplingStrategies{ | ||
| DefaultSamplingProbability: testDefaultSamplingProbability, | ||
| DefaultLowerBoundTracesPerSecond: 1.0, | ||
| }}) | ||
| remoteSampler.UpdateSampler() | ||
|
|
||
| result := remoteSampler.ShouldSample(trace.SamplingParameters{TraceID: traceID}) | ||
| assert.Equal(t, trace.RecordAndSample, result.Decision) | ||
| assert.Equal(t, []attribute.KeyValue{attribute.String("jaeger.sampler.type", "probabilistic"), attribute.Float64("jaeger.sampler.param", 0.5)}, result.Attributes) | ||
| }) | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is redundant. The package already has the functional options mechanism
So
WithAttributesOn()should be implemented asOptionjust like other options, and should set a flag on theconfigstruct.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the idea behind these internal options is to have different behavior when creating samplers without need to change every test to add new argument in constructor.
I can use flag arg in sampler's constructors if it is ok with you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a) why do you need to change every test? do they all compare attributes?
b) even if you need to, it seems like a trivial task for a Copilot
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a) cause a lot of tests call these constructors
b) yeah but it is harder to review a lot of small changes
nvm I'll change to flag argument 👍