NH-94685: capture stacktrace for span

.github/workflows/rlscan.yml

@@ -8,6 +8,10 @@ on:
 permissions:
   contents: read
 
+env:
+  GITHUB_USERNAME: ${{ github.actor }}
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
 jobs:
   reversing_lab_scan_agent:
     runs-on: ubuntu-latest

build.gradle

@@ -50,7 +50,7 @@ subprojects {
                 opentelemetryJavaagent: property('otel.agent.version'),
                 bytebuddy             : "1.15.10",
                 guava                 : "30.1-jre",
-                joboe                 : "10.0.15",
+                joboe                 : "10.0.16",
                 agent                 : swoVersion, // the custom distro agent version
                 autoservice           : "1.0.1",
                 caffeine              : "2.9.3",

custom/lambda/src/main/java/com/solarwinds/opentelemetry/extensions/PropertiesSupplier.java

@@ -17,6 +17,7 @@
 package com.solarwinds.opentelemetry.extensions;
 
 import static com.solarwinds.opentelemetry.extensions.SharedNames.COMPONENT_NAME;
+import static com.solarwinds.opentelemetry.extensions.SharedNames.SPAN_STACKTRACE_FILTER_CLASS;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -30,6 +31,8 @@ public PropertiesSupplier() {
     defaultProperties.put(
         "otel.propagators", String.format("tracecontext,baggage,%s,xray", COMPONENT_NAME));
     defaultProperties.put("otel.instrumentation.runtime-telemetry.enabled", "false");
+    defaultProperties.put(
+        "otel.java.experimental.span-stacktrace.filter", SPAN_STACKTRACE_FILTER_CLASS);
     defaultProperties.put("otel.exporter.otlp.protocol", "grpc");
   }
 

custom/shared/build.gradle

@@ -40,6 +40,9 @@ dependencies {
   implementation "org.json:json:${versions.json}"
   implementation "com.google.code.gson:gson:2.10.1"
   implementation "com.github.ben-manes.caffeine:caffeine:${versions.caffeine}"
+  implementation("io.opentelemetry.contrib:opentelemetry-span-stacktrace:${property('otel.java.contrib.version')}") {
+    exclude(module: "opentelemetry-sdk", group: "io.opentelemetry") // the agent includes this
+  }
 
   testImplementation("org.json:json:${versions.json}")
   testImplementation "com.solarwinds.joboe:sampling:${versions.joboe}"

custom/shared/src/main/java/com/solarwinds/opentelemetry/extensions/SharedNames.java

@@ -23,6 +23,9 @@ private SharedNames() {}
 
   public static String TRANSACTION_NAME_KEY = "sw.transaction";
 
+  public static String SPAN_STACKTRACE_FILTER_CLASS =
+      "com.solarwinds.opentelemetry.extensions.SpanStacktraceFilter";
+
   // This is visible to customer via span layer and can be used to configure transaction
   // filtering setting.
   public static final String LAYER_NAME_PLACEHOLDER = "%s:%s";

custom/shared/src/main/java/com/solarwinds/opentelemetry/extensions/SpanStacktraceFilter.java

@@ -0,0 +1,44 @@
+/*
+ * © SolarWinds Worldwide, LLC. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+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.sdk.trace.ReadableSpan;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.function.Predicate;
+
+public class SpanStacktraceFilter implements Predicate<ReadableSpan> {
+  private static final Set<String> filterAttributes = new HashSet<>();
+
+  static {
+    filterAttributes.add("db.system");
+    Set<String> configuredFilterAttributes =
+        ConfigManager.getConfigOptional(
+            ConfigProperty.AGENT_SPAN_STACK_TRACE_FILTERS, filterAttributes);
+    filterAttributes.addAll(configuredFilterAttributes);
+  }
+
+  @Override
+  public boolean test(ReadableSpan readableSpan) {
+    return filterAttributes.stream()
+        .anyMatch(attr -> readableSpan.getAttribute(stringKey(attr)) != null);
+  }
+}

custom/shared/src/main/java/com/solarwinds/opentelemetry/extensions/StackTraceFilterParser.java

@@ -0,0 +1,45 @@
+/*
+ * © SolarWinds Worldwide, LLC. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.solarwinds.opentelemetry.extensions;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonSyntaxException;
+import com.google.gson.reflect.TypeToken;
+import com.solarwinds.joboe.config.ConfigParser;
+import com.solarwinds.joboe.config.InvalidConfigException;
+import java.lang.reflect.Type;
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+public final class StackTraceFilterParser implements ConfigParser<String, Set<String>> {
+  private static final Gson gson = new GsonBuilder().create();
+
+  @Override
+  public Set<String> convert(String input) throws InvalidConfigException {
+    try {
+      if (input.startsWith("[")) {
+        Type type = new TypeToken<Set<String>>() {}.getType();
+        return gson.fromJson(input, type);
+      }
+      return Arrays.stream(input.split(",")).map(String::trim).collect(Collectors.toSet());
+    } catch (JsonSyntaxException e) {
+      throw new InvalidConfigException(e);
+    }
+  }
+}

custom/shared/src/test/java/com/solarwinds/opentelemetry/extensions/SpanStacktraceFilterTest.java

@@ -0,0 +1,47 @@
+/*
+ * © SolarWinds Worldwide, LLC. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.solarwinds.opentelemetry.extensions;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.when;
+
+import io.opentelemetry.sdk.trace.ReadableSpan;
+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;
+
+  @Mock private ReadableSpan readableSpanMock;
+
+  @Test
+  void returnTrueWhenAttributeHasValue() {
+    when(readableSpanMock.getAttribute(any())).thenReturn("test-value");
+    assertTrue(tested.test(readableSpanMock));
+  }
+
+  @Test
+  void returnFalseWhenAttributeHasNoValue() {
+    assertFalse(tested.test(readableSpanMock));
+  }
+}

custom/shared/src/test/java/com/solarwinds/opentelemetry/extensions/StackTraceFilterParserTest.java

@@ -0,0 +1,53 @@
+/*
+ * © SolarWinds Worldwide, LLC. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.solarwinds.opentelemetry.extensions;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import com.solarwinds.joboe.config.InvalidConfigException;
+import java.util.HashSet;
+import java.util.Set;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+@ExtendWith(MockitoExtension.class)
+class StackTraceFilterParserTest {
+
+  @InjectMocks private StackTraceFilterParser tested;
+
+  @Test
+  void returnListOfStringGivenCommaSeparatedString() throws InvalidConfigException {
+    String input = "name,  status";
+    Set<String> expected = new HashSet<>();
+    expected.add("name");
+
+    expected.add("status");
+    assertEquals(expected, tested.convert(input));
+  }
+
+  @Test
+  void returnListOfStringGivenJsonList() throws InvalidConfigException {
+    String input = "[\"name\",\"status\"]";
+    Set<String> expected = new HashSet<>();
+    expected.add("name");
+
+    expected.add("status");
+    assertEquals(expected, tested.convert(input));
+  }
+}

custom/src/main/java/com/solarwinds/opentelemetry/extensions/SolarwindsPropertiesSupplier.java

@@ -17,6 +17,7 @@
 package com.solarwinds.opentelemetry.extensions;
 
 import static com.solarwinds.opentelemetry.extensions.SharedNames.COMPONENT_NAME;
+import static com.solarwinds.opentelemetry.extensions.SharedNames.SPAN_STACKTRACE_FILTER_CLASS;
 import static com.solarwinds.opentelemetry.extensions.initialize.AutoConfigurationCustomizerProviderImpl.isAgentEnabled;
 
 import java.util.HashMap;
@@ -31,6 +32,8 @@ public class SolarwindsPropertiesSupplier implements Supplier<Map<String, String
     if (isAgentEnabled()) {
       PROPERTIES.put("otel.metrics.exporter", "none");
       PROPERTIES.put("otel.logs.exporter", "none");
+
+      PROPERTIES.put("otel.java.experimental.span-stacktrace.filter", SPAN_STACKTRACE_FILTER_CLASS);
       PROPERTIES.put("otel.propagators", String.format("tracecontext,baggage,%s", COMPONENT_NAME));
     } else {
       PROPERTIES.put("otel.sdk.disabled", "true");

custom/src/main/java/com/solarwinds/opentelemetry/extensions/initialize/ConfigurationLoader.java

@@ -42,6 +42,7 @@
 import com.solarwinds.opentelemetry.extensions.NamingScheme;
 import com.solarwinds.opentelemetry.extensions.RangeValidationParser;
 import com.solarwinds.opentelemetry.extensions.SqlTagDatabasesParser;
+import com.solarwinds.opentelemetry.extensions.StackTraceFilterParser;
 import com.solarwinds.opentelemetry.extensions.TracingModeParser;
 import com.solarwinds.opentelemetry.extensions.TransactionNameManager;
 import com.solarwinds.opentelemetry.extensions.TransactionNamingScheme;
@@ -101,6 +102,7 @@ public class ConfigurationLoader {
     ConfigProperty.PROFILER.setParser(ProfilerSettingParser.INSTANCE);
     ConfigProperty.AGENT_TRANSACTION_NAMING_SCHEMES.setParser(new TransactionNamingSchemesParser());
     ConfigProperty.AGENT_SQL_TAG_DATABASES.setParser(new SqlTagDatabasesParser());
+    ConfigProperty.AGENT_SPAN_STACK_TRACE_FILTERS.setParser(new StackTraceFilterParser());
   }
 
   public static void load() throws InvalidConfigException {

gradle.properties

@@ -19,6 +19,7 @@ systemProp.org.gradle.internal.repository.max.retries=10
 systemProp.org.gradle.internal.repository.initial.backoff=500
 
 # Project properties provides a central place for shared property among subprojects
+swo.agent.version=2.10.0
 otel.agent.version=2.10.0
 otel.sdk.version=1.44.1
-swo.agent.version=2.10.0
+otel.java.contrib.version=1.40.0-alpha