Plinth.Logging.NLog.AppInsights 1.5.9-b172.dfc6e7bd

Prefix Reserved

This is a prerelease version of Plinth.Logging.NLog.AppInsights.

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.9-b172.dfc6e7bd

NuGet\Install-Package Plinth.Logging.NLog.AppInsights -Version 1.5.9-b172.dfc6e7bd

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.9-b172.dfc6e7bd" />

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.9-b172.dfc6e7bd

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Plinth.Logging.NLog.AppInsights, 1.5.9-b172.dfc6e7bd"

#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.9-b172.dfc6e7bd&prerelease

// Install Plinth.Logging.NLog.AppInsights as a Cake Tool
#tool nuget:?package=Plinth.Logging.NLog.AppInsights&version=1.5.9-b172.dfc6e7bd&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Microsoft.ApplicationInsights (>= 2.21.0)
- Microsoft.ApplicationInsights.AspNetCore (>= 2.21.0)
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- Plinth.Common (>= 1.5.9-b172.dfc6e7bd)
- Plinth.Logging.NLog (>= 1.5.9-b172.dfc6e7bd)
net7.0
- Microsoft.ApplicationInsights (>= 2.21.0)
- Microsoft.ApplicationInsights.AspNetCore (>= 2.21.0)
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- Plinth.Common (>= 1.5.9-b172.dfc6e7bd)
- Plinth.Logging.NLog (>= 1.5.9-b172.dfc6e7bd)

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	88	11/12/2024
1.6.6	84	11/8/2024
1.6.5	261	8/31/2024
1.6.4	67	8/2/2024
1.6.3	155	5/15/2024
1.6.2	184	2/16/2024
1.6.1	2,467	1/5/2024
1.6.0	316	11/30/2023
1.5.10-b186.aca976b4	73	11/30/2023
1.5.9	137	11/29/2023
1.5.9-b174.64153841	82	11/23/2023
1.5.9-b172.dfc6e7bd	70	11/17/2023
1.5.9-b171.4e2b92e2	81	11/4/2023
1.5.8	163	10/23/2023
1.5.7	3,957	7/31/2023
1.5.6	3,427	7/13/2023
1.5.5	199	6/29/2023
1.5.4	586	3/7/2023
1.5.3	266	3/3/2023
1.5.2	514	1/11/2023
1.5.2-b92.7c961f5f	122	1/11/2023
1.5.0	379	11/9/2022
1.5.0-b88.7a7c20cd	108	11/9/2022
1.4.7	3,102	10/20/2022
1.4.6	577	10/17/2022
1.4.5	708	10/1/2022
1.4.4	483	8/16/2022
1.4.3	500	8/2/2022
1.4.2	670	7/19/2022
1.4.2-b80.7fdbfd04	134	7/19/2022
1.4.2-b74.acaf86f5	117	6/15/2022
1.4.1	489	6/13/2022
1.4.0	501	6/6/2022
1.3.8	1,158	4/12/2022
1.3.7	556	3/21/2022
1.3.6	552	3/17/2022
1.3.6-b67.ca5053f3	132	3/16/2022
1.3.6-b66.4a9683e6	127	3/16/2022
1.3.5	592	2/23/2022
1.3.4	897	1/20/2022
1.3.3	334	12/29/2021
1.3.2	505	12/11/2021
1.3.1	367	11/12/2021
1.3.0	386	11/8/2021
1.2.3	1,573	9/22/2021
1.2.2	401	8/20/2021
1.2.1	394	8/5/2021
1.2.0	452	8/1/2021
1.2.0-b37.a54030b9	163	6/24/2021
1.1.6	3,082	3/22/2021
1.1.5	594	3/9/2021
1.1.4	486	2/27/2021
1.1.3	487	2/17/2021
1.1.2	511	2/12/2021
1.1.1	516	2/1/2021
1.1.0	534	12/16/2020
1.1.0-b27.b66c309b	284	11/15/2020
1.0.12	702	10/18/2020
1.0.11	602	10/6/2020

net7.0 support and removed netcoreapp3.1