v3.1.1

• #​1977 - don't stack overflow when disposing ReusableStringWriter with large renderings (@​nblumhardt)

This is a bugfix for release 3.1.0.

v3.1.0

• #​1935 - remove CHANGES.md (@​sungam3r)
• #​1936, #​1922 - README.md updates (@​nblumhardt)
• #​1942 - remove redundant GetTypeInfo() calls (@​SimonCropp)
• #​1947 - message template caching performance improvements (@​epeshk)
• #​1948 - reduce allocations in Logger.Write() (@​epeshk)
• #​1955 breaking - collect and propagate Activity.Current.TraceId and SpanId automatically in Logger.Write() (@​nblumhardt)
• #​1964 - don't cache reusable string writers with large buffer sizes (@​Jakimar)
• #​1969 - README.md updates (@​bartelink)
• #​1971 - drop test coverage for unsupported .NET Core versions (@​bartelink)

Built-in trace and span id support

This release adds two new first-class properties to LogEvent: TraceId and SpanId. These are set automatically in Logger.Write() to the corresponding property values from System.Diagnostics.Activity.Current.

The major benefit of this change is that sinks, once updated, can reliably propagate trace and span ids through to back-ends that support them (in much the same way that first-class timestamps, messages, levels, and exceptions are used today).

The sinks maintained under serilog/serilog, along with formatting helpers such as Serilog.Formatting.Compact and Serilog.Expressions, are already compatible with this change or have pending releases that add compatibility.

Dropped .NET Core 2.1 and 3.0 support

On .NET Core 2.1 and 3.0, projects targeting Serilog 3.1+ will fail to build, with:

/project/packages/system.runtime.compilerservices.unsafe/6.0.0/buildTransitive/netcoreapp2.0
/System.Runtime.CompilerServices.Unsafe.targets(4,5): error : System.Runtime.CompilerServices.Unsafe
doesn't support netcoreapp2.1. Consider updating your TargetFramework to netcoreapp3.1 or later.

Affected consumers should continue to use Serilog 3.0 or earlier. See https://github.com/serilog/serilog/issues/1983 for a discussion of this issue.

Technical breaking change

Trace and span id collection includes support for {TraceId} and {SpanId} placeholders in output templates (commonly used when formatting text log files). Where previously these names resolved to user-defined properties, they now resolve to the built-in LogEvent.TraceId and LogEvent.SpanId values, respectively.

Impact is expected to be low/zero, because the trace and span id values in any user-added properties are almost certainly identical to the built-in ones.

v3.0.1

• #​1926 - fix JsonFormatter output for renderMessage = true (@​nblumhardt)

v3.0.0

What's new in 3.0.0?

Target framework changes - Serilog no longer targets netstandard1.x or .NET Framework versions earlier than .NET 4.6.2. Users on affected frameworks should continue to target Serilog 2.12.x.

Removed obsolete APIs - Many deprecated/obsolete types and functions have been removed. Notably, JsonFormatter can no longer be subclassed (either port to JsonValueFormatter, use Serilog.Expressions, or copy the original JsonFormatter code into your project).

Added APIs - LevelAlias.Off is now provided as an equivalent to Microsoft.Extensions.Logging's LogLevel.Off; Destructure.AsDictionary<T>() can now be used to mark dictionary types.

Fewer allocations on many hot paths - A lot of work has gone into avoiding heap allocations wherever possible.

Changes

• Change exception message by @​sungam3r in https://github.com/serilog/serilog/pull/1762
• Avoided IEnumerator allocation (#​1769) by @​igor84 in https://github.com/serilog/serilog/pull/1770
• Avoid iterator allocations when working with SequenceValue by @​sungam3r in https://github.com/serilog/serilog/pull/1785
• Add API approval test by @​sungam3r in https://github.com/serilog/serilog/pull/1783
• Bump Newtonsoft.Json from 13.0.1 to 13.0.2 in /test/Serilog.Tests by @​dependabot in https://github.com/serilog/serilog/pull/1787
• Introduce ScalarValue.Null by @​sungam3r in https://github.com/serilog/serilog/pull/1774
• Tokens -> TokenArray by @​sungam3r in https://github.com/serilog/serilog/pull/1778
• Drop netstandard1.3 and netstandard1.0 support by @​SimonCropp in https://github.com/serilog/serilog/pull/1807
• Remove JsonFormatter.Escape by @​SimonCropp in https://github.com/serilog/serilog/pull/1804
• Use WriteLine(char) by @​SimonCropp in https://github.com/serilog/serilog/pull/1803
• Remove extension of JsonFormatter by subclassing by @​SimonCropp in https://github.com/serilog/serilog/pull/1801
• Remove redundant overrides from LoggerSinkConfiguration by @​SimonCropp in https://github.com/serilog/serilog/pull/1800
• Avoid StringWriter.ToString() calls by @​sungam3r in https://github.com/serilog/serilog/pull/1782
• Remove the obsolete RawFormatter type by @​nblumhardt in https://github.com/serilog/serilog/pull/1808
• .NET 7 SDK by @​SimonCropp in https://github.com/serilog/serilog/pull/1806
• Remove OutputProperties.GetOutputProperties() by @​SimonCropp in https://github.com/serilog/serilog/pull/1805
• Verify API by @​SimonCropp in https://github.com/serilog/serilog/pull/1809
• Remove redundant nullable suppressions by @​SimonCropp in https://github.com/serilog/serilog/pull/1810
• Remove duplicate Where() calls in FindConfigurationMethods() by @​SimonCropp in https://github.com/serilog/serilog/pull/1812
• Remove net45 support by @​SimonCropp in https://github.com/serilog/serilog/pull/1811
• Remove redundant GetTypeInfo() in LoadConfigurationAssemblies by @​SimonCropp in https://github.com/serilog/serilog/pull/1817
• Remove GetTypeInfo() from FindConfigurationMethods(() by @​SimonCropp in https://github.com/serilog/serilog/pull/1815
• Remove redundant GetTypeInfo() in EnumScalarConversionPolicy by @​SimonCropp in https://github.com/serilog/serilog/pull/1816
• Remove obsolete PropertyToken constructor by @​SimonCropp in https://github.com/serilog/serilog/pull/1819
• switch expressions by @​SimonCropp in https://github.com/serilog/serilog/pull/1818
• Do not allocate strings for TextWriter.Write() by @​sungam3r in https://github.com/serilog/serilog/pull/1775
• Simplify reflection in SettingValueConversions by @​SimonCropp in https://github.com/serilog/serilog/pull/1814
• Improve GetPropertiesRecursive() performance by @​SimonCropp in https://github.com/serilog/serilog/pull/1813
• Use Convert.ToHexString() in ByteArrayScalarConversionPolicy() by @​sungam3r in https://github.com/serilog/serilog/pull/1776
• Remove FEATURE_ASYNCLOCAL by @​SimonCropp in https://github.com/serilog/serilog/pull/1822
• Remove FEATURE_HASHTABLE by @​SimonCropp in https://github.com/serilog/serilog/pull/1823
• Use IsEnum for enum check in EnumScalarConversionPolicy by @​SimonCropp in https://github.com/serilog/serilog/pull/1825
• Comments on Hashtable use in MessageTemplateCache by @​SimonCropp in https://github.com/serilog/serilog/pull/1828
• Remove GetTypeInfo() from PropertyValueConverter by @​SimonCropp in https://github.com/serilog/serilog/pull/1824
• Avoid repeated GetType() in PropertyValueConverter by @​SimonCropp in https://github.com/serilog/serilog/pull/1832
• Leverage dictionary TryAdd() and items constructor by @​SimonCropp in https://github.com/serilog/serilog/pull/1830
• Use array instead of list when we know the size in PropertyValueConverter by @​SimonCropp in https://github.com/serilog/serilog/pull/1831
• Move net46 target to net461 by @​SimonCropp in https://github.com/serilog/serilog/pull/1827
• Clean up JsonValueFormatter by @​SimonCropp in https://github.com/serilog/serilog/pull/1835
• var in JsonFormatter by @​SimonCropp in https://github.com/serilog/serilog/pull/1838
• Remove obsolete SelfLog.Out by @​SimonCropp in https://github.com/serilog/serilog/pull/1837
• Remove obsolete JsonFormatter omitEnclosingObject overload by @​SimonCropp in https://github.com/serilog/serilog/pull/1834
• Remove obsolete PushProperties() by @​SimonCropp in https://github.com/serilog/serilog/pull/1836
• No point putting _minimumLevel and _levelSwitch on stack by @​SimonCropp in https://github.com/serilog/serilog/pull/1840
• Avoid casting enum to int where possible by @​SimonCropp in https://github.com/serilog/serilog/pull/1841
• Leverage nullable char in JsonFormatter by @​SimonCropp in https://github.com/serilog/serilog/pull/1839
• Use correct overload with char in JsonFormatter by @​sungam3r in https://github.com/serilog/serilog/pull/1842
• Annotate Serilog for trimming by @​agocke in https://github.com/serilog/serilog/pull/1690
• Fix net471 DisableImplicitFrameworkReferences by @​SimonCropp in https://github.com/serilog/serilog/pull/1846
• Fix 461 TargetFramework constants in tests by @​SimonCropp in https://github.com/serilog/serilog/pull/1847
• Missing API approval by @​SimonCropp in https://github.com/serilog/serilog/pull/1848
• net471 supports ITuple by @​SimonCropp in https://github.com/serilog/serilog/pull/1849
• Remove FEATURE_GETCURRENTMETHOD const by @​SimonCropp in https://github.com/serilog/serilog/pull/1851
• macOS CI by @​SimonCropp in https://github.com/serilog/serilog/pull/1858
• Run tests on mac by @​SimonCropp in https://github.com/serilog/serilog/pull/1860
• BenchmarkDotNet 0.13.5 by @​SimonCropp in https://github.com/serilog/serilog/pull/1861
• Cache empty text token by @​SimonCropp in https://github.com/serilog/serilog/pull/1859
• Simplify PublicApi_Should_Not_Change_Unintentionally() test by @​SimonCropp in https://github.com/serilog/serilog/pull/1864
• Move from net461 to net462 by @​SimonCropp in https://github.com/serilog/serilog/pull/1863
• Remove redundant GetPackagingOutputs by @​SimonCropp in https://github.com/serilog/serilog/pull/1867
• Use char delimiters by @​SimonCropp in https://github.com/serilog/serilog/pull/1868
• Remove redundant reference assemblies by @​SimonCropp in https://github.com/serilog/serilog/pull/1866
• Introduce PolySharp by @​sungam3r in https://github.com/serilog/serilog/pull/1845
• Missing PolySharp changes by @​SimonCropp in https://github.com/serilog/serilog/pull/1869
• Simplify build scripts by @​SimonCropp in https://github.com/serilog/serilog/pull/1865
• Added ReusableStringWriter by @​igor84 in https://github.com/serilog/serilog/pull/1771
• PublicApiGenerator v11 by @​SimonCropp in https://github.com/serilog/serilog/pull/1877
• Use langword in XML comments by @​sungam3r in https://github.com/serilog/serilog/pull/1871
• Avoid creating SafeAggregateSink wrapper around empty list by @​sungam3r in https://github.com/serilog/serilog/pull/1878
• Remove obsolete classes by @​sungam3r in https://github.com/serilog/serilog/pull/1874
• Add space settings by @​sungam3r in https://github.com/serilog/serilog/pull/1885
• Make Alignment and LevelOverrides readonly by @​sungam3r in https://github.com/serilog/serilog/pull/1884
• Remove redundant CallerArgumentExpressionAttribute by @​SimonCropp in https://github.com/serilog/serilog/pull/1886
• Remove MessageTemplateToken.StartIndex by @​SimonCropp in https://github.com/serilog/serilog/pull/1882
• Microsoft.NET.Test.Sdk 17.5.0 by @​SimonCropp in https://github.com/serilog/serilog/pull/1862
• Throw, rather than exit, when any command in the build script fails by @​nblumhardt in https://github.com/serilog/serilog/pull/1887
• Suppress some warnings, tidy up some namespacing by @​nblumhardt in https://github.com/serilog/serilog/pull/1888
• Reinstate LoggerSinkConfiguration.Sink(ILogEventSink, LogEventLevel) by @​nblumhardt in https://github.com/serilog/serilog/pull/1889
• Avoid some alloc with Array.Empty by @​SimonCropp in https://github.com/serilog/serilog/pull/1898
• Destructure ReadOnlyDictionary as Dictionary by @​sungam3r in https://github.com/serilog/serilog/pull/1897
• Remove redundant IDictionary cast by @​SimonCropp in https://github.com/serilog/serilog/pull/1900
• Adding ability to dispose nested loggers in WriteTo.Logger() by @​srogovtsev in https://github.com/serilog/serilog/pull/1890
• Optimize AddPropertyIfAbsent by @​sungam3r in https://github.com/serilog/serilog/pull/1872
• Accept/pass through the standard levelSwitch option in WriteTo.Logger() by @​nblumhardt in https://github.com/serilog/serilog/pull/1902
• Add net47 target by @​SimonCropp in https://github.com/serilog/serilog/pull/1905
• Annotate WithProperty() by @​sungam3r in https://github.com/serilog/serilog/pull/1907
• Add LoggingLevelSwitch.MinimumLevelChanged by @​sungam3r in https://github.com/serilog/serilog/pull/1908
• Fix #​1464, don't log parameter count mismatch message incorrectly by @​nblumhardt in https://github.com/serilog/serilog/pull/1903
• Add Destructure.AsDictionary<T>() by @​sungam3r in https://github.com/serilog/serilog/pull/1906
• Add LevelAlias.Off; fixes #​1684 by @​nblumhardt in https://github.com/serilog/serilog/pull/1910
• Use JsonValueFormatter to implement classic JsonFormatter by @​nblumhardt in https://github.com/serilog/serilog/pull/1911
• Include README.md in the NuGet package for display on nuget.org by @​nblumhardt in https://github.com/serilog/serilog/pull/1916