Revert "Revert "added README.md for SigV4 Exporter""

This reverts commit d5f8ede.

Author: liustve

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

@@ -52,6 +52,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
+import software.amazon.opentelemetry.javaagent.providers.exporter.OtlpAwsSpanExporterBuilder;
 
 /**
  * This customizer performs the following customizations:
@@ -194,16 +195,18 @@ private boolean isApplicationSignalsRuntimeEnabled(ConfigProperties configProps)
   }
 
   private Map<String, String> customizeProperties(ConfigProperties configProps) {
-    boolean isLambdaEnvironment = isLambdaEnvironment();
     Map<String, String> propsOverride = new HashMap<>();
+    boolean isLambdaEnvironment = isLambdaEnvironment();
 
     // Enable AWS Resource Providers
     propsOverride.put(OTEL_RESOURCE_PROVIDERS_AWS_ENABLED, "true");
+
     if (!isLambdaEnvironment) {
-      this.disableAwsResourceProvider(
-          propsOverride,
-          configProps,
-          List.of("io.opentelemetry.contrib.aws.resource.LambdaResourceProvider"));
+      propsOverride.put(
+          OTEL_DISABLED_RESOURCE_PROVIDERS_CONFIG,
+          this.disableResourceProvider(
+              configProps,
+              List.of("io.opentelemetry.contrib.aws.resource.LambdaResourceProvider")));
     }
 
     if (isApplicationSignalsEnabled(configProps)) {
@@ -261,7 +264,9 @@ private Map<String, String> customizeLambdaEnvProperties(ConfigProperties config
               "io.opentelemetry.contrib.aws.resource.EcsResourceProvider",
               "io.opentelemetry.contrib.aws.resource.EksResourceProvider");
 
-      this.disableAwsResourceProvider(propsOverride, configProperties, disabledResourceProviders);
+      propsOverride.put(
+          OTEL_DISABLED_RESOURCE_PROVIDERS_CONFIG,
+          this.disableResourceProvider(configProperties, disabledResourceProviders));
 
       // Set the max export batch size for BatchSpanProcessors
       propsOverride.put(
@@ -272,14 +277,12 @@ private Map<String, String> customizeLambdaEnvProperties(ConfigProperties config
     return Collections.emptyMap();
   }
 
-  private void disableAwsResourceProvider(
-      Map<String, String> newProps, ConfigProperties oldProps, List<String> resourceProviders) {
-
+  private String disableResourceProvider(
+      ConfigProperties oldProps, List<String> resourceProviders) {
     List<String> list = oldProps.getList(OTEL_DISABLED_RESOURCE_PROVIDERS_CONFIG);
-    List<String> disabledResourceProviders = new ArrayList<>(list);
+    Set<String> disabledResourceProviders = new HashSet<>(list);
     disabledResourceProviders.addAll(resourceProviders);
-    newProps.put(
-        OTEL_DISABLED_RESOURCE_PROVIDERS_CONFIG, String.join(",", disabledResourceProviders));
+    return String.join(",", disabledResourceProviders);
   }
 
   private Resource customizeResource(Resource resource, ConfigProperties configProps) {

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/OtlpAwsSpanExporter.java renamed to awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/OtlpAwsSpanExporter.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.opentelemetry.javaagent.providers;
+package software.amazon.opentelemetry.javaagent.providers.exporter;
 
 import io.opentelemetry.exporter.internal.otlp.traces.TraceRequestMarshaler;
 import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter;

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/OtlpAwsSpanExporterBuilder.java renamed to awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/OtlpAwsSpanExporterBuilder.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.opentelemetry.javaagent.providers;
+package software.amazon.opentelemetry.javaagent.providers.exporter;
 
 import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter;
 

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/README.md

@@ -0,0 +1,26 @@
+# ADOT X-Ray OTLP Trace Export Configuration
+
+This guide explains how to automatically configure ADOT environment variables for exporting traces to [AWS X-Ray OTLP endpoint](https://docs.aws.amazon.com/xray/latest/devguide/xray-opentelemetry.html)
+
+## Pre-requisites:
+1. Transaction Search must be enabled in order to send spans to the Xray OTLP endpoint. See [this doc](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search-getting-started.html) on how to enable Transaction Search.
+
+2. Ensure the AWS IAM role used for credentials in your application environment has [AWSXRayWriteOnlyAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSXrayWriteOnlyAccess.html) managed policy attached to it.
+
+## Environment Variables
+
+Set the following environment variables to **PROPERLY** configure trace export with SigV4 authentication:
+
+```shell
+# Set X-Ray endpoint (replace AWS_REGION with your region)
+OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://xray.<AWS_REGION>.amazonaws.com/v1/traces
+
+# Configure OTLP export protocol
+OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
+
+OTEL_METRICS_EXPORTER=none
+OTEL_LOGS_EXPORTER=none
+OTEL_RESOURCE_ATTRIBUTES="service.name=<YOUR_SERVICE_NAME>"
+
+# Disable application signals (they will be generated in CloudWatch backend)
+OTEL_AWS_APPLICATION_SIGNALS_ENABLED=false

awsagentprovider/src/test/java/software/amazon/opentelemetry/javaagent/providers/OtlpAwsSpanExporterTest.java

@@ -46,6 +46,7 @@
 import software.amazon.awssdk.http.auth.spi.signer.SignRequest.Builder;
 import software.amazon.awssdk.http.auth.spi.signer.SignedRequest;
 import software.amazon.awssdk.identity.spi.AwsCredentialsIdentity;
+import software.amazon.opentelemetry.javaagent.providers.exporter.OtlpAwsSpanExporterBuilder;
 
 @ExtendWith(MockitoExtension.class)
 public class OtlpAwsSpanExporterTest {