feat: Add Application Signals Dimensions to EMF exporter (#1264)

*Description of changes:*

- Added support for Application Signals dimensions (Service and
Environment) in EMF exporters via the
`OTEL_METRICS_ADD_APPLICATION_SIGNALS_DIMENSIONS` environment variable.
When enabled, the exporters automatically add Service and Environment
dimensions. Defaults to `UnknownService` and `generic:default`
respectively based on resource attributes and cloud platform.

- Application Signals dimensions are enabled by default when
`OTEL_METRICS_EXPORTER` is set to `awsemf`. Users can opt out or disable
this feature by explicitly setting
`OTEL_METRICS_ADD_APPLICATION_SIGNALS_DIMENSIONS` to `false`.

- chore: add Builder class for `AwsEmf` and `Console` exporters

<img width="966" height="499" alt="image"
src="https://github.com/user-attachments/assets/20174c2d-9dfa-438b-af8e-afc64e8f649d"
/>


By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.

Author: liustve

CHANGELOG.md

@@ -15,6 +15,8 @@ If your change does not need a CHANGELOG entry, add the "skip changelog" label t
 
 ### Enhancements
 
+- Add Application Signals Dimensions to EMF exporter
+  ([#1264](https://github.com/aws-observability/aws-otel-java-instrumentation/pull/1264))
 - Configure EMF and CompactLog Exporters for Lambda Environment
   ([#1222](https://github.com/aws-observability/aws-otel-java-instrumentation/pull/1222))
 - feat: [Java] EMF Exporter Implementation

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

@@ -118,6 +118,8 @@ public final class AwsApplicationSignalsCustomizerProvider
   private static final String DEPRECATED_APP_SIGNALS_ENABLED_CONFIG =
       "otel.aws.app.signals.enabled";
   static final String APPLICATION_SIGNALS_ENABLED_CONFIG = "otel.aws.application.signals.enabled";
+  static final String OTEL_METRICS_ADD_APPLICATION_SIGNALS_DIMENSIONS =
+      "otel.metrics.add.application.signals.dimensions";
 
   private static final String OTEL_RESOURCE_PROVIDERS_AWS_ENABLED =
       "otel.resource.providers.aws.enabled";
@@ -185,8 +187,8 @@ public void customize(AutoConfigurationCustomizer autoConfiguration) {
     autoConfiguration.addMetricExporterCustomizer(this::customizeMetricExporter);
   }
 
-  static boolean isLambdaEnvironment(ConfigProperties props) {
-    return props.getString(AWS_LAMBDA_FUNCTION_NAME_PROP_CONFIG) != null;
+  static boolean shouldAddApplicationSignalsDimensionsEnabled(ConfigProperties props) {
+    return props.getBoolean(OTEL_METRICS_ADD_APPLICATION_SIGNALS_DIMENSIONS, true);
   }
 
   private static Optional<String> getAwsRegionFromConfig(ConfigProperties configProps) {
@@ -197,6 +199,10 @@ private static Optional<String> getAwsRegionFromConfig(ConfigProperties configPr
     return Optional.ofNullable(configProps.getString(AWS_DEFAULT_REGION));
   }
 
+  static boolean isLambdaEnvironment(ConfigProperties props) {
+    return props.getString(AWS_LAMBDA_FUNCTION_NAME_PROP_CONFIG) != null;
+  }
+
   static boolean isLambdaEnvironment() {
     return System.getenv(AWS_LAMBDA_FUNCTION_NAME_CONFIG) != null;
   }
@@ -551,6 +557,9 @@ MetricExporter customizeMetricExporter(
       MetricExporter metricExporter, ConfigProperties configProps) {
 
     if (isEmfExporterEnabled) {
+      boolean shouldAddApplicationSignalsDimensions =
+          AwsApplicationSignalsCustomizerProvider.shouldAddApplicationSignalsDimensionsEnabled(
+              configProps);
       Map<String, String> headers =
           AwsApplicationSignalsConfigUtils.parseOtlpHeaders(
               configProps.getString(OTEL_EXPORTER_OTLP_LOGS_HEADERS));
@@ -562,11 +571,20 @@ MetricExporter customizeMetricExporter(
             && headers.containsKey(AWS_OTLP_LOGS_STREAM_HEADER)) {
           String logGroup = headers.get(AWS_OTLP_LOGS_GROUP_HEADER);
           String logStream = headers.get(AWS_OTLP_LOGS_STREAM_HEADER);
-          return new AwsCloudWatchEmfExporter(namespace, logGroup, logStream, awsRegion.get());
+          return AwsCloudWatchEmfExporter.builder()
+              .setNamespace(namespace)
+              .setLogGroupName(logGroup)
+              .setLogStreamName(logStream)
+              .setAwsRegion(awsRegion.get())
+              .setShouldAddApplicationSignalsDimensions(shouldAddApplicationSignalsDimensions)
+              .build();
         }
 
         if (isLambdaEnvironment(configProps)) {
-          return new ConsoleEmfExporter(namespace);
+          return ConsoleEmfExporter.builder()
+              .setNamespace(namespace)
+              .setShouldAddApplicationSignalsDimensions(shouldAddApplicationSignalsDimensions)
+              .build();
         }
         logger.warning(
             String.format(

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/metrics/AwsCloudWatchEmfExporter.java

@@ -19,7 +19,6 @@
 import java.util.logging.Logger;
 import software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsClient;
 import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.BaseEmfExporter;
-import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.CloudWatchLogsClientEmitter;
 import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.LogEventEmitter;
 
 /**
@@ -34,27 +33,22 @@
 public class AwsCloudWatchEmfExporter extends BaseEmfExporter<CloudWatchLogsClient> {
   private static final Logger logger = Logger.getLogger(AwsCloudWatchEmfExporter.class.getName());
 
-  /**
-   * Initialize the CloudWatch EMF exporter.
-   *
-   * @param namespace CloudWatch namespace for metrics (default: "default")
-   * @param logGroupName CloudWatch log group name
-   * @param logStreamName CloudWatch log stream name (auto-generated if null)
-   * @param awsRegion AWS region
-   */
-  public AwsCloudWatchEmfExporter(
-      String namespace, String logGroupName, String logStreamName, String awsRegion) {
-    super(namespace, new CloudWatchLogsClientEmitter(logGroupName, logStreamName, awsRegion));
+  public static AwsCloudWatchEmfExporterBuilder builder() {
+    return new AwsCloudWatchEmfExporterBuilder();
   }
 
-  /**
-   * Initialize the CloudWatch EMF exporter with a custom emitter.
-   *
-   * @param namespace CloudWatch namespace for metrics
-   * @param emitter Custom log emitter
-   */
-  public AwsCloudWatchEmfExporter(String namespace, LogEventEmitter<CloudWatchLogsClient> emitter) {
-    super(namespace, emitter);
+  static AwsCloudWatchEmfExporter create(
+      String namespace,
+      LogEventEmitter<CloudWatchLogsClient> emitter,
+      boolean shouldAddApplicationSignalsDimensions) {
+    return new AwsCloudWatchEmfExporter(namespace, emitter, shouldAddApplicationSignalsDimensions);
+  }
+
+  private AwsCloudWatchEmfExporter(
+      String namespace,
+      LogEventEmitter<CloudWatchLogsClient> emitter,
+      boolean shouldAddApplicationSignalsDimensions) {
+    super(namespace, emitter, shouldAddApplicationSignalsDimensions);
   }
 
   @Override

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/metrics/AwsCloudWatchEmfExporterBuilder.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file 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 software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics;
+
+import static java.util.Objects.requireNonNull;
+
+import software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsClient;
+import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.CloudWatchLogsClientEmitter;
+import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.LogEventEmitter;
+
+public class AwsCloudWatchEmfExporterBuilder {
+  private String namespace;
+  private String logGroupName;
+  private String logStreamName;
+  private String awsRegion;
+  private LogEventEmitter<CloudWatchLogsClient> emitter;
+  private boolean shouldAddApplicationSignalsDimensions = false;
+
+  public AwsCloudWatchEmfExporterBuilder setNamespace(String namespace) {
+    this.namespace = namespace;
+    return this;
+  }
+
+  public AwsCloudWatchEmfExporterBuilder setLogGroupName(String logGroupName) {
+    this.logGroupName = logGroupName;
+    return this;
+  }
+
+  public AwsCloudWatchEmfExporterBuilder setLogStreamName(String logStreamName) {
+    this.logStreamName = logStreamName;
+    return this;
+  }
+
+  public AwsCloudWatchEmfExporterBuilder setAwsRegion(String awsRegion) {
+    this.awsRegion = awsRegion;
+    return this;
+  }
+
+  public AwsCloudWatchEmfExporterBuilder setEmitter(LogEventEmitter<CloudWatchLogsClient> emitter) {
+    this.emitter = emitter;
+    return this;
+  }
+
+  public AwsCloudWatchEmfExporterBuilder setShouldAddApplicationSignalsDimensions(
+      boolean shouldAddApplicationSignalsDimensions) {
+    this.shouldAddApplicationSignalsDimensions = shouldAddApplicationSignalsDimensions;
+    return this;
+  }
+
+  public AwsCloudWatchEmfExporter build() {
+
+    if (this.emitter == null) {
+      requireNonNull(logGroupName, "Must set logGroupName when emitter is not provided");
+      requireNonNull(logStreamName, "Must set logStreamName when emitter is not provided");
+      requireNonNull(awsRegion, "Must set awsRegion when emitter is not provided");
+      this.emitter = new CloudWatchLogsClientEmitter(logGroupName, logStreamName, awsRegion);
+    }
+    return AwsCloudWatchEmfExporter.create(
+        this.namespace, this.emitter, this.shouldAddApplicationSignalsDimensions);
+  }
+}

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/metrics/ConsoleEmfExporter.java

@@ -20,30 +20,28 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.BaseEmfExporter;
-import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.ConsoleEmitter;
 import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.LogEventEmitter;
 
 /** EMF metrics exporter for printing data to Standard Out. */
 public class ConsoleEmfExporter extends BaseEmfExporter<PrintStream> {
   private static final Logger logger = Logger.getLogger(ConsoleEmfExporter.class.getName());
 
-  /**
-   * Initialize the Console EMF exporter.
-   *
-   * @param namespace CloudWatch namespace for metrics (defaults to "default")
-   */
-  public ConsoleEmfExporter(String namespace) {
-    super(namespace, new ConsoleEmitter());
+  public static ConsoleEmfExporterBuilder builder() {
+    return new ConsoleEmfExporterBuilder();
   }
 
-  /**
-   * Initialize the Console EMF exporter with custom emitter.
-   *
-   * @param namespace CloudWatch namespace for metrics
-   * @param emitter Custom emitter
-   */
-  public ConsoleEmfExporter(String namespace, LogEventEmitter<PrintStream> emitter) {
-    super(namespace, emitter);
+  static ConsoleEmfExporter create(
+      String namespace,
+      LogEventEmitter<PrintStream> emitter,
+      boolean shouldAddApplicationSignalsDimensions) {
+    return new ConsoleEmfExporter(namespace, emitter, shouldAddApplicationSignalsDimensions);
+  }
+
+  private ConsoleEmfExporter(
+      String namespace,
+      LogEventEmitter<PrintStream> emitter,
+      boolean shouldAddApplicationSignalsDimensions) {
+    super(namespace, emitter, shouldAddApplicationSignalsDimensions);
   }
 
   @Override

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/metrics/ConsoleEmfExporterBuilder.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file 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 software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics;
+
+import java.io.PrintStream;
+import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.ConsoleEmitter;
+import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.common.emitter.LogEventEmitter;
+
+public class ConsoleEmfExporterBuilder {
+  private String namespace;
+  private LogEventEmitter<PrintStream> emitter;
+  private boolean shouldAddApplicationSignalsDimensions = false;
+
+  public ConsoleEmfExporterBuilder setNamespace(String namespace) {
+    this.namespace = namespace;
+    return this;
+  }
+
+  public ConsoleEmfExporterBuilder setEmitter(LogEventEmitter<PrintStream> emitter) {
+    this.emitter = emitter;
+    return this;
+  }
+
+  public ConsoleEmfExporterBuilder setShouldAddApplicationSignalsDimensions(
+      boolean shouldAddApplicationSignalsDimensions) {
+    this.shouldAddApplicationSignalsDimensions = shouldAddApplicationSignalsDimensions;
+    return this;
+  }
+
+  public ConsoleEmfExporter build() {
+    if (this.emitter == null) {
+      this.emitter = new ConsoleEmitter();
+    }
+    return ConsoleEmfExporter.create(
+        this.namespace, this.emitter, this.shouldAddApplicationSignalsDimensions);
+  }
+}

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/metrics/common/BaseEmfExporter.java

@@ -47,17 +47,26 @@
 public abstract class BaseEmfExporter<T> implements MetricExporter {
   private static final Logger logger = Logger.getLogger(BaseEmfExporter.class.getName());
   private final String namespace;
+  private final boolean shouldAddApplicationSignalsDimensions;
   protected final LogEventEmitter<T> emitter;
 
   /**
-   * Creates a new EMF exporter with the specified namespace and log emitter.
+   * Creates a new EMF exporter with the specified namespace, log emitter, and Application Signals
+   * flag.
    *
    * @param namespace the CloudWatch metric namespace, defaults to "default" if null
    * @param emitter the log event emitter for sending EMF logs
+   * @param shouldAddApplicationSignalsDimensions whether Application Signals dimensions should be
+   *     added
    */
-  protected BaseEmfExporter(String namespace, LogEventEmitter<T> emitter) {
-    this.namespace = namespace != null ? namespace : "default";
+  protected BaseEmfExporter(
+      String namespace, LogEventEmitter<T> emitter, boolean shouldAddApplicationSignalsDimensions) {
+    if (emitter == null) {
+      throw new IllegalArgumentException("Given emitter must not be null");
+    }
+    this.namespace = namespace == null || namespace.isEmpty() ? "default" : namespace;
     this.emitter = emitter;
+    this.shouldAddApplicationSignalsDimensions = shouldAddApplicationSignalsDimensions;
   }
 
   @Override
@@ -117,7 +126,8 @@ record =
                   records,
                   firstRecord.getResourceAttributes(),
                   this.namespace,
-                  firstRecord.getTimestamp());
+                  firstRecord.getTimestamp(),
+                  this.shouldAddApplicationSignalsDimensions);
 
           Map<String, Object> logEvent = new HashMap<>();
           logEvent.put("message", new ObjectMapper().writeValueAsString(emfLog));