Changelog

View Source

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

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

main

v7.0.0

This is a big release full of massive performance improvements and protocol compliance, but also of breaking changes. Read carefully the changelog and the documentation before migrating.

Changed

The application is now divided in three core subsystems, that is, listeners, packet pipelines, and zones, which are configured differently and will require migration. See erldns_listeners. erldns_pipeline and erldns_zones respectively for documentation on how to reconfigure.

Telemetry events, as well as logger events, are entirely scoped within these respective subsystems, that means, that the events are now prefixed with [erldns, request, _], for listener workers, and [erldns, pipeline] for pipeline processing. Similarly, logger events are tagged with domain => [erldns, admin | listeners | pipeline | zones] metadata, and all are structured.

Custom parsers and encoders

If you had any custom parser or encoder, you will need to update them to the new API, which unifies both into a single module. See erldns_zone_codec for more information on its callbacks. Note that the zone_to_erlang/1,2 callbacks are now decode/1 and zone_*/x callbacks are now encode/2, and they all take only maps as input and output respectively.

TXT and SPF record formats

TXT and SPF record formats has changed, from a single string, to an array, to support more complex DNS records & use cases, so that the following:

{
  ...
  "type": "TXT",
  "data": {
    "txt": "\"Hi, this is some text\" \"with extras\""
  }
},

becomes

{
  ...
  "type": "TXT",
  "data": {
    "txts": ["Hi, this is some text", "with extras"]
  }
},

A warning will be logged for each invalid record, but they will be skipped, and not loaded.

For more important changes, see:

  • Refactor the query processing pipeline #224
  • Reimplement the network stack #225
  • Rework zones loader #230
  • Rework zones codecs #231
  • Rework zones cache #232
  • Rework documentation and internals #233
  • Fix overriding packet size in optrr record #242
  • Upgrade dns_erlang to v4.
  • Use segmented_cache for the zone cache and the throttle modules.

Added

  • Support for OTP28 #220
  • Support for dns_erlang v4, which enforces strings as binaries and options as maps
  • Introduce domain tag in logger events #244
  • zone cache put_rrset_zone accepts zone records #243
  • Add statistic functionality to listeners #227

Removed

  • Support for TXT and SPF records with data as a single string, they must be a list of strings instead.
  • Support for the erldns_txt parser #248
  • Support for zone parsers taking input as lists #231

Fixed

  • Fix DNSSEC timestamps #234
  • Fix (C)DNS/(C)DNSKEY signing #235
  • Fix cache non-normalised match bug #241

Security

  • Introduce backpressure and load shedding #240

6.0.2

  • Add mailbox length telemetry events.
  • Keep the handlers state in an ets table and avoid the singleton gen_server call.

6.0.1

  • Add terminating context to telemetry span events

6.0.0

  • Instrument code using telemetry in a metrics agnostic way.

5.0.0

  • Introduce support for Logger
  • Remove lager
  • Remove the erldns_events singleton.

4.3.1

  • Export dnssec internal new API endpoint

4.3.0

  • Add support for NSEC compact denial of existence

4.2.4

  • Add support for zone records directory loading
  • Add the latest dnstest version fixing almost all tests

4.2.3

  • Update dns_erlang: fix EDNS0 compliance for truncated records and unsupported versions

4.2.2

  • Test admin API and fix bugs related to authentication and json encoding

4.2.1

  • Ensure supervision tree starts correctly

4.2.0

  • Merge admin and metrics APIs into this repository.

4.1.2

  • Hide SPF/TXT multipart handling behind a feature flag
  • Fix a bug mixing SPF and TXT records

4.1.1

  • Bugfix handling null in the zone parser json payloads

4.1.0

  • Introduce SPF/TXT multipart handling (#150)

4.0.0

  • Add ex_doc support
  • Remove support for OpenTelemetry.

3.0.0

Changed

Added

  • erlfmt
  • CONTRIBUTING.md
  • CHANGELOG.md
  • release process to hex.pm

2.2.0

  • ...