Rename OtlpUdpExporter to XrayUdpExporter (#211)

jj22ee · web-flow · commit 2e4ab295b2e5 · 2025-05-13T14:42:22.000-07:00
diff --git a/exporters/AWS.Distro.OpenTelemetry.Exporter.Xray.Udp/XrayUdpExporter.cs b/exporters/AWS.Distro.OpenTelemetry.Exporter.Xray.Udp/XrayUdpExporter.cs
@@ -12,25 +12,25 @@
 namespace AWS.Distro.OpenTelemetry.Exporter.Xray.Udp;
 
 /// <summary>
-/// OTLP UDP Exporter class. This class is used to build an OtlpUdpExporter to registered as in exporter
+/// OTLP UDP Exporter class. This class is used to build an XrayUdpExporter to registered as in exporter
 /// during the instrumentation initialization phase
 /// </summary>
-public class OtlpUdpExporter : BaseExporter<Activity>
+public class XrayUdpExporter : BaseExporter<Activity>
 {
     private static readonly ILoggerFactory Factory = LoggerFactory.Create(builder => builder.AddProvider(new ConsoleLoggerProvider()));
-    private static readonly ILogger Logger = Factory.CreateLogger<OtlpUdpExporter>();
+    private static readonly ILogger Logger = Factory.CreateLogger<XrayUdpExporter>();
 
     private UdpExporter udpExporter;
     private string signalPrefix;
     private Resource processResource;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="OtlpUdpExporter"/> class.
+    /// Initializes a new instance of the <see cref="XrayUdpExporter"/> class.
     /// </summary>
     /// <param name="endpoint">Endpoint to export requests to</param>
     /// <param name="signalPrefix">Sampled vs UnSampled signal prefix</param>
     /// <param name="processResource">Otel Resource object</param>
-    public OtlpUdpExporter(Resource processResource, string? endpoint = null, string? signalPrefix = null)
+    public XrayUdpExporter(Resource processResource, string? endpoint = null, string? signalPrefix = null)
     {
         // Check if running in AWS Lambda environment
         if (endpoint == null && !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("AWS_LAMBDA_FUNCTION_NAME")))
diff --git a/exporters/AWS.Distro.OpenTelemetry.Exporter.Xray.Udp/nuget-readme.md b/exporters/AWS.Distro.OpenTelemetry.Exporter.Xray.Udp/nuget-readme.md
@@ -19,7 +19,7 @@ Sdk.CreateTracerProviderBuilder()
     .AddAspNetCoreInstrumentation()
     .AddHttpClientInstrumentation()
     // Add the X-Ray UDP Exporter
-    .AddOtlpUdpExporter(resourceBuilder.Build(), "localhost:2000")
+    .AddXrayUdpExporter(resourceBuilder.Build(), "localhost:2000")
     .Build();
 ```
 
@@ -36,7 +36,7 @@ builder.Services.AddOpenTelemetry()
          builder
          .SetResourceBuilder(resourceBuilder)
          .AddAspNetCoreInstrumentation()
-         .AddOtlpUdpExporter(resourceBuilder.Build(), "localhost:2000");
+         .AddXrayUdpExporter(resourceBuilder.Build(), "localhost:2000");
      });
 ```
 
diff --git a/sample-applications/udp-exporter-test-app/Startup.cs b/sample-applications/udp-exporter-test-app/Startup.cs
@@ -44,7 +44,7 @@ public void ConfigureServices(IServiceCollection services)
                     {
                         options.Endpoint = new Uri(Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT"));
                     })
-                    .AddOtlpUdpExporter(resourceBuilder.Build(), "localhost:2000")
+                    .AddXrayUdpExporter(resourceBuilder.Build(), "localhost:2000")
                     .Build();
             }
             else {
@@ -61,7 +61,7 @@ public void ConfigureServices(IServiceCollection services)
                     {
                         options.Endpoint = new Uri(Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT"));
                     })
-                    .AddOtlpUdpExporter(resourceBuilder.Build(), "localhost:2000")
+                    .AddXrayUdpExporter(resourceBuilder.Build(), "localhost:2000")
                     .Build();
             }
 
@@ -96,14 +96,14 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
     public static class TracerProviderBuilderExtensions
     {
-        public static TracerProviderBuilder AddOtlpUdpExporter(
+        public static TracerProviderBuilder AddXrayUdpExporter(
             this TracerProviderBuilder builder, 
             Resource resource, 
             string endpoint)
         {
             return builder.AddProcessor(
                 new BatchActivityExportProcessor(
-                    new OtlpUdpExporter(resource, endpoint)
+                    new XrayUdpExporter(resource, endpoint)
                 )
             );
         }
diff --git a/src/AWS.Distro.OpenTelemetry.AutoInstrumentation/GlobalSuppressions.cs b/src/AWS.Distro.OpenTelemetry.AutoInstrumentation/GlobalSuppressions.cs
@@ -16,19 +16,19 @@
 [assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "Reviewed", Scope = "member", Target = "~M:AWS.Distro.OpenTelemetry.AutoInstrumentation.AwsMetricAttributesSpanExporterBuilder.Create(OpenTelemetry.BaseExporter{System.Diagnostics.Activity},OpenTelemetry.Resources.Resource)~AWS.Distro.OpenTelemetry.AutoInstrumentation.AwsMetricAttributesSpanExporterBuilder")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Reviewed", Scope = "type", Target = "~T:ByteStringConverter")]
 [assembly: SuppressMessage("Design", "CA1050:Declare types in namespaces", Justification = "Reviewed", Scope = "type", Target = "~T:ByteStringConverter")]
-[assembly: SuppressMessage("Design", "CA1050:Declare types in namespaces", Justification = "Reviewed", Scope = "type", Target = "~T:OtlpUdpExporter")]
+[assembly: SuppressMessage("Design", "CA1050:Declare types in namespaces", Justification = "Reviewed", Scope = "type", Target = "~T:XrayUdpExporter")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Reviewed", Scope = "type", Target = "~T:SpanKindConverter")]
 [assembly: SuppressMessage("Design", "CA1050:Declare types in namespaces", Justification = "Reviewed", Scope = "type", Target = "~T:SpanKindConverter")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Reviewed", Scope = "type", Target = "~T:UdpExporter")]
 [assembly: SuppressMessage("Design", "CA1050:Declare types in namespaces", Justification = "Reviewed", Scope = "type", Target = "~T:UdpExporter")]
-[assembly: SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1011:Closing square brackets should be spaced correctly", Justification = "Reviewed", Scope = "member", Target = "~M:OtlpUdpExporter.Export(OpenTelemetry.Batch{System.Diagnostics.Activity}@)~OpenTelemetry.ExportResult")]
+[assembly: SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1011:Closing square brackets should be spaced correctly", Justification = "Reviewed", Scope = "member", Target = "~M:XrayUdpExporter.Export(OpenTelemetry.Batch{System.Diagnostics.Activity}@)~OpenTelemetry.ExportResult")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Reviewed", Scope = "type", Target = "~T:StatusCodeConverter")]
 [assembly: SuppressMessage("StyleCop.CSharp.NamingRules", "SA1307:Accessible fields should begin with upper-case letter", Justification = "Reviewed", Scope = "member", Target = "~F:AWS.Distro.OpenTelemetry.AutoInstrumentation.Version.version")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1400:Access modifier should be declared", Justification = "Reviewed", Scope = "type", Target = "~T:AWS.Distro.OpenTelemetry.AutoInstrumentation.Version")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "Reviewed", Scope = "member", Target = "~F:AWS.Distro.OpenTelemetry.AutoInstrumentation.Version.version")]
 [assembly: SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1636:File header copyright text should match", Justification = "Reviewed")]
 [assembly: SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1011:Closing square brackets should be spaced correctly", Justification = "Reviewed", Scope = "member", Target = "~M:OtlpExporterUtils.SerializeSpans(OpenTelemetry.Batch{System.Diagnostics.Activity},OpenTelemetry.Resources.Resource)~System.Byte[]")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Reviewed", Scope = "type", Target = "~T:RetryHelper")]
-[assembly: SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1011:Closing square brackets should be spaced correctly", Justification = "Reviewed", Scope = "member", Target = "~M:OtlpAwsSpanExporter.Export(OpenTelemetry.Batch{System.Diagnostics.Activity}@)~OpenTelemetry.ExportResult,~M:OtlpUdpExporter.SerializeSpans(OpenTelemetry.Batch{System.Diagnostics.Activity})~System.Byte[]")]
+[assembly: SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1011:Closing square brackets should be spaced correctly", Justification = "Reviewed", Scope = "member", Target = "~M:OtlpAwsSpanExporter.Export(OpenTelemetry.Batch{System.Diagnostics.Activity}@)~OpenTelemetry.ExportResult,~M:XrayUdpExporter.SerializeSpans(OpenTelemetry.Batch{System.Diagnostics.Activity})~System.Byte[]")]
 
 // TODO, review these suppressions.
diff --git a/src/AWS.Distro.OpenTelemetry.AutoInstrumentation/Plugin.cs b/src/AWS.Distro.OpenTelemetry.AutoInstrumentation/Plugin.cs
@@ -157,13 +157,13 @@ public void TracerProviderInitialized(TracerProvider tracerProvider)
                 Resource processResource = tracerProvider.GetResource();
 
                 // UDP exporter for sampled spans
-                var sampledSpanExporter = new OtlpUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelSampledTracesBinaryPrefix);
+                var sampledSpanExporter = new XrayUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelSampledTracesBinaryPrefix);
                 tracerProvider.AddProcessor(new BatchActivityExportProcessor(exporter: sampledSpanExporter, maxExportBatchSize: LambdaSpanExportBatchSize));
                 if (this.IsApplicationSignalsEnabled())
                 {
                     // Register UDP Exporter to export unsampled traces in Lambda
                     // only when Application Signals enabled
-                    var unsampledSpanExporter = new OtlpUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelUnSampledTracesBinaryPrefix);
+                    var unsampledSpanExporter = new XrayUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelUnSampledTracesBinaryPrefix);
                     tracerProvider.AddProcessor(new AwsBatchUnsampledSpanExportProcessor(exporter: unsampledSpanExporter, maxExportBatchSize: LambdaSpanExportBatchSize));
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public void ConfigureServices(IServiceCollection services)`
`44`	`44`	`{`
`45`	`45`	`options.Endpoint = new Uri(Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT"));`
`46`	`46`	`})`
`47`		`- .AddOtlpUdpExporter(resourceBuilder.Build(), "localhost:2000")`
	`47`	`+ .AddXrayUdpExporter(resourceBuilder.Build(), "localhost:2000")`
`48`	`48`	`.Build();`
`49`	`49`	`}`
`50`	`50`	`else {`
`@@ -61,7 +61,7 @@ public void ConfigureServices(IServiceCollection services)`
`61`	`61`	`{`
`62`	`62`	`options.Endpoint = new Uri(Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT"));`
`63`	`63`	`})`
`64`		`- .AddOtlpUdpExporter(resourceBuilder.Build(), "localhost:2000")`
	`64`	`+ .AddXrayUdpExporter(resourceBuilder.Build(), "localhost:2000")`
`65`	`65`	`.Build();`
`66`	`66`	`}`
`67`	`67`
`@@ -96,14 +96,14 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`96`	`96`
`97`	`97`	`public static class TracerProviderBuilderExtensions`
`98`	`98`	`{`
`99`		`- public static TracerProviderBuilder AddOtlpUdpExporter(`
	`99`	`+ public static TracerProviderBuilder AddXrayUdpExporter(`
`100`	`100`	`this TracerProviderBuilder builder,`
`101`	`101`	`Resource resource,`
`102`	`102`	`string endpoint)`
`103`	`103`	`{`
`104`	`104`	`return builder.AddProcessor(`
`105`	`105`	`new BatchActivityExportProcessor(`
`106`		`- new OtlpUdpExporter(resource, endpoint)`
	`106`	`+ new XrayUdpExporter(resource, endpoint)`
`107`	`107`	`)`
`108`	`108`	`);`
`109`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -157,13 +157,13 @@ public void TracerProviderInitialized(TracerProvider tracerProvider)`
`157`	`157`	`Resource processResource = tracerProvider.GetResource();`
`158`	`158`
`159`	`159`	`// UDP exporter for sampled spans`
`160`		`- var sampledSpanExporter = new OtlpUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelSampledTracesBinaryPrefix);`
	`160`	`+ var sampledSpanExporter = new XrayUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelSampledTracesBinaryPrefix);`
`161`	`161`	`tracerProvider.AddProcessor(new BatchActivityExportProcessor(exporter: sampledSpanExporter, maxExportBatchSize: LambdaSpanExportBatchSize));`
`162`	`162`	`if (this.IsApplicationSignalsEnabled())`
`163`	`163`	`{`
`164`	`164`	`// Register UDP Exporter to export unsampled traces in Lambda`
`165`	`165`	`// only when Application Signals enabled`
`166`		`- var unsampledSpanExporter = new OtlpUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelUnSampledTracesBinaryPrefix);`
	`166`	`+ var unsampledSpanExporter = new XrayUdpExporter(processResource, AwsXrayDaemonAddress, FormatOtelUnSampledTracesBinaryPrefix);`
`167`	`167`	`tracerProvider.AddProcessor(new AwsBatchUnsampledSpanExportProcessor(exporter: unsampledSpanExporter, maxExportBatchSize: LambdaSpanExportBatchSize));`
`168`	`168`	`}`
`169`	`169`	`}`