Skip to content

Latest commit

 

History

History
248 lines (149 loc) · 8.85 KB

CHANGELOG.md

File metadata and controls

248 lines (149 loc) · 8.85 KB
Raw

Change Log

All notable changes to this project will be documented in this file.

This project adheres to Semantic Versioning and is following Keep a CHANGELOG.

Unreleased

[10.0.0] - 2024-04-03

⚡ Added

  • Support for .NET Framework 4.6.2

💉 Fixed

  • #196 Sink does not work well with other sinks due to dependency version mismatch. (discovered by @sergey-messer)

💀 Removed

[9.0.0] - 2023-10-19

⚡ Added

  • [BREAKING CHANGE] Support for specifying UDP datagram encoding (contributed by @pedoc)
  • [BREAKING CHANGE] Support for broadcast packages (contributed by @dnatov)

[8.0.1] - 2022-11-20

💫 Changed

  • Update dependencies

[8.0.0] - 2022-03-26

💀 Removed

[7.1.0] - 2020-10-19

⚡ Added

[7.0.1] - 2020-08-14

💉 Fixed

  • Configure SourceLink to embed untracked sources
  • Configure SourceLink to use deterministic builds when running on AppVeyor

[7.0.0] - 2020-03-09

💉 Fixed

  • #73 [BREAKING CHANGE] Leading and trailing white-space characters are no longer removed from the payload before being sent over the network, thus respecting output templates that use those characters. (discovered by @tagcode)

[6.0.0] - 2019-07-08

💉 Fixed

  • #42 Revert to support IPv4 on networks without IPv6 (contribution by brettdavis-bmw)
  • #45 Correctly XML escape exception message serialized by Log4jTextFormatter
  • #51 Correctly XML escape all properties serialized by Log4jTextFormatter and Log4netTextFormatter

💫 Changed

  • [BREAKING CHANGE] The API for creating a sink has changed. The sink was originally intended for IPv4 addresses, but has along the way gotten support for host names and IPv6 addresses. These changes calls for a small redesign of the API, benefiting the majority of the consumers using application settings instead of code configuration. The following chapters will describe your migration path.

Migrate sink created by code

Lets assume you have configured the sink using code, and your code looks something like this.

Serilog.ILogger log = new LoggerConfiguration()
  .MinimumLevel.Verbose()
  .WriteTo.Udp(IPAddress.Loopback, 7071)
  .CreateLogger();

The Udp extension is no longer accepting IPAddress as first argument, and you are now required to specify the address family your remote address is targeting. Lets change the code above to conform to the new API.

Serilog.ILogger log = new LoggerConfiguration()
  .MinimumLevel.Verbose()
  .WriteTo.Udp("localhost", 7071, AddressFamily.InterNetwork)
  .CreateLogger();

Migrate sink created by application settings

Lets assume you have configured the sink using application settings, and your configuration looks something like this.

{
  "Serilog": {
    "MinimumLevel": "Verbose",
    "WriteTo": [
      {
        "Name": "Udp",
        "Args": {
          "remoteAddress": "localhost",
          "remotePort": 7071
        }
      }
    ]
  }
}

You are now required to specify the address family your remote address is targeting. Lets change the configuration above to conform to the new API.

{
  "Serilog": {
    "MinimumLevel": "Verbose",
    "WriteTo": [
      {
        "Name": "Udp",
        "Args": {
          "remoteAddress": "localhost",
          "remotePort": 7071,
          "family": "InterNetwork"
        }
      }
    ]
  }
}

[5.0.1] - 2019-01-07

⚡ Added

[5.0.0] - 2018-09-13

💉 Fixed

Breaking change

Please note that this release contains breaking changes. UDP packages are now sent using a socket in dual mode, which tunnels IPv4 traffic over IPv6. For more information regarding dual mode, please see the ASP.NET blog. For questions regarding operating systems and IPv6 support, please see the comparison of IPv6 support in operating systems.

[4.1.0] - 2018-06-06

⚡ Added

[4.0.1] - 2018-01-29

💉 Fixed

  • #21 Invalid XML generated by Log4jTextFormatter and Log4netTextFormatter

💀 Removed

  • Support for .NET Standard 2.0 since the sink also has support for .NET Standard 1.3

[4.0.0] - 2017-11-09

⚡ Added

  • [BREAKING CHANGE] Option to specify a logging level switch (contribution by Gian Maria)

[3.3.0] - 2017-09-13

⚡ Added

  • Text formatter compliant with log4net XML schema, thus compatible with Log4View (contribution by Johan van Rhyn)

[3.2.0] - 2017-08-26

⚡ Added

  • Text formatter compliant with log4j XML schema, thus compatible with Log2Console

[3.1.0] - 2017-08-20

⚡ Added

  • Support for .NET Core 2.0

[3.0.0] - 2017-05-02

⚡ Added

  • Full parity between code and JSON configuration of sink by introducing Serilog.Settings.Configuration support for extension method Udp(IPAddress remoteAddress, int remotePort, ITextFormatter formatter, int localPort, LogEventLevel restrictedToMinimumLevel).

💫 Changed

  • [BREAKING CHANGE] Renamed argument remoteAddressAsString to remoteAddress. JSON configuration using Serilog.Settings.Configuration will have to be updated accordingly.

[2.3.1] - 2017-04-24

💉 Fixed

  • Package project URL

[2.3.0] - 2017-04-14

⚡ Added

[2.2.0] - 2017-03-16

⚡ Added

[2.1.0] - 2016-11-01

⚡ Added

  • Support for specifying a log event formatter

[2.0.0] - 2016-10-31

⚡ Added

  • [BREAKING CHANGE] Support for Serilog 2.0.0
  • Support for .NET Standard 1.5

[1.1.0] - 2016-01-19

⚡ Added

  • Support for Serilog v1.5.14.

[1.0.1] - 2015-03-30

💉 Fixed

  • URL to NuGet package icon.

[1.0.0] - 2015-03-26

Initial version.