Metric Schema and config name changes

In this commit, we are removing RemoteTarget and replacing with
RemoteResourceIdentifier and RemoteResourceType. Further, we are
formatting RemoteService, and the content of the RemoteResource
attributes such that they align with AWS Cloud Control resource names.

In addition to these changes, we are modifying the config names used for
enabling and configuring Application Signals to use the full feature name,
"application.signals".

Author: thpierce

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/awssdk/base/AwsSdkBaseTest.java

@@ -57,26 +57,6 @@ protected String getKinesisSpanNamePrefix() {
     return "Kinesis";
   }
 
-  @Override
-  protected String getS3ServiceName() {
-    return "AWS.SDK.Amazon S3";
-  }
-
-  @Override
-  protected String getDynamoDbServiceName() {
-    return "AWS.SDK.AmazonDynamoDBv2";
-  }
-
-  @Override
-  protected String getSqsServiceName() {
-    return "AWS.SDK.AmazonSQS";
-  }
-
-  @Override
-  protected String getKinesisServiceName() {
-    return "AWS.SDK.AmazonKinesis";
-  }
-
   protected String getS3RpcServiceName() {
     return "Amazon S3";
   }

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/awssdk/v1/AwsSdkV1Test.java

@@ -56,25 +56,6 @@ protected String getKinesisSpanNamePrefix() {
     return "Kinesis";
   }
 
-  @Override
-  protected String getS3ServiceName() {
-    return "AWS.SDK.S3";
-  }
-
-  @Override
-  protected String getDynamoDbServiceName() {
-    return "AWS.SDK.DynamoDb";
-  }
-
-  @Override
-  protected String getSqsServiceName() {
-    return "AWS.SDK.Sqs";
-  }
-
-  protected String getKinesisServiceName() {
-    return "AWS.SDK.Kinesis";
-  }
-
   @Override
   protected String getS3RpcServiceName() {
     return "S3";

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/awssdk/v2/AwsSdkV2Test.java

@@ -78,11 +78,11 @@ public abstract class ContractTestBase {
           .waitingFor(getApplicationWaitCondition())
           .withEnv("JAVA_TOOL_OPTIONS", "-javaagent:/opentelemetry-javaagent-all.jar")
           .withEnv("OTEL_METRIC_EXPORT_INTERVAL", "100") // 100 ms
-          .withEnv("OTEL_AWS_APP_SIGNALS_ENABLED", "true")
+          .withEnv("OTEL_AWS_APPLICATION_SIGNALS_ENABLED", "true")
           .withEnv("OTEL_METRICS_EXPORTER", "none")
           .withEnv("OTEL_BSP_SCHEDULE_DELAY", "0") // Don't wait to export spans to the collector
           .withEnv(
-              "OTEL_AWS_APP_SIGNALS_EXPORTER_ENDPOINT",
+              "OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT",
               "http://" + COLLECTOR_HOSTNAME + ":" + COLLECTOR_PORT)
           .withEnv(
               "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT",

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/base/ContractTestBase.java

@@ -29,6 +29,7 @@ public class AppSignalsConstants {
   public static final String AWS_LOCAL_OPERATION = "aws.local.operation";
   public static final String AWS_REMOTE_SERVICE = "aws.remote.service";
   public static final String AWS_REMOTE_OPERATION = "aws.remote.operation";
-  public static final String AWS_REMOTE_TARGET = "aws.remote.target";
+  public static final String AWS_REMOTE_RESOURCE_TYPE = "aws.remote.resource.type";
+  public static final String AWS_REMOTE_RESOURCE_IDENTIFIER = "aws.remote.resource.identifier";
   public static final String AWS_SPAN_KIND = "aws.span.kind";
 }

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/utils/AppSignalsConstants.java

@@ -52,14 +52,24 @@
  * </ul>
  *
  * <p>You can control when these customizations are applied using the property
- * otel.aws.app.signals.enabled or the environment variable OTEL_AWS_APP_SIGNALS_ENABLED. This flag
- * is disabled by default.
+ * otel.aws.application.signals.enabled or the environment variable
+ * OTEL_AWS_APPLICATION_SIGNALS_ENABLED. This flag is disabled by default.
  */
 public class AwsAppSignalsCustomizerProvider implements AutoConfigurationCustomizerProvider {
   private static final Duration DEFAULT_METRIC_EXPORT_INTERVAL = Duration.ofMinutes(1);
   private static final Logger logger =
       Logger.getLogger(AwsAppSignalsCustomizerProvider.class.getName());
 
+  private static final String SMP_ENABLED_CONFIG = "otel.smp.enabled";
+  private static final String APP_SIGNALS_ENABLED_CONFIG = "otel.aws.app.signals.enabled";
+  private static final String APPLICATION_SIGNALS_ENABLED_CONFIG =
+      "otel.aws.application.signals.enabled";
+  private static final String SMP_EXPORTER_ENDPOINT_CONFIG = "otel.aws.smp.exporter.endpoint";
+  private static final String APP_SIGNALS_EXPORTER_ENDPOINT_CONFIG =
+      "otel.aws.app.signals.exporter.endpoint";
+  private static final String APPLICATION_SIGNALS_EXPORTER_ENDPOINT_CONFIG =
+      "otel.aws.application.signals.exporter.endpoint";
+
   public void customize(AutoConfigurationCustomizer autoConfiguration) {
     autoConfiguration.addSamplerCustomizer(this::customizeSampler);
     autoConfiguration.addTracerProviderCustomizer(this::customizeTracerProviderBuilder);
@@ -68,7 +78,9 @@ public void customize(AutoConfigurationCustomizer autoConfiguration) {
 
   private boolean isAppSignalsEnabled(ConfigProperties configProps) {
     return configProps.getBoolean(
-        "otel.aws.app.signals.enabled", configProps.getBoolean("otel.smp.enabled", false));
+        APPLICATION_SIGNALS_ENABLED_CONFIG,
+        configProps.getBoolean(
+            APP_SIGNALS_ENABLED_CONFIG, configProps.getBoolean(SMP_ENABLED_CONFIG, false)));
   }
 
   private Sampler customizeSampler(Sampler sampler, ConfigProperties configProps) {
@@ -141,9 +153,10 @@ public MetricExporter createExporter(ConfigProperties configProps) {
       if (protocol.equals(OtlpConfigUtil.PROTOCOL_HTTP_PROTOBUF)) {
         appSignalsEndpoint =
             configProps.getString(
-                "otel.aws.app.signals.exporter.endpoint",
+                APPLICATION_SIGNALS_EXPORTER_ENDPOINT_CONFIG,
                 configProps.getString(
-                    "otel.aws.smp.exporter.endpoint", "http://localhost:4316/v1/metrics"));
+                    APP_SIGNALS_EXPORTER_ENDPOINT_CONFIG,
+                    configProps.getString(SMP_EXPORTER_ENDPOINT_CONFIG, "http://localhost:4316/v1/metrics")));
         logger.log(Level.FINE, String.format("AppSignals export endpoint: %s", appSignalsEndpoint));
         return OtlpHttpMetricExporter.builder()
             .setEndpoint(appSignalsEndpoint)
@@ -153,8 +166,10 @@ public MetricExporter createExporter(ConfigProperties configProps) {
       } else if (protocol.equals(OtlpConfigUtil.PROTOCOL_GRPC)) {
         appSignalsEndpoint =
             configProps.getString(
-                "otel.aws.app.signals.exporter.endpoint",
-                configProps.getString("otel.aws.smp.exporter.endpoint", "http://localhost:4315"));
+                APPLICATION_SIGNALS_EXPORTER_ENDPOINT_CONFIG,
+                configProps.getString(
+                    APP_SIGNALS_EXPORTER_ENDPOINT_CONFIG,
+                    configProps.getString(SMP_EXPORTER_ENDPOINT_CONFIG, "http://localhost:4315")));
         logger.log(Level.FINE, String.format("AppSignals export endpoint: %s", appSignalsEndpoint));
         return OtlpGrpcMetricExporter.builder()
             .setEndpoint(appSignalsEndpoint)

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/AwsAppSignalsCustomizerProvider.java

@@ -35,21 +35,25 @@ private AwsAttributeKeys() {}
   static final AttributeKey<String> AWS_REMOTE_OPERATION =
       AttributeKey.stringKey("aws.remote.operation");
 
-  static final AttributeKey<String> AWS_REMOTE_TARGET = AttributeKey.stringKey("aws.remote.target");
+  static final AttributeKey<String> AWS_REMOTE_RESOURCE_IDENTIFIER =
+      AttributeKey.stringKey("aws.remote.resource.identifier");
+
+  static final AttributeKey<String> AWS_REMOTE_RESOURCE_TYPE =
+      AttributeKey.stringKey("aws.remote.resource.type");
 
   static final AttributeKey<String> AWS_SDK_DESCENDANT =
       AttributeKey.stringKey("aws.sdk.descendant");
 
+  static final AttributeKey<String> AWS_CONSUMER_PARENT_SPAN_KIND =
+      AttributeKey.stringKey("aws.consumer.parent.span.kind");
+
   // use the same AWS Resource attribute name defined by OTel java auto-instr for aws_sdk_v_1_1
   // TODO: all AWS specific attributes should be defined in semconv package and reused cross all
   // otel packages. Related sim -
   // https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/8710
-
   static final AttributeKey<String> AWS_BUCKET_NAME = AttributeKey.stringKey("aws.bucket.name");
   static final AttributeKey<String> AWS_QUEUE_URL = AttributeKey.stringKey("aws.queue.url");
   static final AttributeKey<String> AWS_QUEUE_NAME = AttributeKey.stringKey("aws.queue.name");
   static final AttributeKey<String> AWS_STREAM_NAME = AttributeKey.stringKey("aws.stream.name");
   static final AttributeKey<String> AWS_TABLE_NAME = AttributeKey.stringKey("aws.table.name");
-  static final AttributeKey<String> AWS_CONSUMER_PARENT_SPAN_KIND =
-      AttributeKey.stringKey("aws.consumer.parent.span.kind");
 }

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/AwsAttributeKeys.java

@@ -40,8 +40,9 @@
 import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_QUEUE_NAME;
 import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_QUEUE_URL;
 import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_REMOTE_OPERATION;
+import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_REMOTE_RESOURCE_IDENTIFIER;
+import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_REMOTE_RESOURCE_TYPE;
 import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_REMOTE_SERVICE;
-import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_REMOTE_TARGET;
 import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_SPAN_KIND;
 import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_STREAM_NAME;
 import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_TABLE_NAME;
@@ -88,6 +89,12 @@ final class AwsMetricAttributeGenerator implements MetricAttributeGenerator {
   private static final Logger logger =
       Logger.getLogger(AwsMetricAttributeGenerator.class.getName());
 
+  // Normalized remote service names for supported AWS services
+  private static final String NORMALIZED_DYNAMO_DB_SERVICE_NAME = "AWS::DynamoDB";
+  private static final String NORMALIZED_KINESIS_SERVICE_NAME = "AWS::Kinesis";
+  private static final String NORMALIZED_S3_SERVICE_NAME = "AWS::S3";
+  private static final String NORMALIZED_SQS_SERVICE_NAME = "AWS::SQS";
+
   // Special DEPENDENCY attribute value if GRAPHQL_OPERATION_TYPE attribute key is present.
   private static final String GRAPHQL = "graphql";
 
@@ -129,51 +136,13 @@ private Attributes generateDependencyMetricAttributes(SpanData span, Resource re
     setService(resource, span, builder);
     setEgressOperation(span, builder);
     setRemoteServiceAndOperation(span, builder);
-    setRemoteTarget(span, builder);
+    setRemoteResourceTypeAndIdentifier(span, builder);
     setSpanKindForDependency(span, builder);
     setHttpStatus(span, builder);
 
     return builder.build();
   }
 
-  private static void setRemoteTarget(SpanData span, AttributesBuilder builder) {
-    Optional<String> remoteTarget = getRemoteTarget(span);
-    remoteTarget.ifPresent(s -> builder.put(AWS_REMOTE_TARGET, s));
-  }
-
-  /**
-   * RemoteTarget attribute {@link AwsAttributeKeys#AWS_REMOTE_TARGET} is used to store the resource
-   * name of the remote invokes, such as S3 bucket name, mysql table name, etc. TODO: currently only
-   * support AWS resource name, will be extended to support the general remote targets, such as
-   * ActiveMQ name, etc.
-   */
-  private static Optional<String> getRemoteTarget(SpanData span) {
-    if (isKeyPresent(span, AWS_BUCKET_NAME)) {
-      return Optional.ofNullable("::s3:::" + span.getAttributes().get(AWS_BUCKET_NAME));
-    }
-
-    if (isKeyPresent(span, AWS_QUEUE_URL)) {
-      String arn = SqsUrlParser.getSqsRemoteTarget(span.getAttributes().get(AWS_QUEUE_URL));
-
-      if (arn != null) {
-        return Optional.ofNullable(arn);
-      }
-    }
-
-    if (isKeyPresent(span, AWS_QUEUE_NAME)) {
-      return Optional.ofNullable("::sqs:::" + span.getAttributes().get(AWS_QUEUE_NAME));
-    }
-
-    if (isKeyPresent(span, AWS_STREAM_NAME)) {
-      return Optional.ofNullable("::kinesis:::stream/" + span.getAttributes().get(AWS_STREAM_NAME));
-    }
-
-    if (isKeyPresent(span, AWS_TABLE_NAME)) {
-      return Optional.ofNullable("::dynamodb:::table/" + span.getAttributes().get(AWS_TABLE_NAME));
-    }
-    return Optional.empty();
-  }
-
   /** Service is always derived from {@link ResourceAttributes#SERVICE_NAME} */
   private static void setService(Resource resource, SpanData span, AttributesBuilder builder) {
     String service = resource.getAttribute(SERVICE_NAME);
@@ -213,14 +182,6 @@ private static void setEgressOperation(SpanData span, AttributesBuilder builder)
     builder.put(AWS_LOCAL_OPERATION, operation);
   }
 
-  // add `AWS.SDK.` as prefix to indicate the metrics resulted from current span is from AWS SDK
-  private static String normalizeServiceName(SpanData span, String serviceName) {
-    if (AwsSpanProcessingUtil.isAwsSDKSpan(span)) {
-      return "AWS.SDK." + serviceName;
-    }
-    return serviceName;
-  }
-
   /**
    * Remote attributes (only for Client and Producer spans) are generated based on low-cardinality
    * span attributes, in priority order.
@@ -265,7 +226,7 @@ private static void setRemoteServiceAndOperation(SpanData span, AttributesBuilde
       remoteService = getRemoteService(span, AWS_REMOTE_SERVICE);
       remoteOperation = getRemoteOperation(span, AWS_REMOTE_OPERATION);
     } else if (isKeyPresent(span, RPC_SERVICE) || isKeyPresent(span, RPC_METHOD)) {
-      remoteService = normalizeServiceName(span, getRemoteService(span, RPC_SERVICE));
+      remoteService = normalizeRemoteServiceName(span, getRemoteService(span, RPC_SERVICE));
       remoteOperation = getRemoteOperation(span, RPC_METHOD);
     } else if (isKeyPresent(span, DB_SYSTEM)
         || isKeyPresent(span, DB_OPERATION)
@@ -365,6 +326,72 @@ private static String generateRemoteService(SpanData span) {
     return remoteService;
   }
 
+  /**
+   * If the span is an AWS SDK span, normalize the name to align with <a
+   * href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html">AWS
+   * Cloud Control resource format</a> as much as possible, with special attention to services we
+   * can detect remote resource information for. Long term, we would like to normalize service name
+   * in the upstream.
+   */
+  private static String normalizeRemoteServiceName(SpanData span, String serviceName) {
+    if (AwsSpanProcessingUtil.isAwsSDKSpan(span)) {
+      switch (serviceName) {
+        case "AmazonDynamoDBv2": // AWS SDK v1
+        case "DynamoDb": // AWS SDK v2
+          return NORMALIZED_DYNAMO_DB_SERVICE_NAME;
+        case "AmazonKinesis": // AWS SDK v1
+        case "Kinesis": // AWS SDK v2
+          return NORMALIZED_KINESIS_SERVICE_NAME;
+        case "Amazon S3": // AWS SDK v1
+        case "S3": // AWS SDK v2
+          return NORMALIZED_S3_SERVICE_NAME;
+        case "AmazonSQS": // AWS SDK v1
+        case "Sqs": // AWS SDK v2
+          return NORMALIZED_SQS_SERVICE_NAME;
+        default:
+          return "AWS::" + serviceName;
+      }
+    }
+    return serviceName;
+  }
+
+  /**
+   * Remote resource attributes {@link AwsAttributeKeys#AWS_REMOTE_RESOURCE_TYPE} and {@link
+   * AwsAttributeKeys#AWS_REMOTE_RESOURCE_IDENTIFIER} are used to store information about the
+   * resource associated with the remote invocation, such as S3 bucket name, etc. We should only
+   * ever set both type and identifier or neither.
+   *
+   * <p>AWS resources type and identifier adhere to <a
+   * href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html">AWS
+   * Cloud Control resource format</a>.
+   */
+  private static void setRemoteResourceTypeAndIdentifier(SpanData span, AttributesBuilder builder) {
+    Optional<String> remoteResourceType = Optional.empty();
+    Optional<String> remoteResourceIdentifier = Optional.empty();
+
+    if (isKeyPresent(span, AWS_TABLE_NAME)) {
+      remoteResourceType = Optional.of(NORMALIZED_DYNAMO_DB_SERVICE_NAME + "::Table");
+      remoteResourceIdentifier = Optional.ofNullable(span.getAttributes().get(AWS_TABLE_NAME));
+    } else if (isKeyPresent(span, AWS_STREAM_NAME)) {
+      remoteResourceType = Optional.of(NORMALIZED_KINESIS_SERVICE_NAME + "::Stream");
+      remoteResourceIdentifier = Optional.ofNullable(span.getAttributes().get(AWS_STREAM_NAME));
+    } else if (isKeyPresent(span, AWS_BUCKET_NAME)) {
+      remoteResourceType = Optional.of(NORMALIZED_S3_SERVICE_NAME + "::Bucket");
+      remoteResourceIdentifier = Optional.ofNullable(span.getAttributes().get(AWS_BUCKET_NAME));
+    } else if (isKeyPresent(span, AWS_QUEUE_NAME)) {
+      remoteResourceType = Optional.of(NORMALIZED_SQS_SERVICE_NAME + "::Queue");
+      remoteResourceIdentifier = Optional.ofNullable(span.getAttributes().get(AWS_QUEUE_NAME));
+    } else if (isKeyPresent(span, AWS_QUEUE_URL)) {
+      remoteResourceType = Optional.of(NORMALIZED_SQS_SERVICE_NAME + "::Queue");
+      remoteResourceIdentifier = SqsUrlParser.getQueueName(span.getAttributes().get(AWS_QUEUE_URL));
+    }
+
+    if (remoteResourceType.isPresent() && remoteResourceIdentifier.isPresent()) {
+      builder.put(AWS_REMOTE_RESOURCE_TYPE, remoteResourceType.get());
+      builder.put(AWS_REMOTE_RESOURCE_IDENTIFIER, remoteResourceIdentifier.get());
+    }
+  }
+
   /** Span kind is needed for differentiating metrics in the EMF exporter */
   private static void setSpanKindForService(SpanData span, AttributesBuilder builder) {
     String spanKind = span.getKind().name();