Skip to content
This repository was archived by the owner on Dec 8, 2020. It is now read-only.

CHANGELOG.md

Latest commit

 

History

History
83 lines (64 loc) · 3.51 KB

CHANGELOG.md

File metadata and controls

83 lines (64 loc) · 3.51 KB
Raw

Changelog

This covers changes for versions 3.0 and higher. The changelog for 2.x releases can be found in the v2.x branch.

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

Unreleased

3.1.2 - 2019-04-05

Changed

  • The Timber.Formatter no longer prints in a proprietary format with the @metadata delimiter. It not just print simple JSON lines. As such, the Timber.Formatter is not recommended for use in development or test environment unless you want JSON formatted logs.

3.1.1 - 2019-03-16

Changed

  • Added support for the new Timber API keys. The :source_id parameter is now supported when configuring :timber in addition to the :api_key. This does not break backwards compatibility.

3.1.0 - 2019-02-25

Changed

  • Timber.InvalidAPIKeyError is now Timber.Errors.InvalidAPIKeyError
  • Events are no longer nested under the event key.
  • Custom events are no longer nested under the event.custom key, they have simply been moved to the root of the document.
  • Custom contexts are no longer nested under the context.custom key, they have simply been moved to the root of the document.
  • JSON representations of log events no longer include the $schema key since Timber 2.0 does not strictly require a schema anymore.
  • All Timber.Events.* and Timber.Contexts.* structs have been deprecated in favor of simple maps since Timber 2.0 no longer requires a strict schema. Module docs for each module has been updated accordingly.
  • Errors are no longer automatically parsed in the logger backend. Please use the :timber_exceptions library if you'd like to structure errors. This is a proper approach to structuring these events.
  • Handle unencodable content

3.0.0 - 2018-12-20

3.0.0 contains breaking changes, for upgrade instructions see UPGRADING.md

Changed

  • Jason is now used for JSON encoding. The JSON library can no longer be injected via configuration.
  • msgpax 1.x is no longer supported
  • Logs are now sent in batches of 1000 instead of 5000 to comply with the Timber library specification
  • Timber.LoggerBackends.HTTP.TimberAPIKeyInvalid is now Timber.InvalidAPIKeyError

Removed

  • Removed support for Elixir 1.3 and lower
  • Removed integration with Phoenix; use the :timber_phoenix package instead
  • Removed integration with Plug; use the :timber_plug package instead
  • Removed integration with Ecto; use the :timber_ecto package instead
  • Removed integration with ExAws
  • Removed integration with :error_logger; use the :timber_exceptions package instead
  • Removed the installer (mix timber.install); manual installation is now expected
  • Removed the test event Mix task