more unit testing

Author: liustve

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

@@ -77,6 +77,9 @@ import { OTLPAwsLogExporter } from './exporter/otlp/aws/logs/otlp-aws-log-export
 const AWS_TRACES_OTLP_ENDPOINT_PATTERN = '^https://xray\\.([a-z0-9-]+)\\.amazonaws\\.com/v1/traces$';
 const AWS_LOGS_OTLP_ENDPOINT_PATTERN = '^https://logs\\.([a-z0-9-]+)\\.amazonaws\\.com/v1/logs$';
 
+const AWS_OTLP_LOGS_GROUP_HEADER = 'x-aws-log-group';
+const AWS_OTLP_LOGS_STREAM_HEADER = 'x-aws-log-stream';
+
 const APPLICATION_SIGNALS_ENABLED_CONFIG: string = 'OTEL_AWS_APPLICATION_SIGNALS_ENABLED';
 const APPLICATION_SIGNALS_EXPORTER_ENDPOINT_CONFIG: string = 'OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT';
 const METRIC_EXPORT_INTERVAL_CONFIG: string = 'OTEL_METRIC_EXPORT_INTERVAL';
@@ -462,7 +465,11 @@ export class AwsLoggerProcessorProvider {
             exporters.push(new OTLPHttpLogExporter());
             break;
           case 'http/protobuf':
-            if (otlpExporterLogsEndpoint && isAwsOtlpEndpoint(otlpExporterLogsEndpoint, 'logs')) {
+            if (
+              otlpExporterLogsEndpoint &&
+              isAwsOtlpEndpoint(otlpExporterLogsEndpoint, 'logs') &&
+              validateLogsHeaders()
+            ) {
               diag.debug('Detected CloudWatch Logs OTLP endpoint. Switching exporter to OTLPAwsLogExporter');
               exporters.push(new OTLPAwsLogExporter(otlpExporterLogsEndpoint));
             } else {
@@ -475,7 +482,11 @@ export class AwsLoggerProcessorProvider {
             break;
           default:
             diag.warn(`Unsupported OTLP logs protocol: "${protocol}". Using http/protobuf.`);
-            if (otlpExporterLogsEndpoint && isAwsOtlpEndpoint(otlpExporterLogsEndpoint, 'logs')) {
+            if (
+              otlpExporterLogsEndpoint &&
+              isAwsOtlpEndpoint(otlpExporterLogsEndpoint, 'logs') &&
+              validateLogsHeaders()
+            ) {
               diag.debug('Detected CloudWatch Logs OTLP endpoint. Switching exporter to OTLPAwsLogExporter');
               exporters.push(new OTLPAwsLogExporter(otlpExporterLogsEndpoint));
             } else {
@@ -817,10 +828,51 @@ function getXrayDaemonEndpoint() {
   return process.env[AWS_XRAY_DAEMON_ADDRESS_CONFIG];
 }
 
+/**
+ * Determines if the given endpoint is either the AWS OTLP Traces or Logs endpoint.
+ */
+
 function isAwsOtlpEndpoint(otlpEndpoint: string, service: string): boolean {
   const pattern = service === 'xray' ? AWS_TRACES_OTLP_ENDPOINT_PATTERN : AWS_LOGS_OTLP_ENDPOINT_PATTERN;
 
   return new RegExp(pattern).test(otlpEndpoint.toLowerCase());
 }
 
+/**
+ * Checks if x-aws-log-group and x-aws-log-stream are present in the headers in order to send logs to
+ * AWS OTLP Logs endpoint.
+ */
+function validateLogsHeaders() {
+  const logsHeaders = process.env['OTEL_EXPORTER_OTLP_LOGS_HEADERS'];
+
+  if (!logsHeaders) {
+    diag.warn(
+      'Improper configuration: Please configure the environment variable OTEL_EXPORTER_OTLP_LOGS_HEADERS ' +
+        'to include x-aws-log-group and x-aws-log-stream'
+    );
+    return false;
+  }
+
+  let filteredLogHeadersCount = 0;
+
+  for (const pair of logsHeaders.split(',')) {
+    if (pair.includes('=')) {
+      const [key, value] = pair.split('=', 2);
+      if ((key === AWS_OTLP_LOGS_GROUP_HEADER || key === AWS_OTLP_LOGS_STREAM_HEADER) && value) {
+        filteredLogHeadersCount += 1;
+      }
+    }
+  }
+
+  if (filteredLogHeadersCount !== 2) {
+    diag.warn(
+      'Improper configuration: Please configure the environment variable OTEL_EXPORTER_OTLP_LOGS_HEADERS ' +
+        'to have values for x-aws-log-group and x-aws-log-stream'
+    );
+    return false;
+  }
+
+  return true;
+}
+
 // END The OpenTelemetry Authors code

aws-distro-opentelemetry-node-autoinstrumentation/src/exporter/otlp/aws/common/aws-authenticator.ts

@@ -77,7 +77,7 @@ export class AwsAuthenticator {
     return headers;
   }
 
-  // Cleans up Sigv4 headers from headers to avoid accidentally copying them to the new headers
+  // Cleans up Sigv4 from headers to avoid accidentally copying them to the new headers
   private removeSigV4Headers(headers: Record<string, string>) {
     const newHeaders: Record<string, string> = {};
     const sigV4Headers = ['x-amz-date', 'authorization', 'x-amz-content-sha256', 'x-amz-security-token'];

aws-distro-opentelemetry-node-autoinstrumentation/src/exporter/otlp/aws/common/utils.ts

@@ -1,5 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+
 import { OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
 
 export function changeUrlConfig(endpoint: string, config?: OTLPExporterNodeConfigBase): OTLPExporterNodeConfigBase {

aws-distro-opentelemetry-node-autoinstrumentation/test/exporter/otlp/aws/common/aws-authenticator.test.ts

@@ -6,18 +6,17 @@ import * as proxyquire from 'proxyquire';
 import * as sinon from 'sinon';
 import expect from 'expect';
 import { AwsAuthenticator } from '../../../../../src/exporter/otlp/aws/common/aws-authenticator';
-
-const PATH = '../../../../../src/exporter/otlp/aws/common/aws-authenticator';
-const SIGNATURE_V4_MODULE = '@smithy/signature-v4';
-const CREDENTIAL_PROVIDER_MODULE = '@aws-sdk/credential-provider-node';
-const SHA_256_MODULE = '@aws-crypto/sha256-js';
-const AWS_HTTP_MODULE = '@smithy/protocol-http';
-
-const AWS_OTLP_TRACES_ENDPOINT = 'https://xray.us-east-1.amazonaws.com/v1/traces';
-
-const AUTHORIZATION_HEADER = 'authorization';
-const X_AMZ_DATE_HEADER = 'x-amz-date';
-const X_AMZ_SECURITY_TOKEN_HEADER = 'x-amz-security-token';
+import {
+  AUTHORIZATION_HEADER,
+  AWS_AUTH_PATH,
+  AWS_HTTP_MODULE,
+  AWS_OTLP_TRACES_ENDPOINT,
+  CREDENTIAL_PROVIDER_MODULE,
+  SHA_256_MODULE,
+  SIGNATURE_V4_MODULE,
+  X_AMZ_DATE_HEADER,
+  X_AMZ_SECURITY_TOKEN_HEADER,
+} from './test-utils.test';
 
 const mockCredentials = {
   accessKeyId: 'test_access_key',
@@ -49,7 +48,7 @@ describe('AwsAuthenticator', () => {
         requireStub.withArgs(dependency).throws(new Error(`Cannot find module '${dependency}'`));
         requireStub.callThrough();
 
-        const { AwsAuthenticator: MockThrowableModuleAuthenticator } = require(PATH);
+        const { AwsAuthenticator: MockThrowableModuleAuthenticator } = require(AWS_AUTH_PATH);
 
         const result = await new MockThrowableModuleAuthenticator('us-east-1', 'xray').authenticate(
           AWS_OTLP_TRACES_ENDPOINT,
@@ -80,7 +79,7 @@ describe('AwsAuthenticator', () => {
       [X_AMZ_SECURITY_TOKEN_HEADER]: 'testSecurityToken',
     };
 
-    const AwsAuthenticatorWithMock = proxyquire(PATH, {
+    const AwsAuthenticatorWithMock = proxyquire(AWS_AUTH_PATH, {
       [CREDENTIAL_PROVIDER_MODULE]: {
         defaultProvider: () => Promise.resolve(mockCredentials),
       },
@@ -124,7 +123,7 @@ describe('AwsAuthenticator', () => {
       [X_AMZ_SECURITY_TOKEN_HEADER]: 'testSecurityToken',
     };
 
-    const AwsAuthenticatorWithMock = proxyquire(PATH, {
+    const AwsAuthenticatorWithMock = proxyquire(AWS_AUTH_PATH, {
       [CREDENTIAL_PROVIDER_MODULE]: {
         defaultProvider: () => Promise.resolve(mockCredentials),
       },

aws-distro-opentelemetry-node-autoinstrumentation/test/exporter/otlp/aws/logs/otlp-aws-log-exporter.test.ts

@@ -14,7 +14,7 @@ import * as sinon from 'sinon';
 import * as proxyquire from 'proxyquire';
 import * as nock from 'nock';
 
-const EXPECTED_AUTH_HEADER = 'AWS4-HMAC-SHA256 Credential=test_key/some_date/us-east-1/xray/aws4_request';
+const EXPECTED_AUTH_HEADER = 'AWS4-HMAC-SHA256 Credential=test_key/some_date/us-east-1/logs/aws4_request';
 const EXPECTED_AUTH_X_AMZ_DATE = 'some_date';
 const EXPECTED_AUTH_SECURITY_TOKEN = 'test_token';