ApplicationInsights.ProblemDetails

Overview

MS Application Insights integration for the Hellang.Middleware.ProblemDetails package.

Enriches request telemetry with custom dimensions extracted from a ProblemDetail response:

Usage

Prerequisites

Ensure your ASP.Net Core application has been configured with:

• MS Application Insights SDK; see official guidance
• Hellang.Middleware.ProblemDetails package. For guidance see:
  • sample code
  • sample app

Steps

1. Install package

   dotnet add package CcAcca.ApplicationInsights.ProblemDetails
   

2. Register the library with .Net Core dependency injection system. In Statup.ConfigureServices method add:

   services.AddProblemDetailTelemetryInitializer()
   

Configuration / customization

• Configure which ProblemDetail responses are sent to application insights:

  services.AddProblemDetailTelemetryInitializer(o => {
    o.ShouldSend = (ctx, problem) => problem.Status >= StatusCodes.Status500InternalServerError;
  })
  

• Configure which properties of an ProblemDetail should be sent to application insights:

  services.AddProblemDetailTelemetryInitializer(o => {
   o.IncludeErrorsValue = (ctx, problem) => !SensitiveUrl(ctx);
   o.IncludeExtensionsValue = (ctx, problem) => !SensitiveUrl(ctx);
   o.IncludeRawJson = (ctx, problem) => !SensitiveUrl(ctx);
  });
  

• Configure the values of the dimensions sent to application insights:

  services.AddProblemDetailTelemetryInitializer(o => {
   o.MapDimensions = (ctx, problem, dimensions) => {
     var sensitiveFields = new[] {"SSN", "SocialSecurityNumber", "AccountNumber"};
     var isSensitive = dimensions.Any(d => sensitiveFields.Any(f => d.Key.Contains(f)));
     var sanitized = isSensitive
       ? dimensions
         .Where(d =>
           !sensitiveFields.Concat(new[] {DefaultDimensionCollector.RawDimensionKey})
             .Any(f => d.Key.Contains(f)))
       : dimensions;
     return new Dictionary<string, string>(sanitized);
   };
  });