reorder to baggage,xray,tracecontext

Author: jj22ee

aws-distro-opentelemetry-node-autoinstrumentation/README.md

@@ -30,6 +30,6 @@ export OTEL_TRACES_SAMPLER_ARG=endpoint=http://localhost:2000,polling_interval=3
 | Environment Variable | Description | Example |
 | -------------------- | ----------- | ------- |
 | `OTEL_EXPORTER_OTLP_PROTOCOL` | Leave unset so that ADOT JS will use a recommended OTLP protocol | `http/protobuf` |
-| `OTEL_PROPAGATORS` | Leave unset so that ADOT JS will use a recommended list of propagators | `tracecontext,baggage,xray` |
+| `OTEL_PROPAGATORS` | Leave unset so that ADOT JS will use a recommended list of propagators | `baggage,xray,tracecontext` |
 | `OTEL_NODE_DISABLED_INSTRUMENTATIONS` | Leave unset so that ADOT JS will disable a recommended list of instrumentations | `fs,dns` |
 | `OTEL_NODE_RESOURCE_DETECTORS` | Leave unset so that ADOT JS will use a recommended list of Resource Detectors. If set, `env` should be at the end of the list | `aws,env` |

aws-distro-opentelemetry-node-autoinstrumentation/src/register.ts

@@ -44,7 +44,7 @@ export function setAwsDefaultEnvironmentVariables() {
   if (!process.env.OTEL_PROPAGATORS) {
     // Propagators are run in the order they are configured.
     // xray is set after baggage in case xray propagator depends on the result of the baggage header extraction.
-    process.env.OTEL_PROPAGATORS = 'tracecontext,baggage,xray';
+    process.env.OTEL_PROPAGATORS = 'baggage,xray,tracecontext';
   }
   if (!process.env.OTEL_NODE_DISABLED_INSTRUMENTATIONS) {
     if (isAgentObservabilityEnabled()) {

aws-distro-opentelemetry-node-autoinstrumentation/test/aws-opentelemetry-configurator.test.ts

@@ -63,6 +63,7 @@ import {
 import { OTLPAwsLogExporter } from '../src/exporter/otlp/aws/logs/otlp-aws-log-exporter';
 import { OTLPAwsSpanExporter } from '../src/exporter/otlp/aws/traces/otlp-aws-span-exporter';
 import { AwsCloudWatchOtlpBatchLogRecordProcessor } from '../src/exporter/otlp/aws/logs/aws-cw-otlp-batch-log-record-processor';
+import { TRACE_PARENT_HEADER } from '@opentelemetry/core';
 
 // Tests AwsOpenTelemetryConfigurator after running Environment Variable setup in register.ts
 describe('AwsOpenTelemetryConfiguratorTest', () => {
@@ -178,6 +179,51 @@ describe('AwsOpenTelemetryConfiguratorTest', () => {
       expect(spanContext.traceFlags).toEqual(1);
     });
 
+    it('Default Propagator extraction of Trace Context prioritizes W3C Trace Header over X-Ray Trace Header for span context if they mismatch', () => {
+      const carrier: Record<string, string> = {
+        'X-Amzn-Trace-Id':
+          'Root=1-5759e988-bd862e3fe1bf46a994270000;Parent=53945c3f42cd0000;Sampled=0;Lineage=a87bd80c:1|68fd508a:5|c512fbe3:2',
+        [TRACE_PARENT_HEADER]: '00-11111111222222223333333344444444-5555555566666666-01',
+      };
+      const textMapGetter: TextMapGetter = {
+        keys: (carrier: Record<string, string>): string[] => {
+          return Object.keys(carrier);
+        },
+        get: (carrier: Record<string, string>, key: string) => {
+          return carrier?.[key];
+        },
+      };
+
+      // Create configurator with default settings and AgentObservability enabled for this test case
+      setAwsDefaultEnvironmentVariables();
+      const customAwsOtelConfigurator = new AwsOpentelemetryConfigurator([]);
+      const customAwsOtelConfiguration = customAwsOtelConfigurator.configure();
+
+      const tracerProvider: NodeTracerProvider = new NodeTracerProvider(customAwsOtelConfiguration);
+      const tracer: Tracer = tracerProvider.getTracer('test');
+
+      const contextAfterExtraction = customAwsOtelConfiguration.textMapPropagator?.extract(
+        ROOT_CONTEXT,
+        carrier,
+        textMapGetter
+      );
+
+      // Test Trace Context extraction directly
+      const spanContextAfterExtraction = trace.getSpanContext(contextAfterExtraction!);
+      expect(spanContextAfterExtraction?.traceId).toEqual('11111111222222223333333344444444');
+      expect(spanContextAfterExtraction?.spanId).toEqual('5555555566666666');
+      expect(spanContextAfterExtraction?.traceFlags).toEqual(1);
+
+      // Test Trace Context extraction indirectly through span creation
+      const span: Span = tracer.startSpan('test', undefined, contextAfterExtraction);
+      span.end();
+      const spanContext = span.spanContext();
+
+      expect(spanContext.traceId).toEqual('11111111222222223333333344444444');
+      expect((span as any).parentSpanId).toEqual('5555555566666666');
+      expect(spanContext.traceFlags).toEqual(1);
+    });
+
     it('Propagator extracts session.id baggage header attribute into to span attributes when Agent Observability is enabled', () => {
       // Create configurator with default settings and AgentObservability enabled for this test case
       setAwsDefaultEnvironmentVariables();
@@ -712,7 +758,7 @@ describe('AwsOpenTelemetryConfiguratorTest', () => {
   function validateConfiguratorEnviron() {
     // Set by register.ts
     expect(process.env).toHaveProperty('OTEL_EXPORTER_OTLP_PROTOCOL', 'http/protobuf');
-    expect(process.env).toHaveProperty('OTEL_PROPAGATORS', 'tracecontext,baggage,xray');
+    expect(process.env).toHaveProperty('OTEL_PROPAGATORS', 'baggage,xray,tracecontext');
 
     // Not set
     expect(process.env).not.toHaveProperty('OTEL_TRACES_SAMPLER');

aws-distro-opentelemetry-node-autoinstrumentation/test/register.test.ts

@@ -46,7 +46,7 @@ describe('Register', function () {
     it('sets AWS Default Environment Variables', () => {
       setAwsDefaultEnvironmentVariables();
       expect(process.env.OTEL_EXPORTER_OTLP_PROTOCOL).toEqual('http/protobuf');
-      expect(process.env.OTEL_PROPAGATORS).toEqual('tracecontext,baggage,xray');
+      expect(process.env.OTEL_PROPAGATORS).toEqual('baggage,xray,tracecontext');
       expect(process.env.OTEL_NODE_DISABLED_INSTRUMENTATIONS).toEqual('fs,dns');
     });
 
@@ -167,7 +167,7 @@ describe('Register', function () {
 
     assert.ok(proc.stdout.includes('AWS Distro of OpenTelemetry automatic instrumentation started successfully'));
     assert.ok(proc.stdout.includes("Environment variable OTEL_EXPORTER_OTLP_PROTOCOL is set to 'http/protobuf'"));
-    assert.ok(proc.stdout.includes("Environment variable OTEL_PROPAGATORS is set to 'tracecontext,baggage,xray'"));
+    assert.ok(proc.stdout.includes("Environment variable OTEL_PROPAGATORS is set to 'baggage,xray,tracecontext'"));
 
     // Check a span has been generated for the GET request done in app.js
     assert.ok(proc.stdout.includes("name: 'GET'"), 'console span output in stdout - validate Span Name');