Skip to content

feat: add session-based sampling ratio support #971

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.

Sign up for GitHub

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

Closed
GerardPaligot wants to merge 1 commit into from
Closed

feat: add session-based sampling ratio support #971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions core/src/main/java/io/opentelemetry/android/OpenTelemetryRumBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,13 @@ private SdkTracerProvider buildTracerProvider(
customizer : tracerProviderCustomizers) {
tracerProviderBuilder = customizer.apply(tracerProviderBuilder, application);
}

if (config.getSessionConfig().getRatio() != null) {
tracerProviderBuilder.setSampler(
new SessionIdRatioBasedSampler(
config.getSessionConfig().getRatio(), sessionProvider));
}

return tracerProviderBuilder.build();
}

Expand Down
13 changes: 12 additions & 1 deletion core/src/main/java/io/opentelemetry/android/config/SessionConfig.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,20 @@ import kotlin.time.Duration.Companion.minutes
data class SessionConfig(
val backgroundInactivityTimeout: Duration = 15.minutes,
val maxLifetime: Duration = 4.hours,
val ratio: Double? = null,
) {
constructor(
backgroundInactivityTimeout: Int = 15,
maxLifetime: Int = 4,
ratio: Double? = null,
) : this(
backgroundInactivityTimeout = backgroundInactivityTimeout.minutes,
maxLifetime = maxLifetime.hours,
ratio = ratio,
)

companion object {
@JvmStatic
fun withDefaults(): SessionConfig = SessionConfig()
fun withDefaults(): SessionConfig = SessionConfig(15.minutes, 4.hours)
}
}
20 changes: 20 additions & 0 deletions core/src/test/java/io/opentelemetry/android/OpenTelemetryRumBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import androidx.annotation.NonNull;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import io.opentelemetry.android.config.OtelRumConfig;
import io.opentelemetry.android.config.SessionConfig;
import io.opentelemetry.android.features.diskbuffering.DiskBufferingConfig;
import io.opentelemetry.android.features.diskbuffering.SignalFromDiskExporter;
import io.opentelemetry.android.features.diskbuffering.scheduler.ExportScheduleHandler;
Expand Down Expand Up @@ -530,6 +531,25 @@ public void verifyGlobalAttrsForLogs() {
.build());
}

@Test
public void testSamplerWithSessionConfigRatio() {
SessionConfig sessionConfig = new SessionConfig(0, 0, 0.0);
OtelRumConfig otelRumConfig = buildConfig().setSessionConfig(sessionConfig);

OpenTelemetryRum rum =
OpenTelemetryRum.builder(application, otelRumConfig)
.addTracerProviderCustomizer(
(tracerProviderBuilder, app) ->
tracerProviderBuilder.addSpanProcessor(
SimpleSpanProcessor.create(spanExporter)))
.build();

rum.getOpenTelemetry().getTracer("test").spanBuilder("test span").startSpan().end();

await().atMost(Duration.ofSeconds(30))
.untilAsserted(() -> assertThat(spanExporter.getFinishedSpanItems()).hasSize(0));
}

/**
* @noinspection KotlinInternalInJava
*/
Expand Down