Plinth.Logging.NLog.AppInsights 1.5.5

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Plinth.Logging.NLog.AppInsights --version 1.5.5                

                    
                

            
NuGet\Install-Package Plinth.Logging.NLog.AppInsights -Version 1.5.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Plinth.Logging.NLog.AppInsights" Version="1.5.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Plinth.Logging.NLog.AppInsights --version 1.5.5                

                    
                

            
#r "nuget: Plinth.Logging.NLog.AppInsights, 1.5.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Plinth.Logging.NLog.AppInsights as a Cake Addin
#addin nuget:?package=Plinth.Logging.NLog.AppInsights&version=1.5.5

// Install Plinth.Logging.NLog.AppInsights as a Cake Tool
#tool nuget:?package=Plinth.Logging.NLog.AppInsights&version=1.5.5

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>
  • 👉 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
  • 👉 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");
  });

👉 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: "/favicon.ico"
  • EnabledPrefixes: A whitelist of url prefixes to enable Request Telemetry. This is null by default. If a list of prefixes is specified, only requests which match will have request telemetry. If there is a conflict between this and DisabledPrefixes, the preference is to disable telemetry.
  • CaptureSqlCommandText: Set to true to have SQL Dependency Telemetry capture the SQL command text sent to the database. Defaults to false.
  • CloudRoleName: See next section
  • CloudRoleInstance: See next section

5. Application Insights Configuration Settings

Values are applied in this order of precedence

  • Connection String (get this from the Azure Portal)

    1. Hardcoded parameter passed in Startup.cs (does not apply to NLog logs)
    2. NLog.config <connectionString>
    3. Environment variable: APPLICATIONINSIGHTS_CONNECTION_STRING
    4. (Obsolete): NLog.config <instrumentationKey>
    5. (Obsolete): Environment variable APPINSIGHTS_INSTRUMENTATIONKEY

  • Cloud Role Name

    1. Hardcoded parameter passed in Startup.cs (does not apply to NLog logs)
    2. NLog.config <cloudRoleName>
    3. Environment variable: APPLICATIONINSIGHTS_CLOUD_ROLENAME

  • Cloud Role Instance

    1. Hardcoded parameter passed in Startup.cs (does not apply to NLog logs)
    2. NLog.config <cloudRoleInstance>
    3. Environment variable: APPLICATIONINSIGHTS_CLOUD_ROLEINSTANCE
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.7.0 66 11/12/2024
1.6.6 73 11/8/2024
1.6.5 209 8/31/2024
1.6.4 62 8/2/2024
1.6.3 150 5/15/2024
1.6.2 179 2/16/2024
1.6.1 2,444 1/5/2024
1.6.0 311 11/30/2023
1.5.10-b186.aca976b4 70 11/30/2023
1.5.9 132 11/29/2023
1.5.9-b174.64153841 79 11/23/2023
1.5.9-b172.dfc6e7bd 67 11/17/2023
1.5.9-b171.4e2b92e2 78 11/4/2023
1.5.8 158 10/23/2023
1.5.7 3,793 7/31/2023
1.5.6 3,348 7/13/2023
1.5.5 194 6/29/2023
1.5.4 581 3/7/2023
1.5.3 261 3/3/2023
1.5.2 509 1/11/2023
1.5.2-b92.7c961f5f 119 1/11/2023
1.5.0 374 11/9/2022
1.5.0-b88.7a7c20cd 105 11/9/2022
1.4.7 3,097 10/20/2022
1.4.6 572 10/17/2022
1.4.5 703 10/1/2022
1.4.4 478 8/16/2022
1.4.3 495 8/2/2022
1.4.2 665 7/19/2022
1.4.2-b80.7fdbfd04 131 7/19/2022
1.4.2-b74.acaf86f5 114 6/15/2022
1.4.1 484 6/13/2022
1.4.0 496 6/6/2022
1.3.8 1,151 4/12/2022
1.3.7 549 3/21/2022
1.3.6 547 3/17/2022
1.3.6-b67.ca5053f3 129 3/16/2022
1.3.6-b66.4a9683e6 124 3/16/2022
1.3.5 587 2/23/2022
1.3.4 892 1/20/2022
1.3.3 329 12/29/2021
1.3.2 500 12/11/2021
1.3.1 362 11/12/2021
1.3.0 381 11/8/2021
1.2.3 1,568 9/22/2021
1.2.2 396 8/20/2021
1.2.1 389 8/5/2021
1.2.0 447 8/1/2021
1.2.0-b37.a54030b9 160 6/24/2021
1.1.6 3,077 3/22/2021
1.1.5 589 3/9/2021
1.1.4 479 2/27/2021
1.1.3 482 2/17/2021
1.1.2 506 2/12/2021
1.1.1 511 2/1/2021
1.1.0 529 12/16/2020
1.1.0-b27.b66c309b 281 11/15/2020
1.0.12 697 10/18/2020
1.0.11 597 10/6/2020

net7.0 support and removed netcoreapp3.1