Adding request id to error trace

Author: fabiocav

src/WebJobs.Script.WebHost/Handlers/ExceptionProcessingHandler.cs

@@ -83,6 +83,7 @@ private IEnumerable<ExceptionProcessor> GetExceptionHandlers(Exception exc)
 
         private static void DefaultExceptionHandler(ExceptionContext exceptionContext, AuthorizationLevel currentLevel, ApiErrorModel error)
         {
+            error.RequestId = exceptionContext.Request?.GetRequestId();
             if (currentLevel == AuthorizationLevel.Admin || exceptionContext.RequestContext.IsLocal)
             {
                 error.Message = GetExceptionMessage(exceptionContext.Exception);

src/WebJobs.Script.WebHost/Handlers/SystemTraceHandler.cs

@@ -24,7 +24,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
             var traceWriter = _config.DependencyResolver.GetService<TraceWriter>();
             var details = new JObject
             {
-                { "id", request.GetRequestId() },
+                { "requestId", request.GetRequestId() },
                 { "method", request.Method.ToString() },
                 { "uri", request.RequestUri.LocalPath.ToString() }
             };
@@ -34,7 +34,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
 
             details = new JObject
             {
-                { "id", request.GetRequestId() },
+                { "requestId", request.GetRequestId() },
                 { "method", request.Method.ToString() },
                 { "uri", request.RequestUri.LocalPath.ToString() },
                 { "authorizationLevel", request.GetAuthorizationLevel().ToString() }
@@ -43,7 +43,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
 
             details = new JObject
             {
-                { "id", request.GetRequestId() },
+                { "requestId", request.GetRequestId() },
                 { "status", response.StatusCode.ToString() }
             };
             traceWriter.Info($"Response details: {details}");

src/WebJobs.Script.WebHost/Models/ApiErrorModel.cs

@@ -23,6 +23,9 @@ public ApiErrorModel()
         [JsonProperty("id")]
         public string Id { get; set; }
 
+        [JsonProperty("requestId")]
+        public string RequestId { get; set; }
+
         [JsonProperty("statusCode")]
         public HttpStatusCode StatusCode { get; set; }
 

test/WebJobs.Script.Tests/Handlers/ExceptionProcessingHandlerTests.cs

@@ -76,7 +76,7 @@ public async Task Handle_WithAnonymousAndErrorDetailsFlag_SetsResponseWithNoErro
         private async Task<ApiErrorModel> ExecuteHandlerTest(AuthorizationLevel authLevel, bool includeDetails)
         {
             var handler = new ExceptionProcessingHandler(_config);
-
+            var requestId = Guid.NewGuid().ToString();
             var exception = new Exception("TestException");
             var exceptionContext = new ExceptionContext(exception, ExceptionCatchBlocks.HttpServer)
             {
@@ -85,7 +85,7 @@ private async Task<ApiErrorModel> ExecuteHandlerTest(AuthorizationLevel authLeve
 
             exceptionContext.Request.SetAuthorizationLevel(authLevel);
             exceptionContext.Request.SetConfiguration(_config);
-
+            exceptionContext.Request.Properties.Add(ScriptConstants.AzureFunctionsRequestIdKey, requestId);
             exceptionContext.RequestContext = new System.Web.Http.Controllers.HttpRequestContext();
 
             var context = new ExceptionHandlerContext(exceptionContext);
@@ -95,7 +95,11 @@ private async Task<ApiErrorModel> ExecuteHandlerTest(AuthorizationLevel authLeve
 
             HttpResponseMessage response = await context.Result.ExecuteAsync(CancellationToken.None);
 
-            return await response.Content.ReadAsAsync<ApiErrorModel>();
+            ApiErrorModel error = await response.Content.ReadAsAsync<ApiErrorModel>();
+
+            Assert.Equal(requestId, error.RequestId);
+
+            return error;
         }
     }
 }

test/WebJobs.Script.Tests/Handlers/SystemTraceHandlerTests.cs

@@ -56,19 +56,19 @@ public async Task SendAsync_WritesExpectedTraces()
             var trace = traces[0];
             Assert.Equal(TraceLevel.Info, trace.Level);
             string message = Regex.Replace(trace.Message, @"\s+", string.Empty);
-            Assert.Equal($"ExecutingHTTPrequest:{{\"id\":\"{requestId}\",\"method\":\"GET\",\"uri\":\"/api/testfunc\"}}", message);
+            Assert.Equal($"ExecutingHTTPrequest:{{\"requestId\":\"{requestId}\",\"method\":\"GET\",\"uri\":\"/api/testfunc\"}}", message);
 
             // validate executed trace
             trace = traces[1];
             Assert.Equal(TraceLevel.Info, trace.Level);
             message = Regex.Replace(trace.Message, @"\s+", string.Empty);
-            Assert.Equal($"ExecutedHTTPrequest:{{\"id\":\"{requestId}\",\"method\":\"GET\",\"uri\":\"/api/testfunc\",\"authorizationLevel\":\"Function\"}}", message);
+            Assert.Equal($"ExecutedHTTPrequest:{{\"requestId\":\"{requestId}\",\"method\":\"GET\",\"uri\":\"/api/testfunc\",\"authorizationLevel\":\"Function\"}}", message);
 
             // validate response trace
             trace = traces[2];
             Assert.Equal(TraceLevel.Info, trace.Level);
             message = Regex.Replace(trace.Message, @"\s+", string.Empty);
-            Assert.Equal($"Responsedetails:{{\"id\":\"{requestId}\",\"status\":\"OK\"}}", message);
+            Assert.Equal($"Responsedetails:{{\"requestId\":\"{requestId}\",\"status\":\"OK\"}}", message);
         }
     }
 }