Rename metrics tag exception.type to error.type (#51084)

JamesNK · web-flow · commit 7ffeb436ad02 · 2023-10-10T15:25:21.000-07:00
diff --git a/src/Hosting/Hosting/src/Internal/HostingMetrics.cs b/src/Hosting/Hosting/src/Internal/HostingMetrics.cs
@@ -71,10 +71,10 @@ public void RequestEnd(string protocol, bool isHttps, string scheme, string meth
                 tags.Add("http.route", route);
             }
             // This exception is only present if there is an unhandled exception.
-            // An exception caught by ExceptionHandlerMiddleware and DeveloperExceptionMiddleware isn't thrown to here. Instead, those middleware add exception.type to custom tags.
+            // An exception caught by ExceptionHandlerMiddleware and DeveloperExceptionMiddleware isn't thrown to here. Instead, those middleware add error.type to custom tags.
             if (exception != null)
             {
-                tags.Add("exception.type", exception.GetType().FullName);
+                tags.Add("error.type", exception.GetType().FullName);
             }
             if (customTags != null)
             {
diff --git a/src/Hosting/Hosting/test/HostingMetricsTests.cs b/src/Hosting/Hosting/test/HostingMetricsTests.cs
@@ -97,11 +97,11 @@ static void AssertRequestDuration(CollectedMeasurement<double> measurement, stri
             Assert.Equal(statusCode, (int)measurement.Tags["http.response.status_code"]);
             if (exceptionName == null)
             {
-                Assert.False(measurement.Tags.ContainsKey("exception.type"));
+                Assert.False(measurement.Tags.ContainsKey("error.type"));
             }
             else
             {
-                Assert.Equal(exceptionName, (string)measurement.Tags["exception.type"]);
+                Assert.Equal(exceptionName, (string)measurement.Tags["error.type"]);
             }
             if (unhandledRequest ?? false)
             {
diff --git a/src/Middleware/Diagnostics/src/DiagnosticsMetrics.cs b/src/Middleware/Diagnostics/src/DiagnosticsMetrics.cs
@@ -39,7 +39,7 @@ public void RequestException(string exceptionName, ExceptionResult result, strin
     private void RequestExceptionCore(string exceptionName, ExceptionResult result, string? handler)
     {
         var tags = new TagList();
-        tags.Add("exception.type", exceptionName);
+        tags.Add("error.type", exceptionName);
         tags.Add("aspnetcore.diagnostics.exception.result", GetExceptionResult(result));
         if (handler != null)
         {
diff --git a/src/Middleware/Diagnostics/src/DiagnosticsTelemetry.cs b/src/Middleware/Diagnostics/src/DiagnosticsTelemetry.cs
@@ -15,7 +15,7 @@ public static void ReportUnhandledException(ILogger logger, HttpContext context,
 
         if (context.Features.Get<IHttpMetricsTagsFeature>() is { } tagsFeature)
         {
-            tagsFeature.Tags.Add(new KeyValuePair<string, object?>("exception.type", ex.GetType().FullName));
+            tagsFeature.Tags.Add(new KeyValuePair<string, object?>("error.type", ex.GetType().FullName));
         }
     }
 }
diff --git a/src/Middleware/Diagnostics/test/UnitTests/DeveloperExceptionPageMiddlewareTest.cs b/src/Middleware/Diagnostics/test/UnitTests/DeveloperExceptionPageMiddlewareTest.cs
@@ -579,7 +579,7 @@ public async Task UnhandledError_ExceptionNameTagAdded()
             {
                 Assert.True(m.Value > 0);
                 Assert.Equal(500, (int)m.Tags["http.response.status_code"]);
-                Assert.Equal("System.Exception", (string)m.Tags["exception.type"]);
+                Assert.Equal("System.Exception", (string)m.Tags["error.type"]);
             });
         Assert.Collection(requestExceptionCollector.GetMeasurementSnapshot(),
             m => AssertRequestException(m, "System.Exception", "unhandled"));
@@ -588,7 +588,7 @@ public async Task UnhandledError_ExceptionNameTagAdded()
     private static void AssertRequestException(CollectedMeasurement<long> measurement, string exceptionName, string result, string handler = null)
     {
         Assert.Equal(1, measurement.Value);
-        Assert.Equal(exceptionName, (string)measurement.Tags["exception.type"]);
+        Assert.Equal(exceptionName, (string)measurement.Tags["error.type"]);
         Assert.Equal(result, measurement.Tags["aspnetcore.diagnostics.exception.result"].ToString());
         if (handler == null)
         {
diff --git a/src/Middleware/Diagnostics/test/UnitTests/ExceptionHandlerMiddlewareTest.cs b/src/Middleware/Diagnostics/test/UnitTests/ExceptionHandlerMiddlewareTest.cs
@@ -318,7 +318,7 @@ public async Task Metrics_ExceptionThrown_Unhandled_Reported()
     private static void AssertRequestException(CollectedMeasurement<long> measurement, string exceptionName, string result, string handler = null)
     {
         Assert.Equal(1, measurement.Value);
-        Assert.Equal(exceptionName, (string)measurement.Tags["exception.type"]);
+        Assert.Equal(exceptionName, (string)measurement.Tags["error.type"]);
         Assert.Equal(result, measurement.Tags["aspnetcore.diagnostics.exception.result"].ToString());
         if (handler == null)
         {
diff --git a/src/Middleware/Diagnostics/test/UnitTests/ExceptionHandlerTest.cs b/src/Middleware/Diagnostics/test/UnitTests/ExceptionHandlerTest.cs
@@ -962,7 +962,7 @@ public async Task UnhandledError_ExceptionNameTagAdded()
             {
                 Assert.True(m.Value > 0);
                 Assert.Equal(404, (int)m.Tags["http.response.status_code"]);
-                Assert.Equal("System.Exception", (string)m.Tags["exception.type"]);
+                Assert.Equal("System.Exception", (string)m.Tags["error.type"]);
             });
     }
 }
diff --git a/src/Servers/Kestrel/Core/src/Internal/Infrastructure/KestrelMetrics.cs b/src/Servers/Kestrel/Core/src/Internal/Infrastructure/KestrelMetrics.cs
@@ -116,7 +116,7 @@ private void ConnectionStopCore(in ConnectionMetricsContext metricsContext, Exce
         {
             if (exception != null)
             {
-                tags.Add("exception.type", exception.GetType().FullName);
+                tags.Add("error.type", exception.GetType().FullName);
             }
 
             // Add custom tags for duration.
@@ -298,7 +298,7 @@ private void TlsHandshakeStopCore(in ConnectionMetricsContext metricsContext, lo
         }
         if (exception != null)
         {
-            tags.Add("exception.type", exception.GetType().FullName);
+            tags.Add("error.type", exception.GetType().FullName);
         }
 
         var duration = Stopwatch.GetElapsedTime(startTimestamp, currentTimestamp);
diff --git a/src/Servers/Kestrel/test/InMemory.FunctionalTests/KestrelMetricsTests.cs b/src/Servers/Kestrel/test/InMemory.FunctionalTests/KestrelMetricsTests.cs
@@ -273,7 +273,7 @@ public async Task Http1Connection_Error()
         Assert.Collection(connectionDuration.GetMeasurementSnapshot(), m =>
         {
             AssertDuration(m, "127.0.0.1", localPort: 0, "tcp", "ipv4", httpVersion: null);
-            Assert.Equal("System.InvalidOperationException", (string)m.Tags["exception.type"]);
+            Assert.Equal("System.InvalidOperationException", (string)m.Tags["error.type"]);
         });
         Assert.Collection(activeConnections.GetMeasurementSnapshot(), m => AssertCount(m, 1, "127.0.0.1", localPort: 0, "tcp", "ipv4"), m => AssertCount(m, -1, "127.0.0.1", localPort: 0, "tcp", "ipv4"));
         Assert.Collection(queuedConnections.GetMeasurementSnapshot(), m => AssertCount(m, 1, "127.0.0.1", localPort: 0, "tcp", "ipv4"), m => AssertCount(m, -1, "127.0.0.1", localPort: 0, "tcp", "ipv4"));

Original file line number	Diff line number	Diff line change
`@@ -71,10 +71,10 @@ public void RequestEnd(string protocol, bool isHttps, string scheme, string meth`
`71`	`71`	`tags.Add("http.route", route);`
`72`	`72`	`}`
`73`	`73`	`// This exception is only present if there is an unhandled exception.`
`74`		`- // An exception caught by ExceptionHandlerMiddleware and DeveloperExceptionMiddleware isn't thrown to here. Instead, those middleware add exception.type to custom tags.`
	`74`	`+ // An exception caught by ExceptionHandlerMiddleware and DeveloperExceptionMiddleware isn't thrown to here. Instead, those middleware add error.type to custom tags.`
`75`	`75`	`if (exception != null)`
`76`	`76`	`{`
`77`		`- tags.Add("exception.type", exception.GetType().FullName);`
	`77`	`+ tags.Add("error.type", exception.GetType().FullName);`
`78`	`78`	`}`
`79`	`79`	`if (customTags != null)`
`80`	`80`	`{`
Original file line number	Diff line number	Diff line change
`@@ -97,11 +97,11 @@ static void AssertRequestDuration(CollectedMeasurement<double> measurement, stri`
`97`	`97`	`Assert.Equal(statusCode, (int)measurement.Tags["http.response.status_code"]);`
`98`	`98`	`if (exceptionName == null)`
`99`	`99`	`{`
`100`		`- Assert.False(measurement.Tags.ContainsKey("exception.type"));`
	`100`	`+ Assert.False(measurement.Tags.ContainsKey("error.type"));`
`101`	`101`	`}`
`102`	`102`	`else`
`103`	`103`	`{`
`104`		`- Assert.Equal(exceptionName, (string)measurement.Tags["exception.type"]);`
	`104`	`+ Assert.Equal(exceptionName, (string)measurement.Tags["error.type"]);`
`105`	`105`	`}`
`106`	`106`	`if (unhandledRequest ?? false)`
`107`	`107`	`{`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public void RequestException(string exceptionName, ExceptionResult result, strin`
`39`	`39`	`private void RequestExceptionCore(string exceptionName, ExceptionResult result, string? handler)`
`40`	`40`	`{`
`41`	`41`	`var tags = new TagList();`
`42`		`- tags.Add("exception.type", exceptionName);`
	`42`	`+ tags.Add("error.type", exceptionName);`
`43`	`43`	`tags.Add("aspnetcore.diagnostics.exception.result", GetExceptionResult(result));`
`44`	`44`	`if (handler != null)`
`45`	`45`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public static void ReportUnhandledException(ILogger logger, HttpContext context,`
`15`	`15`
`16`	`16`	`if (context.Features.Get<IHttpMetricsTagsFeature>() is { } tagsFeature)`
`17`	`17`	`{`
`18`		`- tagsFeature.Tags.Add(new KeyValuePair<string, object?>("exception.type", ex.GetType().FullName));`
	`18`	`+ tagsFeature.Tags.Add(new KeyValuePair<string, object?>("error.type", ex.GetType().FullName));`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -579,7 +579,7 @@ public async Task UnhandledError_ExceptionNameTagAdded()`
`579`	`579`	`{`
`580`	`580`	`Assert.True(m.Value > 0);`
`581`	`581`	`Assert.Equal(500, (int)m.Tags["http.response.status_code"]);`
`582`		`- Assert.Equal("System.Exception", (string)m.Tags["exception.type"]);`
	`582`	`+ Assert.Equal("System.Exception", (string)m.Tags["error.type"]);`
`583`	`583`	`});`
`584`	`584`	`Assert.Collection(requestExceptionCollector.GetMeasurementSnapshot(),`
`585`	`585`	`m => AssertRequestException(m, "System.Exception", "unhandled"));`
`@@ -588,7 +588,7 @@ public async Task UnhandledError_ExceptionNameTagAdded()`
`588`	`588`	`private static void AssertRequestException(CollectedMeasurement<long> measurement, string exceptionName, string result, string handler = null)`
`589`	`589`	`{`
`590`	`590`	`Assert.Equal(1, measurement.Value);`
`591`		`- Assert.Equal(exceptionName, (string)measurement.Tags["exception.type"]);`
	`591`	`+ Assert.Equal(exceptionName, (string)measurement.Tags["error.type"]);`
`592`	`592`	`Assert.Equal(result, measurement.Tags["aspnetcore.diagnostics.exception.result"].ToString());`
`593`	`593`	`if (handler == null)`
`594`	`594`	`{`
Original file line number	Diff line number	Diff line change
`@@ -318,7 +318,7 @@ public async Task Metrics_ExceptionThrown_Unhandled_Reported()`
`318`	`318`	`private static void AssertRequestException(CollectedMeasurement<long> measurement, string exceptionName, string result, string handler = null)`
`319`	`319`	`{`
`320`	`320`	`Assert.Equal(1, measurement.Value);`
`321`		`- Assert.Equal(exceptionName, (string)measurement.Tags["exception.type"]);`
	`321`	`+ Assert.Equal(exceptionName, (string)measurement.Tags["error.type"]);`
`322`	`322`	`Assert.Equal(result, measurement.Tags["aspnetcore.diagnostics.exception.result"].ToString());`
`323`	`323`	`if (handler == null)`
`324`	`324`	`{`
Original file line number	Diff line number	Diff line change
`@@ -962,7 +962,7 @@ public async Task UnhandledError_ExceptionNameTagAdded()`
`962`	`962`	`{`
`963`	`963`	`Assert.True(m.Value > 0);`
`964`	`964`	`Assert.Equal(404, (int)m.Tags["http.response.status_code"]);`
`965`		`- Assert.Equal("System.Exception", (string)m.Tags["exception.type"]);`
	`965`	`+ Assert.Equal("System.Exception", (string)m.Tags["error.type"]);`
`966`	`966`	`});`
`967`	`967`	`}`
`968`	`968`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ private void ConnectionStopCore(in ConnectionMetricsContext metricsContext, Exce`
`116`	`116`	`{`
`117`	`117`	`if (exception != null)`
`118`	`118`	`{`
`119`		`- tags.Add("exception.type", exception.GetType().FullName);`
	`119`	`+ tags.Add("error.type", exception.GetType().FullName);`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`// Add custom tags for duration.`
`@@ -298,7 +298,7 @@ private void TlsHandshakeStopCore(in ConnectionMetricsContext metricsContext, lo`
`298`	`298`	`}`
`299`	`299`	`if (exception != null)`
`300`	`300`	`{`
`301`		`- tags.Add("exception.type", exception.GetType().FullName);`
	`301`	`+ tags.Add("error.type", exception.GetType().FullName);`
`302`	`302`	`}`
`303`	`303`
`304`	`304`	`var duration = Stopwatch.GetElapsedTime(startTimestamp, currentTimestamp);`
Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,7 @@ public async Task Http1Connection_Error()`
`273`	`273`	`Assert.Collection(connectionDuration.GetMeasurementSnapshot(), m =>`
`274`	`274`	`{`
`275`	`275`	`AssertDuration(m, "127.0.0.1", localPort: 0, "tcp", "ipv4", httpVersion: null);`
`276`		`- Assert.Equal("System.InvalidOperationException", (string)m.Tags["exception.type"]);`
	`276`	`+ Assert.Equal("System.InvalidOperationException", (string)m.Tags["error.type"]);`
`277`	`277`	`});`
`278`	`278`	`Assert.Collection(activeConnections.GetMeasurementSnapshot(), m => AssertCount(m, 1, "127.0.0.1", localPort: 0, "tcp", "ipv4"), m => AssertCount(m, -1, "127.0.0.1", localPort: 0, "tcp", "ipv4"));`
`279`	`279`	`Assert.Collection(queuedConnections.GetMeasurementSnapshot(), m => AssertCount(m, 1, "127.0.0.1", localPort: 0, "tcp", "ipv4"), m => AssertCount(m, -1, "127.0.0.1", localPort: 0, "tcp", "ipv4"));`