Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: RD-14352-Lettuce-redis-client-does-not-apply-RedisReduceSpan-Sampler #630

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import io.opentelemetry.sdk.trace.data.LinkData;
import io.opentelemetry.sdk.trace.samplers.Sampler;
import io.opentelemetry.sdk.trace.samplers.SamplingResult;
import io.opentelemetry.semconv.SemanticAttributes;
import java.util.List;
import java.util.logging.Logger;
import java.util.regex.Pattern;
Expand Down Expand Up @@ -79,7 +80,7 @@ static class RedisReduceInfoSpanSampler implements Sampler {
private final Sampler delegateSampler;

// Regex pattern to match span names containing "INFO," (case insensitive)
private final Pattern spanNamePattern = Pattern.compile("INFO.*", Pattern.CASE_INSENSITIVE);
private final Pattern infoCommandPattern = Pattern.compile("INFO.*", Pattern.CASE_INSENSITIVE);

public RedisReduceInfoSpanSampler(Sampler delegateSampler) {
this.delegateSampler = delegateSampler;
Expand All @@ -97,7 +98,14 @@ public SamplingResult shouldSample(
String dbSystem = attributes.get(DB_SYSTEM_KEY);
if ("redis".equalsIgnoreCase(dbSystem)) {
// Match the span name against the regex
if (spanNamePattern.matcher(spanName).matches()) {
if (infoCommandPattern.matcher(spanName).matches()) {
LOGGER.finest("Dropping Redis INFO span because of span name: " + spanName);
return SamplingResult.drop();
}
// Math the span attribute db.statement against the regex
String dbStatement = attributes.get(SemanticAttributes.DB_STATEMENT);
if (dbStatement != null && infoCommandPattern.matcher(dbStatement).matches()) {
LOGGER.finest("Dropping Redis INFO span because of db.statement: " + dbStatement);
return SamplingResult.drop();
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public void tearDown() {
}

@Test
public void shouldDropByDefaultInfoServer() {
public void shouldDropByInfoCommand() {
AutoConfiguredOpenTelemetrySdkBuilder builder = AutoConfiguredOpenTelemetrySdk.builder();

new RedisSamplingConfigurer().customize(builder);
Expand All @@ -50,8 +50,9 @@ public void shouldDropByDefaultInfoServer() {
SdkTracerProvider tracerProvider = sdk.getOpenTelemetrySdk().getSdkTracerProvider();
Sampler sampler = tracerProvider.getSampler();

// Test that the default behavior is to drop "INFO server" commands
SamplingResult infoServerResult =
// Test that the default behavior is to drop "INFO" command in the span name
Assertions.assertEquals(
SamplingResult.drop(),
sampler.shouldSample(
Context.root(),
IdGenerator.random().generateTraceId(),
Expand All @@ -60,11 +61,11 @@ public void shouldDropByDefaultInfoServer() {
Attributes.of(
AttributeKey.stringKey("db.system"), "redis",
AttributeKey.stringKey("db.statement"), "server"),
Collections.emptyList());
Assertions.assertEquals(SamplingResult.drop(), infoServerResult);
Collections.emptyList()));

// Test that the default behavior is to drop other INFO commands
SamplingResult serverResult =
Assertions.assertEquals(
SamplingResult.drop(),
sampler.shouldSample(
Context.root(),
IdGenerator.random().generateTraceId(),
Expand All @@ -73,8 +74,20 @@ public void shouldDropByDefaultInfoServer() {
Attributes.of(
AttributeKey.stringKey("db.system"), "redis",
AttributeKey.stringKey("db.statement"), "other"),
Collections.emptyList());
Assertions.assertEquals(SamplingResult.drop(), serverResult);
Collections.emptyList()));

// Test that the default behavior is to drop other INFO commands
Assertions.assertEquals(
SamplingResult.drop(),
sampler.shouldSample(
Context.root(),
IdGenerator.random().generateTraceId(),
"redis",
SpanKind.CLIENT,
Attributes.of(
AttributeKey.stringKey("db.system"), "redis",
AttributeKey.stringKey("db.statement"), "INFO"),
Collections.emptyList()));
}

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,13 +215,18 @@ private void fillEndpoint(OpenTelemetryEndpoint endpoint) {
@CanIgnoreReturnValue
@SuppressWarnings("UnusedMethod")
public synchronized Tracer.Span start(RedisCommand<?, ?, ?> command) {
// Here we would like to set db.statement before starting the span, because Sampler may use it.
// At that point db.statement having only command name is fine, command args will be added later.
String commandName = command.getType().name();
this.spanBuilder.setAttribute(SemanticAttributes.DB_STATEMENT, commandName);

start();

Span span = this.span;
if (span == null) {
throw new IllegalStateException("Span started but null, this is a programming error.");
}
span.updateName(command.getType().name());
span.updateName(commandName);

if (command.getArgs() != null) {
argsList = OtelCommandArgsUtil.getCommandArgs(command.getArgs());
Expand Down
Loading