Skip to content

use key presence for stacktrace filter instead of value #400

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

Merged
cleverchuk merged 2 commits into from
Dec 18, 2025
Merged

use key presence for stacktrace filter instead of value #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e099da2
use key presence for stacktrace filter instead of value
cleverchuk Dec 15, 2025
317dddf
optimize
cleverchuk Dec 17, 2025
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
23 changes: 15 additions & 8 deletions ...om/shared/src/main/java/com/solarwinds/opentelemetry/extensions/SpanStacktraceFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,36 @@

package com.solarwinds.opentelemetry.extensions;

import static io.opentelemetry.api.common.AttributeKey.stringKey;

import com.solarwinds.joboe.config.ConfigManager;
import com.solarwinds.joboe.config.ConfigProperty;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.sdk.trace.ReadableSpan;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;

public class SpanStacktraceFilter implements Predicate<ReadableSpan> {
private static final Set<String> filterAttributes = new HashSet<>();
private Set<String> filterAttributes = new HashSet<>();

@Override
public boolean test(ReadableSpan readableSpan) {
if (filterAttributes.isEmpty()) {
filterAttributes.add("db.system");
Set<String> configuredFilterAttributes =
ConfigManager.getConfigOptional(
ConfigProperty.AGENT_SPAN_STACKTRACE_FILTERS, filterAttributes);
filterAttributes.addAll(configuredFilterAttributes);
ConfigProperty.AGENT_SPAN_STACKTRACE_FILTERS, Collections.singleton("db.system"));

Set<String> effectiveFilterAttributes = new HashSet<>(configuredFilterAttributes);
effectiveFilterAttributes.add("db.system");
filterAttributes = effectiveFilterAttributes;
}

return filterAttributes.stream()
.anyMatch(attr -> readableSpan.getAttribute(stringKey(attr)) != null);
Set<String> attributes =
readableSpan.getAttributes().asMap().keySet().stream()
.map(AttributeKey::getKey)
.collect(Collectors.toSet());

return filterAttributes.stream().anyMatch(attributes::contains);
}
}
98 changes: 84 additions & 14 deletions ...hared/src/test/java/com/solarwinds/opentelemetry/extensions/SpanStacktraceFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,102 @@

package com.solarwinds.opentelemetry.extensions;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.ArgumentMatchers.any;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import com.solarwinds.joboe.config.ConfigManager;
import com.solarwinds.joboe.config.ConfigProperty;
import com.solarwinds.joboe.config.InvalidConfigException;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.sdk.trace.ReadableSpan;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

@ExtendWith(MockitoExtension.class)
class SpanStacktraceFilterTest {

@InjectMocks private SpanStacktraceFilter tested;
private SpanStacktraceFilter tested;

@Mock private ReadableSpan readableSpanMock;
@BeforeEach
void setUp() {
tested = new SpanStacktraceFilter();
}

@AfterEach
void tearDown() {
ConfigManager.reset();
}

@Test
void returnTrueWhenSpanHasMultipleMatchingAttributes() {
ReadableSpan span =
createSpanWithAttributes(
Attributes.builder().put("db.system", "postgresql").put("http.method", "GET").build());
assertTrue(tested.test(span));
}

@Test
void returnFalseWhenSpanHasNoAttributes() {
ReadableSpan span = createSpanWithAttributes(Attributes.empty());
assertFalse(tested.test(span));
}

@Test
void returnTrueWhenSpanHasCustomConfiguredLongAttribute() throws InvalidConfigException {
Set<String> customFilters = new HashSet<>();
customFilters.add("process.id");
ConfigManager.setConfig(ConfigProperty.AGENT_SPAN_STACKTRACE_FILTERS, customFilters);

SpanStacktraceFilter filter = new SpanStacktraceFilter();
ReadableSpan span =
createSpanWithAttributes(Attributes.builder().put("process.id", 450).build());

assertTrue(filter.test(span));
}

@Test
void returnTrueWhenAttributeHasValue() {
when(readableSpanMock.getAttribute(any())).thenReturn("test-value");
assertTrue(tested.test(readableSpanMock));
void returnTrueWhenSpanHasCustomConfiguredStringArrayAttribute() throws InvalidConfigException {
Set<String> customFilters = new HashSet<>();
customFilters.add("messaging.systems");
ConfigManager.setConfig(ConfigProperty.AGENT_SPAN_STACKTRACE_FILTERS, customFilters);

SpanStacktraceFilter filter = new SpanStacktraceFilter();
ReadableSpan spanWithMessaging =
createSpanWithAttributes(
Attributes.builder()
.put(
AttributeKey.stringArrayKey("messaging.systems"),
Arrays.asList("postgresql", "rabbitmq"))
.build());

assertTrue(filter.test(spanWithMessaging));
}

@Test
void returnFalseWhenAttributeHasNoValue() {
assertFalse(tested.test(readableSpanMock));
void returnTrueWhenSpanHasCustomConfiguredLongArrayAttribute() throws InvalidConfigException {
Set<String> customFilters = new HashSet<>();
customFilters.add("process.ids");
ConfigManager.setConfig(ConfigProperty.AGENT_SPAN_STACKTRACE_FILTERS, customFilters);

SpanStacktraceFilter filter = new SpanStacktraceFilter();
ReadableSpan span =
createSpanWithAttributes(
Attributes.builder()
.put(AttributeKey.longArrayKey("process.ids"), Arrays.asList(200L, 300L))
.build());

assertTrue(filter.test(span));
}

private ReadableSpan createSpanWithAttributes(Attributes attributes) {
ReadableSpan span = mock(ReadableSpan.class);
when(span.getAttributes()).thenReturn(attributes);
return span;
}
}
Loading