rename UDP Exporter to AwsXrayUdpSpanExporter

Author: jj22ee

.github/workflows/release-udp-exporter.yml

@@ -18,7 +18,7 @@ jobs:
         uses: ./.github/actions/set_up
         with:
           node_version: "20"
-          package_name: "@aws/aws-otel-otlp-udp-exporter"
+          package_name: "@aws/aws-distro-opentelemetry-exporter-xray-udp"
           os: ubuntu-latest
           run_unit_tests: true
 
@@ -27,7 +27,7 @@ jobs:
         id: staging_tarball_build
         shell: bash
         run: |
-          cd exporters/aws-otel-otlp-udp-exporter
+          cd exporters/aws-distro-opentelemetry-exporter-xray-udp
           npm pack
 
       - name: Download and run X-Ray Daemon
@@ -42,7 +42,7 @@ jobs:
         run: |
           cd sample-applications/integ-test-http-server
           npm install
-          npm install ../../exporters/aws-otel-otlp-udp-exporter/aws-aws-otel-otlp-udp-exporter-*.tgz
+          npm install ../../exporters/aws-distro-opentelemetry-exporter-xray-udp/aws-aws-distro-opentelemetry-exporter-xray-udp-*.tgz
 
       - name: Run Sample App in Background
         run: |
@@ -76,7 +76,7 @@ jobs:
       # TODO: Uncomment when we make the first release
       # # Publish OTLP UDP Exporter to npm
       # - name: Publish to npm
-      #   working-directory: exporters/aws-otel-otlp-udp-exporter
+      #   working-directory: exporters/aws-distro-opentelemetry-exporter-xray-udp
       #   env:
       #     NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
       #     NPM_CONFIG_PROVENANCE: true

exporters/aws-otel-otlp-udp-exporter/.eslintignore renamed to exporters/aws-distro-opentelemetry-exporter-xray-udp/.eslintignore

@@ -0,0 +1,18 @@
+# AWS Distro for OpenTelemetry (ADOT) OTLP UDP Exporter
+
+Install this package into your NodeJS project with:
+
+```shell
+npm install --save @aws/aws-distro-opentelemetry-exporter-xray-udp
+```
+
+## Usage
+
+```js
+import { AwsXrayUdpSpanExporter } from './aws-xray-udp-span-exporter';
+import { SpanExporter } from '@opentelemetry/sdk-trace-base';
+
+// ...
+
+let AwsXrayUdpSpanExporter: SpanExporter = new AwsXrayUdpSpanExporter('127.0.0.1:2000');
+```

exporters/aws-otel-otlp-udp-exporter/.eslintrc.js renamed to exporters/aws-distro-opentelemetry-exporter-xray-udp/.eslintrc.js

@@ -1,12 +1,12 @@
 {
-  "name": "@aws/aws-otel-otlp-udp-exporter",
+  "name": "@aws/aws-distro-opentelemetry-exporter-xray-udp",
   "version": "0.0.1",
   "description": "This package provides an OTLP UDP Exporter for OpenTelemetry.",
   "author": {
     "name": "Amazon Web Services",
     "url": "http://aws.amazon.com"
   },
-  "homepage": "https://github.com/aws-observability/aws-otel-js-instrumentation/tree/main/exporters/aws-otel-otlp-udp-exporter#readme",
+  "homepage": "https://github.com/aws-observability/aws-otel-js-instrumentation/tree/main/exporters/aws-distro-opentelemetry-exporter-xray-udp#readme",
   "license": "Apache-2.0",
   "engines": {
     "node": ">=14"
@@ -22,7 +22,7 @@
     "compile": "tsc -p .",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "precompile": "tsc --version && lerna run version:update --scope @aws/aws-otel-otlp-udp-exporter --include-dependencies",
+    "precompile": "tsc --version && lerna run version:update --scope @aws/aws-distro-opentelemetry-exporter-xray-udp --include-dependencies",
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "tdd": "yarn test -- --watch-extensions ts --watch",

exporters/aws-otel-otlp-udp-exporter/LICENSE renamed to exporters/aws-distro-opentelemetry-exporter-xray-udp/LICENSE

@@ -54,7 +54,7 @@ export class UdpExporter {
   }
 }
 
-export class OTLPUdpSpanExporter implements SpanExporter {
+export class AwsXrayUdpSpanExporter implements SpanExporter {
   private _udpExporter: UdpExporter;
   private _signalPrefix: string;
   private _endpoint: string;

exporters/aws-distro-opentelemetry-exporter-xray-udp/README.md

@@ -1,4 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export { OTLPUdpSpanExporter } from './otlp-udp-exporter';
+export { AwsXrayUdpSpanExporter } from './aws-xray-udp-span-exporter';

exporters/aws-otel-otlp-udp-exporter/package.json renamed to exporters/aws-distro-opentelemetry-exporter-xray-udp/package.json

@@ -5,7 +5,7 @@ import { diag, SpanContext, SpanKind } from '@opentelemetry/api';
 import { ExportResultCode } from '@opentelemetry/core';
 import { Resource } from '@opentelemetry/resources';
 import { ProtobufTraceSerializer } from '@opentelemetry/otlp-transformer';
-import { OTLPUdpSpanExporter, UdpExporter } from '../src/otlp-udp-exporter';
+import { AwsXrayUdpSpanExporter, UdpExporter } from '../src/aws-xray-udp-span-exporter';
 import { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 import * as sinon from 'sinon';
 import expect from 'expect';
@@ -74,8 +74,8 @@ describe('UdpExporterTest', () => {
   });
 });
 
-describe('OTLPUdpSpanExporterTest', () => {
-  let otlpUdpSpanExporter: OTLPUdpSpanExporter;
+describe('AwsXrayUdpSpanExporterTest', () => {
+  let AwsXrayUdpSpanExporter: AwsXrayUdpSpanExporter;
   let udpExporterMock: { sendData: any; shutdown: any };
   let diagErrorSpy: sinon.SinonSpy<[message: string, ...args: unknown[]], void>;
   const endpoint = '127.0.0.1:3000';
@@ -123,8 +123,8 @@ describe('OTLPUdpSpanExporterTest', () => {
     // Stub the diag.error method
     diagErrorSpy = sinon.spy(diag, 'error');
 
-    // Create an instance of OTLPUdpSpanExporter
-    otlpUdpSpanExporter = new OTLPUdpSpanExporter(endpoint, prefix);
+    // Create an instance of AwsXrayUdpSpanExporter
+    AwsXrayUdpSpanExporter = new AwsXrayUdpSpanExporter(endpoint, prefix);
   });
 
   afterEach(() => {
@@ -137,7 +137,7 @@ describe('OTLPUdpSpanExporterTest', () => {
     // Stub ProtobufTraceSerializer.serializeRequest
     sinon.stub(ProtobufTraceSerializer, 'serializeRequest').returns(serializedData);
 
-    otlpUdpSpanExporter.export(spans, callback);
+    AwsXrayUdpSpanExporter.export(spans, callback);
 
     expect(udpExporterMock.sendData.calledOnceWith(serializedData, 'T1')).toBe(true);
     expect(callback.calledOnceWith({ code: ExportResultCode.SUCCESS })).toBe(true);
@@ -149,7 +149,7 @@ describe('OTLPUdpSpanExporterTest', () => {
     sinon.stub(ProtobufTraceSerializer, 'serializeRequest').returns(undefined);
     const callback = sinon.stub();
 
-    otlpUdpSpanExporter.export(spans, callback);
+    AwsXrayUdpSpanExporter.export(spans, callback);
 
     expect(callback.notCalled).toBe(true);
     expect(udpExporterMock.sendData.notCalled).toBe(true);
@@ -162,26 +162,26 @@ describe('OTLPUdpSpanExporterTest', () => {
 
     const callback = sinon.stub();
 
-    otlpUdpSpanExporter.export(spans, callback);
+    AwsXrayUdpSpanExporter.export(spans, callback);
 
     expect(diagErrorSpy.calledOnceWith('Error exporting spans: %s', sinon.match.instanceOf(Error))).toBe(true);
     expect(callback.calledOnceWith({ code: ExportResultCode.FAILED })).toBe(true);
   });
 
   it('should forceFlush without throwing', async () => {
-    expect(otlpUdpSpanExporter.forceFlush()).resolves.not.toThrow();
+    expect(AwsXrayUdpSpanExporter.forceFlush()).resolves.not.toThrow();
   });
 
   it('should shutdown the UDP exporter successfully', async () => {
-    await otlpUdpSpanExporter.shutdown();
+    await AwsXrayUdpSpanExporter.shutdown();
     expect(udpExporterMock.shutdown.calledOnce).toBe(true);
   });
 
   it('should use expected Environment Variables to configure endpoint', () => {
     process.env.AWS_LAMBDA_FUNCTION_NAME = 'testFunctionName';
     process.env.AWS_XRAY_DAEMON_ADDRESS = 'someaddress:1234';
 
-    const exporter = new OTLPUdpSpanExporter(undefined);
+    const exporter = new AwsXrayUdpSpanExporter(undefined);
     expect(exporter['_endpoint']).toBe('someaddress:1234');
     expect(exporter['_udpExporter']['_host']).toBe('someaddress');
     expect(exporter['_udpExporter']['_port']).toBe(1234);