README

Plinth.Logging.NLog.AppInsights

Integration allowing Plinth and NLog to record telemetry and logs to Azure Application Insights

1. Add this to your NLog.config under the <nlog> tag

  <extensions>
    <add assembly="Plinth.Logging.NLog.AppInsights" prefix="plinthAI" />
  </extensions>

2. Then create the target

  <targets>
    <target xsi:type="plinthAI.AppInsightsTarget" name="aiTarget">
      <connectionString>{from-Azure-Portal}</connectionString>
      <cloudRoleName>testRole1</cloudRoleName>
      <cloudRoleInstance>serverA</cloudRoleInstance>
      <maxLength>25000</maxLength>
    </target>
  </targets>

• :point_right: Do not wrap this in an async wrapper. It will break the context and metadata.
• cloudRoleName and cloudRoleInstance are optional, and will have reasonable defaults if not specified
• Cloud Role Name is typically the application name
• Cloud Role Instance is typically the machine name
• The maxLength field is optional, and defaults to 25000 characters
• :point_right: Using a connection string is preferred. <instrumentationKey> is supported but deprecated and will stop working in March 2025

3. Reference the target in a logger rule

  <rules>
    <logger name="*" minlevel="Debug" writeTo="aiTarget" />
  </rules>

4. Initialize telemetry in Startup

  services.AddPlinthAppInsightsTelemetry(cfg => 
  {
      cfg.CloudRoleName = "MyApp";
      cfg.DisabledPrefixes.Add("/health");
  });

:point_right: The lambda is optional and only necessary if setting hardcoded configuration

Configurations Options are

• ConnectionString: If not setting via environment variable or NLog.config
• DisabledPrefixes: A blacklist of url prefixes to disable Request Telemetry. Example: