Azure Function App Insights logging scopes do not seem to work

Louis van Alphen 10

I have a minimal HTTP triggered Azure Function to test the inclusion of logging scopes in AppInsights.

The Program.cs as as follows:

using Microsoft.Extensions.Hosting;
 
var host = new HostBuilder()
    .ConfigureFunctionsWorkerDefaults()
    .Build();
 
host.Run();

host.json is

{
  "version": "2.0",
  "Logging": {
    "LogLevel": {
      "Default": "Information"
    }
  }
}

The function body is

using System.Net;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Http;
using Microsoft.Extensions.Logging;

namespace TestAzureFunctionLoggingScopes
{
  public class TestLoggingScopes
  {
    public TestLoggingScopes(ILogger<TestLoggingScopes> logger)
    {
      this.logger = logger;
    }

    [Function("TestLoggingScopes")]
    public HttpResponseData Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req)
    {
      using IDisposable scope = logger.BeginScope(new Dictionary<string, object> { ["MyScope"] = "MyLog" });

      logger.LogInformation($"C# HTTP trigger function processed a request. InvocationId: {req.FunctionContext.InvocationId}");

      var response = req.CreateResponse(HttpStatusCode.OK);

      response.WriteString($"Welcome to Azure Functions. InvocationId: {req.FunctionContext.InvocationId}");

      return response;
    }

    private readonly ILogger<TestLoggingScopes> logger;
  }
}

I am expection the AppInsight log entry to contain a CustomDimension prop__MyScope with value "MyLog" but it is not present.

enter image description here

Louis van Alphen 10 Reputation points

2023-12-04T10:38:53.5133333+00:00

Has been been a resolution yet?

1 answer

Ryan Hill 28,381 Reputation points Microsoft Employee

2023-11-27T16:03:47.88+00:00
Hi @Louis van Alphen

Your logging was done outside the scope. The logging you're doing should be done in between the braces { } to show scopes. It should be written as follow:

using (_logger.BeginScope("hello scope")) { _logger.LogError("An example of an Error level message"); }

Your current implementation only initializes scopes object which gets disposed after the Run method finishes. See Application Insights logging with .NET - Azure Monitor | Microsoft Learn for more info.
Please sign in to rate this answer.
Louis van Alphen 10 Reputation points

2023-11-27T18:41:03.55+00:00

Sorry, but the suggestion did not work... here is the code exactly copied & pasted from the suggestion

Ryan Hill 28,381 Reputation points Microsoft Employee

2023-11-28T19:26:59.9+00:00

Using your above code, it should be this way,

[Function("TestLoggingScopes")] public HttpResponseData Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req) { using IDisposable scope = logger.BeginScope(new Dictionary<string, object> { ["MyScope"] = "MyLog" }); { logger.LogInformation($"C# HTTP trigger function processed a request. InvocationId: {req.FunctionContext.InvocationId}"); var response = req.CreateResponse(HttpStatusCode.OK); response.WriteString($"Welcome to Azure Functions. InvocationId: {req.FunctionContext.InvocationId}"); logger.LogInformation("Another log message"); return response; } }

Louis van Alphen 10 Reputation points

2023-11-30T07:58:57.6233333+00:00

Unfortunately not working yet. I used the exact code you suggested (below), but scopes are still not working.

I cannot use Functions if the scopes are not working because the scope allows me to query the log entries for a particular process start to finish

using System.Net; using Microsoft.Azure.Functions.Worker; using Microsoft.Azure.Functions.Worker.Http; using Microsoft.Extensions.Logging; namespace TestAzureFunctionLoggingScopes { public class TestLoggingScopes { public TestLoggingScopes(ILogger<TestLoggingScopes> logger) { this.logger = logger; } [Function("TestLoggingScopes")] public HttpResponseData Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req) { using IDisposable scope = logger.BeginScope(new Dictionary<string, object> { ["MyScope"] = "MyLog" }); { logger.LogInformation($"C# HTTP trigger function processed a request. InvocationId: {req.FunctionContext.InvocationId}"); var response = req.CreateResponse(HttpStatusCode.OK); response.WriteString($"Welcome to Azure Functions. InvocationId: {req.FunctionContext.InvocationId}"); logger.LogInformation("Another log message"); return response; } } private readonly ILogger<TestLoggingScopes> logger; } }

Louis van Alphen 10 Reputation points

2023-11-30T07:59:54.7933333+00:00

Please see my response below. Not working yet

Louis van Alphen 10 Reputation points

2023-12-04T10:38:29.7466667+00:00

Has been been a resolution yet?

Ryan Hill 28,381 Reputation points Microsoft Employee

2023-12-04T16:34:29.55+00:00

Apologies for the delayed response @Louis van Alphen . I'll take a closer look at this and let you know.

Austen Frostad 1 Reputation point

2024-03-20T20:21:42.5066667+00:00

Concerning the suggestion of adding braces to fix the issue: Beginning with C# 8.0, the using keyword can be used as an attribute in the variable declarations of disposable objects (Reference). To clarify, the suggestion to use using statement versus using declaration makes no difference to solving the problem.

Louis van Alphen 10 Reputation points

2024-03-21T13:29:46.0166667+00:00

@Austen Frostad I agree. Strange that everyone pitches that as the solution. I have abandoned using Azure Functions for the very reason that logging scopes do not work in AF when logging to AppInsights

Travis Schilling 0 Reputation points

2024-04-11T00:05:35.6+00:00

This is a HUGE problem, we have azure functions currently in production that ARE successfully using the ILogger scope and it's properly showing up in App Insights, HOWEVER, we've just realized that in our Dev and Test environments, updating nuget packages and upgrading .NET versions, the scope is no longer being honored.

We really need this fixed as we have Azure Dashboards and reporting relying on this

Fin McCarthy 0 Reputation points

2024-07-02T01:50:08.79+00:00

Same issue. Scope not working.

C# Web App, dotnet 8 isolated.

My motivation for adding scope was to try to get the logs to chain together as they do for function apps. I see all logs, but they are not correlated. Clicking on Timeline shows the following error:

Louis van Alphen 10 Reputation points

2024-07-02T08:34:00.53+00:00

@Fin McCarthy Exactly my problem. With multiple processes logging to AppInsights you cannot distinguish one process's logs from the other.

Travis Schilling 0 Reputation points

2024-07-02T15:44:26.7033333+00:00

@Louis van Alphen and @Fin McCarthy one of our devs figured out how to get the logging scope to be honored again for .NET 8 Isolated functions. Finally found this documentation here calling out 2 new Nuget packages required as well as addition DI setup code to call.
https://learn.microsoft.com/en-us/azure/azure-functions/dotnet-isolated-process-guide?tabs=windows#application-insights

Packages:

Microsoft.Azure.Functions.Worker.ApplicationInsights

Microsoft.ApplicationInsights.WorkerService

Then in the function's startup (Program.cs), under .ConfigureServices you need to add the following:

services.AddApplicationInsightsTelemetryWorkerService(); services.ConfigureFunctionsApplicationInsights();

The biggest annoying part we have NOT resolved yet, is that it no longer honors the settings in our host.json file (e.g. log levels and sampling setting).

The documentation calls out the fact that the Functions host and the isolated process worker have separate configs now and that host.json settings will NOT affect logging from the worker (our code), so you have to deal with it programmatically.

In the case of disabling Sampling (which we wanted for some of our functions), you need to do it as part of the AddApplicationInsightsTelemetryWorkerService call in one of its overloads, and then to go along with this (because we wanted Information logs to also be included) we need to remove the default logging rule, which is called out, but I'll include their code here in case the site changes

builder.ConfigureLogging(logging => { // AppInsights uses a different filtering and only shows warnings or above by default. This removes that filter logging.Services.Configure<LoggerFilterOptions>(options => { LoggerFilterRule defaultRule = options.Rules.FirstOrDefault(rule => rule.ProviderName == "Microsoft.Extensions.Logging.ApplicationInsights.ApplicationInsightsLoggerProvider"); if (defaultRule is not null) { options.Rules.Remove(defaultRule); } }); }); ```The final thing (that I've run into so far), is that the `operation_Name` value is no longer being set for any of our worker logging, so this of course broke a bunch of our App Insights KQL queries that were looking for all the logs related to an individual function inside the function app. Found [this github issue](https://github.com/Azure/azure-functions-dotnet-worker/issues/1540) where MS said to utilize a TelemetryProcessor to set the `operation_Name` with the `AzureFunctions_FunctionName` value so did that, and now things seem to be mostly back to normal. We have found that the property names from the Logging scope (in the `customDimensions`) are no longer getting camel cased and are NOT getting prefixed with `prop__`, looks like the In-Process function handling was doing all that, so we're still having to update queries, but at least we have the logging scope items back. Here's the telemetry processor code: ```csharp // https://learn.microsoft.com/en-us/azure/azure-monitor/app/api-filtering-sampling?tabs=javascriptwebsdkloaderscript#create-a-telemetry-processor public class FunctionTelemetryProcessor : ITelemetryProcessor { private const string _azureFunctionsFunctionNameFieldKey = "AzureFunctions_FunctionName"; private readonly ITelemetryProcessor _next; public FunctionTelemetryProcessor(ITelemetryProcessor next) { _next = next; } public void Process(ITelemetry item) { if (item is ISupportProperties supportProperties) { if (string.IsNullOrWhiteSpace(item.Context.Operation.Name)) { if (supportProperties.Properties.TryGetValue(_azureFunctionsFunctionNameFieldKey, out string functionName)) { item.Context.Operation.Name = functionName; } } } _next.Process(item); } }

And add it using services.AddApplicationInsightsTelemetryProcessor<FunctionTelemetryProcessor>();

Louis van Alphen 10 Reputation points

2024-07-02T19:02:01.1733333+00:00

@Travis Schilling Thanks very much for the input. I will try your suggestions. For the time being, I have moved away from Functions for my background processes.

Pity the docs are so poor.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Azure Function App Insights logging scopes do not seem to work

1 answer

Your answer