Improve API ergonomics

Author: jack-berg

sdk/common/src/main/java/io/opentelemetry/sdk/internal/DefaultExceptionAttributeResolver.java

@@ -5,35 +5,30 @@
 
 package io.opentelemetry.sdk.internal;
 
-import io.opentelemetry.api.internal.ConfigUtil;
 import java.io.PrintWriter;
 import java.io.StringWriter;
 
 /**
- * This class is internal and experimental. Its APIs are unstable and can change at any time. Its
+ * The default {@link ExceptionAttributeResolver}, populating standard {@code exception.*} as
+ * defined by the semantic conventions.
+ *
+ * <p>This class is internal and experimental. Its APIs are unstable and can change at any time. Its
  * APIs (or a version of them) may be promoted to the public stable API in the future, but no
  * guarantees are made.
+ *
+ * @see ExceptionAttributeResolver#getDefault()
+ * @see ExceptionAttributeResolver#getDefault(boolean) ()
  */
-public final class DefaultExceptionAttributeResolver implements ExceptionAttributeResolver {
+final class DefaultExceptionAttributeResolver implements ExceptionAttributeResolver {
 
-  private static final String ENABLE_JVM_STACKTRACE_PROPERTY =
-      "otel.experimental.sdk.jvm_stacktrace";
-
-  private static final DefaultExceptionAttributeResolver INSTANCE =
-      new DefaultExceptionAttributeResolver(
-          Boolean.parseBoolean(ConfigUtil.getString(ENABLE_JVM_STACKTRACE_PROPERTY, "false")));
+  static final String ENABLE_JVM_STACKTRACE_PROPERTY = "otel.experimental.sdk.jvm_stacktrace";
 
   private final boolean jvmStacktraceEnabled;
 
-  // Visible for testing
   DefaultExceptionAttributeResolver(boolean jvmStacktraceEnabled) {
     this.jvmStacktraceEnabled = jvmStacktraceEnabled;
   }
 
-  public static ExceptionAttributeResolver getInstance() {
-    return INSTANCE;
-  }
-
   @Override
   public void setExceptionAttributes(
       AttributeSetter attributeSetter, Throwable throwable, int maxAttributeLength) {

sdk/common/src/main/java/io/opentelemetry/sdk/internal/ExceptionAttributeResolver.java

@@ -5,7 +5,10 @@
 
 package io.opentelemetry.sdk.internal;
 
+import static io.opentelemetry.sdk.internal.DefaultExceptionAttributeResolver.ENABLE_JVM_STACKTRACE_PROPERTY;
+
 import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.internal.ConfigUtil;
 import javax.annotation.Nullable;
 
 /**
@@ -24,6 +27,26 @@ public interface ExceptionAttributeResolver {
   void setExceptionAttributes(
       AttributeSetter attributeSetter, Throwable throwable, int maxAttributeLength);
 
+  /**
+   * Return the default exception attribute resolver, setting {@code jvmStacktraceEnabled} based on
+   * {@link DefaultExceptionAttributeResolver#ENABLE_JVM_STACKTRACE_PROPERTY}.
+   */
+  static ExceptionAttributeResolver getDefault() {
+    return getDefault(
+        Boolean.parseBoolean(ConfigUtil.getString(ENABLE_JVM_STACKTRACE_PROPERTY, "false")));
+  }
+
+  /**
+   * Return the default exception attribute resolver.
+   *
+   * @param jvmStacktraceEnabled if true, resolve stacktrace using the stacktrace renderer built
+   *     into the JVM. This built in JVM renderer is not attribute limits aware, and may utilize
+   *     more CPU / memory than is needed. Most users will prefer to set this to {@code false}.
+   */
+  static ExceptionAttributeResolver getDefault(boolean jvmStacktraceEnabled) {
+    return new DefaultExceptionAttributeResolver(jvmStacktraceEnabled);
+  }
+
   /**
    * This class is internal and experimental. Its APIs are unstable and can change at any time. Its
    * APIs (or a version of them) may be promoted to the public stable API in the future, but no

sdk/common/src/test/java/io/opentelemetry/sdk/internal/DefaultExceptionAttributeResolverTest.java

@@ -28,8 +28,8 @@ void setExceptionAttributes(
       String expectedMessage,
       String expectedType,
       Predicate<String> validStacktrace) {
-    DefaultExceptionAttributeResolver resolver =
-        new DefaultExceptionAttributeResolver(jvmStacktraceEnabled);
+    ExceptionAttributeResolver resolver =
+        ExceptionAttributeResolver.getDefault(jvmStacktraceEnabled);
     Map<String, Object> attributes = new HashMap<>();
 
     resolver.setExceptionAttributes(

sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLoggerProviderBuilder.java

@@ -12,7 +12,6 @@
 import io.opentelemetry.context.Context;
 import io.opentelemetry.sdk.common.Clock;
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
-import io.opentelemetry.sdk.internal.DefaultExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.ExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.ScopeConfigurator;
 import io.opentelemetry.sdk.internal.ScopeConfiguratorBuilder;
@@ -40,7 +39,7 @@ public final class SdkLoggerProviderBuilder {
   private ScopeConfiguratorBuilder<LoggerConfig> loggerConfiguratorBuilder =
       LoggerConfig.configuratorBuilder();
   private ExceptionAttributeResolver exceptionAttributeResolver =
-      DefaultExceptionAttributeResolver.getInstance();
+      ExceptionAttributeResolver.getDefault();
 
   SdkLoggerProviderBuilder() {}
 

sdk/logs/src/test/java/io/opentelemetry/sdk/logs/LoggerSharedStateTest.java

@@ -12,7 +12,7 @@
 
 import io.opentelemetry.sdk.common.Clock;
 import io.opentelemetry.sdk.common.CompletableResultCode;
-import io.opentelemetry.sdk.internal.DefaultExceptionAttributeResolver;
+import io.opentelemetry.sdk.internal.ExceptionAttributeResolver;
 import io.opentelemetry.sdk.resources.Resource;
 import org.junit.jupiter.api.Test;
 
@@ -29,7 +29,7 @@ void shutdown() {
             LogLimits::getDefault,
             logRecordProcessor,
             Clock.getDefault(),
-            DefaultExceptionAttributeResolver.getInstance());
+            ExceptionAttributeResolver.getDefault());
     state.shutdown();
     state.shutdown();
     verify(logRecordProcessor, times(1)).shutdown();

sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkTracerProviderBuilder.java

@@ -10,7 +10,6 @@
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.sdk.common.Clock;
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
-import io.opentelemetry.sdk.internal.DefaultExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.ExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.ScopeConfigurator;
 import io.opentelemetry.sdk.internal.ScopeConfiguratorBuilder;
@@ -38,7 +37,7 @@ public final class SdkTracerProviderBuilder {
   private ScopeConfiguratorBuilder<TracerConfig> tracerConfiguratorBuilder =
       TracerConfig.configuratorBuilder();
   private ExceptionAttributeResolver exceptionAttributeResolver =
-      DefaultExceptionAttributeResolver.getInstance();
+      ExceptionAttributeResolver.getDefault();
 
   /**
    * Assign a {@link Clock}. {@link Clock} will be used each time a {@link Span} is started, ended

sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkSpanTest.java

@@ -38,7 +38,6 @@
 import io.opentelemetry.context.Context;
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
 import io.opentelemetry.sdk.internal.AttributesMap;
-import io.opentelemetry.sdk.internal.DefaultExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.ExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.InstrumentationScopeUtil;
 import io.opentelemetry.sdk.resources.Resource;
@@ -946,7 +945,7 @@ void addLink() {
             parentSpanId,
             null,
             null,
-            DefaultExceptionAttributeResolver.getInstance());
+            ExceptionAttributeResolver.getDefault());
     try {
       Span span1 = createTestSpan(SpanKind.INTERNAL);
       Span span2 = createTestSpan(SpanKind.INTERNAL);
@@ -1036,7 +1035,7 @@ void addLink_FaultIn() {
             Context.root(),
             SpanLimits.getDefault(),
             spanProcessor,
-            DefaultExceptionAttributeResolver.getInstance(),
+            ExceptionAttributeResolver.getDefault(),
             testClock,
             resource,
             null,
@@ -1381,7 +1380,7 @@ void onStartOnEndNotRequired() {
             Context.root(),
             spanLimits,
             spanProcessor,
-            DefaultExceptionAttributeResolver.getInstance(),
+            ExceptionAttributeResolver.getDefault(),
             testClock,
             resource,
             AttributesMap.create(
@@ -1464,7 +1463,7 @@ private SdkSpan createTestSpanWithAttributes(Map<AttributeKey, Object> attribute
         null,
         attributesMap,
         Collections.singletonList(link),
-        DefaultExceptionAttributeResolver.getInstance());
+        ExceptionAttributeResolver.getDefault());
   }
 
   private SdkSpan createTestRootSpan() {
@@ -1474,7 +1473,7 @@ private SdkSpan createTestRootSpan() {
         SpanId.getInvalid(),
         null,
         Collections.singletonList(link),
-        DefaultExceptionAttributeResolver.getInstance());
+        ExceptionAttributeResolver.getDefault());
   }
 
   private SdkSpan createTestSpan(SpanKind kind) {
@@ -1484,7 +1483,7 @@ private SdkSpan createTestSpan(SpanKind kind) {
         parentSpanId,
         null,
         Collections.singletonList(link),
-        DefaultExceptionAttributeResolver.getInstance());
+        ExceptionAttributeResolver.getDefault());
   }
 
   private SdkSpan createTestSpan(SpanLimits config) {
@@ -1494,7 +1493,7 @@ private SdkSpan createTestSpan(SpanLimits config) {
         parentSpanId,
         null,
         Collections.singletonList(link),
-        DefaultExceptionAttributeResolver.getInstance());
+        ExceptionAttributeResolver.getDefault());
   }
 
   private SdkSpan createTestSpan(
@@ -1608,7 +1607,7 @@ void testAsSpanData() {
             Context.root(),
             spanLimits,
             spanProcessor,
-            DefaultExceptionAttributeResolver.getInstance(),
+            ExceptionAttributeResolver.getDefault(),
             clock,
             resource,
             attributesWithCapacity,

sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkTracerProviderTest.java

@@ -22,7 +22,6 @@
 import io.opentelemetry.sdk.common.Clock;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
-import io.opentelemetry.sdk.internal.DefaultExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.ExceptionAttributeResolver;
 import io.opentelemetry.sdk.internal.ScopeConfigurator;
 import io.opentelemetry.sdk.resources.Resource;
@@ -298,7 +297,7 @@ void exceptionAttributeResolver() {
             .setSpanLimits(
                 SpanLimits.builder().setMaxAttributeValueLength(maxAttributeLength).build());
     ExceptionAttributeResolver exceptionAttributeResolver =
-        spy(DefaultExceptionAttributeResolver.getInstance());
+        spy(ExceptionAttributeResolver.getDefault());
     SdkTracerProviderUtil.setExceptionAttributeResolver(builder, exceptionAttributeResolver);
 
     Exception exception = new Exception("error");