NLog 4.5.0

NLog is a logging platform for .NET with rich log routing and management capabilities.

Install-Package NLog -Version 4.5.0

dotnet add package NLog --version 4.5.0

<PackageReference Include="NLog" Version="4.5.0" />

paket add NLog --version 4.5.0

#r "nuget: NLog, 4.5.0"

Release Notes

NLog 4.5 adds structured logging and .NET Standard support/UPW without breaking changes! Also a lot features has been added!


List of important changes in NLog 4.5

**Features:**

- Support for .Net Standard 2.0 [#2263] + [#2402] (@snakefoot)
- Support for .Net Standard 1.5 [#2341] (@snakefoot)
- Support for .Net Standard 1.3 (and UWP) [#2441] + [#2597] (Remember to manually flush on app suspend). (@snakefoot)
- Introduced Structured logging [#2208] + [#2262] + [#2244] + [#2544] (@snakefoot, @304NotModified, @jods4, @nblumhardt) - see https://github.com/NLog/NLog/wiki/How-to-use-structured-logging
- Json conversion also supports object properties [#2179],  [#2555] (@snakefoot, @304NotModified)
- event-properties layout-renderer can now render objects as json [#2241] (@snakefoot, @304NotModified)
- exception layout-renderer can now render exceptions as json [#2357] (@snakefoot)
- Default file archive logic is now easier to use [#1993] (@snakefoot)
- Introduced InstallationContext.ThrowExceptions [#2214] (@rbarillec)
- WebServiceTarget - Allow configuration of proxy address [#2375] (@snakefoot)
- WebServiceTarget - JsonPost with JsonLayout without being wrapped in parameter [#2590] (@snakefoot)
- ${guid}, added GeneratedFromLogEvent [#2226] (@snakefoot)
- TraceTarget RawWrite to always perform Trace.WriteLine independent of LogLevel [#1968] (@snakefoot)
- Adding OverflowAction options to BufferingTargetWrapper [#2276] (@mikegron)
- WhenRepeatedFilter - Filtering of identical LogEvents  [#2123] + [#2297] (@snakefoot)
- ${callsite} added CleanNamesOfAsyncContinuations option [#2292] (@tkhaugen, @304NotModified)
- ${ndlctiming} allows timing of ndlc-scopes [#2377] (@snakefoot)
- NLogViewerTarget - Enable override of the Logger-name [#2390] (@snakefoot)
- ${sequenceid} added [#2411] (@MikeFH)  
- Added "regex-matches" for filtering [#2437] (@MikeFH)
- ${gdc}, ${mdc} & {mdlc} - Support Format parameter [#2500] (@snakefoot)
- ${currentDir} added [#2491] (@UgurAldanmaz)
- ${AssemblyVersion}: add type (File, Assembly, Informational) option [#2487] (@alexangas)
- FileTarget: Support byte order mark [#2456] (@KYegres)
- TargetWithContext - Easier to create custom NLog targets with support for MDLC and NDLC [#2467] (@snakefoot)
- ${callname-filename} - Without line number [#2591] (@brunotag)
- MDC + MDLC with SetScoped property support  [#2592] (@MikeFH)
- LoggingConfiguration AddRule includes final-parameter [#2612] (@893949088)

**BugFixes:**
- Improve archive stability during concurrent file access [#1889] (@snakefoot)
- FallbackGroup could lose log events [#2265] (@frabar666)
- ${exception} - only include separator when items are available [#2257] (@jojosardez)
- LogFactory - Fixes broken EventArgs for ConfigurationChanged [#1897] (@snakefoot)
- Do not report wrapped targets as unused targets [#2290] (@thesmallbang)
- Added IIncludeContext, implemented missing properties [#2117] (@304NotModified)
- Improve logging of callsite linenumber for async-methods [#2386] (@snakefoot)
- NLogTraceListener - DisableFlush is enabled by default when AutoFlush=true [#2407] (@snakefoot)
- NLogViewer - Better defaults for connection limits [#2404] (@304NotModified)
- LoggingConfiguration.LoggingRules is not thread safe [#2393], [#2418]
- Fix XmlLoggingConfiguration reloading [#2475] (@snakefoot)
- Database Target now supports EntityFramework ConnectionStrings [#2510] (@Misiu, @snakefoot)
- LoggingConfiguration.RemoveTarget now works while actively logging [#2549] (@jojosardez, @snakefoot)
- FileTarget does not fail on platforms without global mutex support [#2604] (@snakefoot)
- LoggingConfiguration does not fail when AutoReload is not possible on the platforms without FileWatcher [#2603]  (@snakefoot)

**Performance:**
- More targets has OptimizeBufferReuse enabled by default [#1913] + [#1923] + [#1912] + [#1911] + [#1910] + [#1909] + [#1908] + [#1907] + [#2560]   (@snakefoot)
- StringBuilderPool - Improved Layout Render Performance by reusing StringBuilders [#2208]   (@snakefoot)
- JsonLayout - Improved Layout Performance, by optimizing use of StringBuilder [#2208]   (@snakefoot)
- FileTarget - Faster byte-encoding of log messsages, by using crude Encoding.GetMaxByteCount() instead of exact Encoding.GetByteCount() [#2208] (@snakefoot)
- Target - Precalculate Layout should ignore sub-layouts for complex layout (Ex Json) [#2378]  (@snakefoot)
- MessageLayoutRenderer - Skip `string.Format` allocation (for caching) when writing to a single target, instead format directly into output buffer. [#2507]  (@snakefoot)

for full list, see https://github.com/NLog/NLog/blob/master/CHANGELOG.md

for what is supported in each platform, see https://github.com/NLog/NLog/wiki/platform-support

Dependencies

• .NETFramework 3.5

  • No dependencies.

• .NETFramework 4.0 Client

  • No dependencies.

• .NETFramework 4.5

  • No dependencies.

• .NETStandard 1.3

  • Microsoft.Extensions.PlatformAbstractions (>= 1.0.0)
  • NETStandard.Library (>= 1.6.0)
  • System.Collections.NonGeneric (>= 4.0.1)
  • System.ComponentModel.Primitives (>= 4.1.0)
  • System.Data.Common (>= 4.1.0)
  • System.Diagnostics.StackTrace (>= 4.0.1)
  • System.Net.NameResolution (>= 4.0.0)
  • System.Net.Requests (>= 4.0.11)
  • System.Reflection.TypeExtensions (>= 4.1.0)
  • System.Xml.XmlDocument (>= 4.0.1)

• .NETStandard 1.5

  • NETStandard.Library (>= 1.6.0)
  • System.ComponentModel.Primitives (>= 4.1.0)
  • System.ComponentModel.TypeConverter (>= 4.1.0)
  • System.Data.Common (>= 4.1.0)
  • System.Diagnostics.Process (>= 4.1.0)
  • System.Diagnostics.StackTrace (>= 4.0.1)
  • System.Diagnostics.TraceSource (>= 4.0.0)
  • System.IO.FileSystem.Watcher (>= 4.0.0)
  • System.Net.NameResolution (>= 4.0.0)
  • System.Net.Requests (>= 4.0.11)
  • System.Reflection.TypeExtensions (>= 4.1.0)
  • System.Runtime.Loader (>= 4.0.0)
  • System.Threading.Thread (>= 4.0.0)
  • System.Xml.XmlDocument (>= 4.0.1)

• .NETStandard 2.0

  • No dependencies.

• MonoAndroid 4.4

  • No dependencies.

• Silverlight 4.0

  • No dependencies.

• Silverlight 5.0

  • No dependencies.

• WindowsPhone 8.0

  • No dependencies.

• Xamarin.iOS 1.0

  • No dependencies.

Used By

NuGet packages (1.9K)

Showing the top 5 NuGet packages that depend on NLog:

Package	Downloads
NLog.Extensions.Logging NLog LoggerProvider for Microsoft.Extensions.Logging for logging in .NET Standard libraries and .NET Core applications. For ASP.NET Core, check: https://www.nuget.org/packages/NLog.Web.AspNetCore	24.8M
NLog.Config NLog.config file to get started with configuring NLog. This package is not mandatory to get started with NLog: the configuration file can created manually (read specs here: https://github.com/NLog/NLog/wiki/Configuration-file) or the configuration can be created programmatically. (read more here: https://github.com/NLog/NLog/wiki/Configuration-API) Note: Unfortunately this package won't work well when using <PackageReference> Advised to: - download manually: https://raw.githubusercontent.com/NLog/NLog/dev/src/NuGet/NLog.Config/content/NLog.config - set "Copy To Output Directory" to "Copy if newer"	11.0M
Microsoft.ApplicationInsights.NLogTarget Application Insights NLog Target is a custom target allowing you to send NLog log messages to Application Insights. Application Insights will collect your logs from multiple sources and provide rich powerful search capabilities. Privacy statement: https://go.microsoft.com/fwlink/?LinkId=512156	4.3M
NLog.Web NLog logging for ASP.NET and ASP.NET MVC. Includes targets and layout renderers for websites and web applications. This package is for ASP.NET 3.5+ For ASP.NET Core: Check https://www.nuget.org/packages/NLog.Web.AspNetCore	3.0M
NLog.Extended NLog.Extended.dll provides MSMQ target and AppSetting renderer	2.4M

GitHub repositories (243)

Showing the top 5 popular GitHub repositories that depend on NLog:

Repository	Stars
shadowsocks/shadowsocks-windows If you want to keep a secret, you must also hide it from yourself.	51.8K
Wox-launcher/Wox Launcher for Windows, an alternative to Alfred and Launchy.	19.7K
files-community/Files A modern file explorer that pushes the boundaries of the platform.	7.4K
JustArchiNET/ArchiSteamFarm C# application with primary purpose of idling Steam cards from multiple accounts simultaneously.	6.3K
Sonarr/Sonarr Smart PVR for newsgroup and bittorrent users.	6.2K

Version History