[AzureMonitorExporter] refactor logging (part2) (Azure#36929)

Timothy Mothra · web-flow · commit b0306ff5b788 · 2023-06-14T16:05:38.000-07:00
* refactor logs messages

* revert change to ExceptionExtensions

* fix merge conflict

* fix id
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/AzureMonitorLogExporter.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/AzureMonitorLogExporter.cs
@@ -48,7 +48,7 @@ public override ExportResult Export(in Batch<LogRecord> batch)
             }
             catch (Exception ex)
             {
-                AzureMonitorExporterEventSource.Log.WriteError("FailedToExport", ex);
+                AzureMonitorExporterEventSource.Log.FailedToExport(ex);
             }
 
             return exportResult;
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/AzureMonitorMetricExporter.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/AzureMonitorMetricExporter.cs
@@ -57,7 +57,7 @@ public override ExportResult Export(in Batch<Metric> batch)
             }
             catch (Exception ex)
             {
-                AzureMonitorExporterEventSource.Log.WriteError("FailedToExport", ex);
+                AzureMonitorExporterEventSource.Log.FailedToExport(ex);
             }
 
             return exportResult;
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/AzureMonitorTraceExporter.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/AzureMonitorTraceExporter.cs
@@ -48,7 +48,7 @@ public override ExportResult Export(in Batch<Activity> batch)
             }
             catch (Exception ex)
             {
-                AzureMonitorExporterEventSource.Log.WriteError("FailedToExport", ex);
+                AzureMonitorExporterEventSource.Log.FailedToExport(ex);
             }
 
             return exportResult;
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/ApplicationInsightsRestClient.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/ApplicationInsightsRestClient.cs
@@ -41,7 +41,7 @@ internal async Task<HttpMessage> InternalTrackAsync(IEnumerable<TelemetryItem> b
             }
             catch (Exception ex)
             {
-                AzureMonitorExporterEventSource.Log.WriteError("FailedToSend", ex);
+                AzureMonitorExporterEventSource.Log.FailedToTransmit(ex);
                 if (ex.InnerException?.Source != "System.Net.Http")
                 {
                     message?.Dispose();
@@ -69,7 +69,7 @@ internal async Task<HttpMessage> InternalTrackAsync(ReadOnlyMemory<byte> body, C
             }
             catch (Exception ex)
             {
-                AzureMonitorExporterEventSource.Log.WriteError("FailedToSend", ex);
+                AzureMonitorExporterEventSource.Log.FailedToTransmit(ex);
                 if (ex.InnerException?.Source != "System.Net.Http")
                 {
                     message?.Dispose();
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/Diagnostics/AzureMonitorExporterEventSource.New.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/Diagnostics/AzureMonitorExporterEventSource.New.cs
@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Diagnostics.Tracing;
+using Azure.Monitor.OpenTelemetry.Exporter.Internals.ConnectionString;
+
+namespace Azure.Monitor.OpenTelemetry.Exporter.Internals.Diagnostics
+{
+    internal sealed partial class AzureMonitorExporterEventSource : EventSource
+    {
+        [NonEvent]
+        public void FailedToExport(Exception ex)
+        {
+            if (IsEnabled(EventLevel.Error))
+            {
+                FailedToExport(ex.FlattenException().ToInvariantString());
+            }
+        }
+
+        [Event(6, Message = "Failed to export due to an exception: {0}", Level = EventLevel.Error)]
+        public void FailedToExport(string exceptionMessage) => WriteEvent(6, exceptionMessage);
+
+        [NonEvent]
+        public void FailedToTransmit(Exception ex)
+        {
+            if (IsEnabled(EventLevel.Error))
+            {
+                FailedToTransmit(ex.FlattenException().ToInvariantString());
+            }
+        }
+
+        [Event(7, Message = "Failed to transmit due to an exception: {0}", Level = EventLevel.Error)]
+        public void FailedToTransmit(string exceptionMessage) => WriteEvent(7, exceptionMessage);
+
+        [NonEvent]
+        public void TransmissionFailed(bool fromStorage, int statusCode, ConnectionVars connectionVars, string? requestEndpoint, bool willRetry)
+        {
+            // TODO: INCLUDE EXACT ERROR MESSAGE FROM INGESTION
+            if (IsEnabled(EventLevel.Warning))
+            {
+                TransmissionFailed(
+                    message: fromStorage ? "Transmission from storage failed." : "Transmission failed.",
+                    retryDetails: willRetry ? "Telemetry is stored offline for retry." : "Telemetry is dropped.",
+                    metaData: $"Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {requestEndpoint}"
+                    );
+            }
+        }
+
+        [Event(8, Message = "{0} {1} {2}")]
+        public void TransmissionFailed(string message, string retryDetails, string metaData) => WriteEvent(8, message, retryDetails, metaData);
+    }
+}
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/Diagnostics/AzureMonitorExporterEventSource.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/Diagnostics/AzureMonitorExporterEventSource.cs
@@ -8,7 +8,7 @@
 namespace Azure.Monitor.OpenTelemetry.Exporter.Internals.Diagnostics
 {
     [EventSource(Name = EventSourceName)]
-    internal sealed class AzureMonitorExporterEventSource : EventSource
+    internal sealed partial class AzureMonitorExporterEventSource : EventSource
     {
         internal const string EventSourceName = "OpenTelemetry-AzureMonitor-Exporter";
 
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/HttpPipelineHelper.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/HttpPipelineHelper.cs
@@ -207,14 +207,7 @@ internal static ExportResult HandleFailures(HttpMessage httpMessage, PersistentB
                 }
             }
 
-            if (result == ExportResult.Success)
-            {
-                AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmit", $"Error code is {statusCode}: Telemetry is stored offline for retry. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");
-            }
-            else
-            {
-                AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmit", $"Error code is {statusCode}: Telemetry is dropped. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");
-            }
+            AzureMonitorExporterEventSource.Log.TransmissionFailed(fromStorage: false, statusCode: statusCode, connectionVars: connectionVars, requestEndpoint: httpMessage.Request.Uri.Host, willRetry: (result == ExportResult.Success));
 
             return result;
         }
@@ -259,14 +252,7 @@ internal static void HandleFailures(HttpMessage httpMessage, PersistentBlob blob
                 }
             }
 
-            if (shouldRetry)
-            {
-                AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmitFromStorage", $"Error code is {statusCode}: Telemetry is stored offline for retry. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");
-            }
-            else
-            {
-                AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmitFromStorage", $"Error code is {statusCode}: Telemetry is dropped. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");
-            }
+            AzureMonitorExporterEventSource.Log.TransmissionFailed(fromStorage: true, statusCode: statusCode, connectionVars: connectionVars, requestEndpoint: httpMessage.Request.Uri.Host, willRetry: shouldRetry);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public override ExportResult Export(in Batch<LogRecord> batch)`
`48`	`48`	`}`
`49`	`49`	`catch (Exception ex)`
`50`	`50`	`{`
`51`		`- AzureMonitorExporterEventSource.Log.WriteError("FailedToExport", ex);`
	`51`	`+ AzureMonitorExporterEventSource.Log.FailedToExport(ex);`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`return exportResult;`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public override ExportResult Export(in Batch<Metric> batch)`
`57`	`57`	`}`
`58`	`58`	`catch (Exception ex)`
`59`	`59`	`{`
`60`		`- AzureMonitorExporterEventSource.Log.WriteError("FailedToExport", ex);`
	`60`	`+ AzureMonitorExporterEventSource.Log.FailedToExport(ex);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`return exportResult;`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ internal async Task<HttpMessage> InternalTrackAsync(IEnumerable<TelemetryItem> b`
`41`	`41`	`}`
`42`	`42`	`catch (Exception ex)`
`43`	`43`	`{`
`44`		`- AzureMonitorExporterEventSource.Log.WriteError("FailedToSend", ex);`
	`44`	`+ AzureMonitorExporterEventSource.Log.FailedToTransmit(ex);`
`45`	`45`	`if (ex.InnerException?.Source != "System.Net.Http")`
`46`	`46`	`{`
`47`	`47`	`message?.Dispose();`
`@@ -69,7 +69,7 @@ internal async Task<HttpMessage> InternalTrackAsync(ReadOnlyMemory<byte> body, C`
`69`	`69`	`}`
`70`	`70`	`catch (Exception ex)`
`71`	`71`	`{`
`72`		`- AzureMonitorExporterEventSource.Log.WriteError("FailedToSend", ex);`
	`72`	`+ AzureMonitorExporterEventSource.Log.FailedToTransmit(ex);`
`73`	`73`	`if (ex.InnerException?.Source != "System.Net.Http")`
`74`	`74`	`{`
`75`	`75`	`message?.Dispose();`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`namespace Azure.Monitor.OpenTelemetry.Exporter.Internals.Diagnostics`
`9`	`9`	`{`
`10`	`10`	`[EventSource(Name = EventSourceName)]`
`11`		`- internal sealed class AzureMonitorExporterEventSource : EventSource`
	`11`	`+ internal sealed partial class AzureMonitorExporterEventSource : EventSource`
`12`	`12`	`{`
`13`	`13`	`internal const string EventSourceName = "OpenTelemetry-AzureMonitor-Exporter";`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -207,14 +207,7 @@ internal static ExportResult HandleFailures(HttpMessage httpMessage, PersistentB`
`207`	`207`	`}`
`208`	`208`	`}`
`209`	`209`
`210`		`- if (result == ExportResult.Success)`
`211`		`- {`
`212`		`- AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmit", $"Error code is {statusCode}: Telemetry is stored offline for retry. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");`
`213`		`- }`
`214`		`- else`
`215`		`- {`
`216`		`- AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmit", $"Error code is {statusCode}: Telemetry is dropped. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");`
`217`		`- }`
	`210`	`+ AzureMonitorExporterEventSource.Log.TransmissionFailed(fromStorage: false, statusCode: statusCode, connectionVars: connectionVars, requestEndpoint: httpMessage.Request.Uri.Host, willRetry: (result == ExportResult.Success));`
`218`	`211`
`219`	`212`	`return result;`
`220`	`213`	`}`
`@@ -259,14 +252,7 @@ internal static void HandleFailures(HttpMessage httpMessage, PersistentBlob blob`
`259`	`252`	`}`
`260`	`253`	`}`
`261`	`254`
`262`		`- if (shouldRetry)`
`263`		`- {`
`264`		`- AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmitFromStorage", $"Error code is {statusCode}: Telemetry is stored offline for retry. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");`
`265`		`- }`
`266`		`- else`
`267`		`- {`
`268`		`- AzureMonitorExporterEventSource.Log.WriteWarning("FailedToTransmitFromStorage", $"Error code is {statusCode}: Telemetry is dropped. Instrumentation Key: {connectionVars.InstrumentationKey}, Configured Endpoint: {connectionVars.IngestionEndpoint}, Actual Endpoint: {httpMessage.Request.Uri.Host}");`
`269`		`- }`
	`255`	`+ AzureMonitorExporterEventSource.Log.TransmissionFailed(fromStorage: true, statusCode: statusCode, connectionVars: connectionVars, requestEndpoint: httpMessage.Request.Uri.Host, willRetry: shouldRetry);`
`270`	`256`	`}`
`271`	`257`	`}`
`272`	`258`	`}`