Add Compact Console Log Record Exporter for Lambda Environment (#236)

*Issue #, if available:*

*Description of changes:*


By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

Author: jj22ee

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

@@ -54,7 +54,6 @@ import {
   SpanProcessor,
   TraceIdRatioBasedSampler,
 } from '@opentelemetry/sdk-trace-base';
-
 import {
   BatchLogRecordProcessor,
   ConsoleLogRecordExporter,
@@ -82,6 +81,7 @@ import { AWS_ATTRIBUTE_KEYS } from './aws-attribute-keys';
 import { AwsCloudWatchOtlpBatchLogRecordProcessor } from './exporter/otlp/aws/logs/aws-cw-otlp-batch-log-record-processor';
 import { ConsoleEMFExporter } from './exporter/aws/metrics/console-emf-exporter';
 import { EMFExporterBase } from './exporter/aws/metrics/emf-exporter-base';
+import { CompactConsoleLogRecordExporter } from './exporter/console/logs/compact-console-log-exporter';
 
 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$';
@@ -613,7 +613,16 @@ export class AwsLoggerProcessorProvider {
           }
         }
       } else if (exporter === 'console') {
-        exporters.push(new ConsoleLogRecordExporter());
+        let logExporter: LogRecordExporter | undefined = undefined;
+        if (isLambdaEnvironment()) {
+          diag.debug(
+            'Lambda environment detected, using CompactConsoleLogRecordExporter instead of ConsoleLogRecordExporter'
+          );
+          logExporter = new CompactConsoleLogRecordExporter();
+        } else {
+          logExporter = new ConsoleLogRecordExporter();
+        }
+        exporters.push(logExporter);
       } else {
         diag.warn(`Unsupported OTEL_LOGS_EXPORTER value: "${exporter}". Supported values are: otlp, console, none.`);
       }

aws-distro-opentelemetry-node-autoinstrumentation/src/exporter/console/logs/compact-console-log-exporter.ts

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { ExportResult, ExportResultCode } from '@opentelemetry/core';
+import { ConsoleLogRecordExporter, ReadableLogRecord } from '@opentelemetry/sdk-logs';
+
+export class CompactConsoleLogRecordExporter extends ConsoleLogRecordExporter {
+  override export(logs: ReadableLogRecord[], resultCallback: (result: ExportResult) => void): void {
+    this._sendLogRecordsToLambdaConsole(logs, resultCallback);
+  }
+
+  private _sendLogRecordsToLambdaConsole(logRecords: ReadableLogRecord[], done?: (result: ExportResult) => void): void {
+    for (const logRecord of logRecords) {
+      process.stdout.write(JSON.stringify(this['_exportInfo'](logRecord)) + '\n');
+    }
+    done?.({ code: ExportResultCode.SUCCESS });
+  }
+}

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

@@ -0,0 +1,151 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { expect } from 'expect';
+import * as sinon from 'sinon';
+import { ExportResultCode } from '@opentelemetry/core';
+import { ReadableLogRecord } from '@opentelemetry/sdk-logs';
+import { Resource } from '@opentelemetry/resources';
+import { CompactConsoleLogRecordExporter } from '../../../../src/exporter/console/logs/compact-console-log-exporter';
+import { Attributes } from '@opentelemetry/api';
+
+describe('CompactConsoleLogRecordExporter', () => {
+  let exporter: CompactConsoleLogRecordExporter;
+  let stdoutWriteSpy: sinon.SinonSpy;
+
+  const createMockLogRecord = (body: string, attributes: Attributes = {}): ReadableLogRecord => ({
+    hrTime: [1640995200, 0],
+    hrTimeObserved: [1640995200, 0],
+    body,
+    severityText: 'INFO',
+    attributes,
+    resource: Resource.empty(),
+    instrumentationScope: { name: 'test', version: '1.0.0' },
+    droppedAttributesCount: 0,
+  });
+
+  beforeEach(() => {
+    exporter = new CompactConsoleLogRecordExporter();
+    stdoutWriteSpy = sinon.spy(process.stdout, 'write');
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('should export logs and call callback with success', done => {
+    const mockLogRecord = createMockLogRecord('test log message');
+    const logs = [mockLogRecord];
+
+    exporter.export(logs, result => {
+      expect(result.code).toBe(ExportResultCode.SUCCESS);
+      expect(stdoutWriteSpy.calledOnce).toBeTruthy();
+
+      const writtenData = stdoutWriteSpy.firstCall.args[0];
+      expect(writtenData).toBe(
+        '{"resource":{"attributes":{}},"instrumentationScope":{"name":"test","version":"1.0.0"},"timestamp":1640995200000000,"severityText":"INFO","body":"test log message","attributes":{}}\n'
+      );
+
+      const loggedContent = JSON.parse(writtenData);
+      expect(loggedContent.body).toBe('test log message');
+      expect(loggedContent.severityText).toBe('INFO');
+      expect(loggedContent.instrumentationScope.name).toBe('test');
+      expect(loggedContent.instrumentationScope.version).toBe('1.0.0');
+
+      done();
+    });
+  });
+
+  it('should export multiple logs', done => {
+    const mockLogRecords = [createMockLogRecord('log 1'), createMockLogRecord('log 2')];
+
+    exporter.export(mockLogRecords, result => {
+      expect(result.code).toBe(ExportResultCode.SUCCESS);
+      expect(stdoutWriteSpy.callCount).toBe(2);
+
+      const firstWrittenData = stdoutWriteSpy.firstCall.args[0];
+      const secondWrittenData = stdoutWriteSpy.secondCall.args[0];
+      expect(firstWrittenData).toBe(
+        '{"resource":{"attributes":{}},"instrumentationScope":{"name":"test","version":"1.0.0"},"timestamp":1640995200000000,"severityText":"INFO","body":"log 1","attributes":{}}\n'
+      );
+      expect(secondWrittenData).toBe(
+        '{"resource":{"attributes":{}},"instrumentationScope":{"name":"test","version":"1.0.0"},"timestamp":1640995200000000,"severityText":"INFO","body":"log 2","attributes":{}}\n'
+      );
+
+      const firstLogContent = JSON.parse(firstWrittenData);
+      const secondLogContent = JSON.parse(secondWrittenData);
+
+      expect(firstLogContent.body).toBe('log 1');
+      expect(secondLogContent.body).toBe('log 2');
+
+      done();
+    });
+  });
+
+  it('should handle empty logs array', done => {
+    exporter.export([], result => {
+      expect(result.code).toBe(ExportResultCode.SUCCESS);
+      expect(stdoutWriteSpy.called).toBeFalsy();
+      done();
+    });
+  });
+
+  it('should work without callback', () => {
+    const mockLogRecord = createMockLogRecord('test log message');
+
+    expect(() => {
+      exporter.export([mockLogRecord], () => {});
+    }).not.toThrow();
+    expect(stdoutWriteSpy.calledOnce).toBeTruthy();
+
+    const writtenData = stdoutWriteSpy.firstCall.args[0];
+    expect(writtenData).toBe(
+      '{"resource":{"attributes":{}},"instrumentationScope":{"name":"test","version":"1.0.0"},"timestamp":1640995200000000,"severityText":"INFO","body":"test log message","attributes":{}}\n'
+    );
+
+    const loggedContent = JSON.parse(writtenData);
+    expect(loggedContent.body).toBe('test log message');
+  });
+
+  it('should handle undefined callback gracefully', () => {
+    const mockLogRecord = createMockLogRecord('test log message');
+
+    expect(() => {
+      exporter['_sendLogRecordsToLambdaConsole']([mockLogRecord]);
+    }).not.toThrow();
+    expect(stdoutWriteSpy.calledOnce).toBeTruthy();
+
+    const writtenData = stdoutWriteSpy.firstCall.args[0];
+    expect(writtenData).toBe(
+      '{"resource":{"attributes":{}},"instrumentationScope":{"name":"test","version":"1.0.0"},"timestamp":1640995200000000,"severityText":"INFO","body":"test log message","attributes":{}}\n'
+    );
+
+    const loggedContent = JSON.parse(writtenData);
+    expect(loggedContent.body).toBe('test log message');
+  });
+
+  it('should format log record with all expected fields', done => {
+    const mockLogRecord = createMockLogRecord('detailed test message', {
+      customKey: 'customValue',
+      requestId: '12345',
+    });
+
+    exporter.export([mockLogRecord], result => {
+      expect(result.code).toBe(ExportResultCode.SUCCESS);
+
+      const writtenData = stdoutWriteSpy.firstCall.args[0];
+      expect(writtenData).toBe(
+        '{"resource":{"attributes":{}},"instrumentationScope":{"name":"test","version":"1.0.0"},"timestamp":1640995200000000,"severityText":"INFO","body":"detailed test message","attributes":{"customKey":"customValue","requestId":"12345"}}\n'
+      );
+
+      const loggedContent = JSON.parse(writtenData);
+      expect(loggedContent.body).toBe('detailed test message');
+      expect(loggedContent.severityText).toBe('INFO');
+      expect(loggedContent.instrumentationScope.name).toBe('test');
+      expect(loggedContent.instrumentationScope.version).toBe('1.0.0');
+      expect(loggedContent.attributes).toEqual({ customKey: 'customValue', requestId: '12345' });
+
+      done();
+    });
+  });
+});