Timber v0.1.2 API Reference

Modules

The functions in this module work by modifying the Logger metadata store which is unique to every BEAM process. This is convenient in many ways. First and foremost, it does not require you to manually manage the metadata. Second, because we conform to the standard Logger principles, you can utilize Timber alongside other Logger backends without issue. Timber prefixes its contextual metadata keys so as not to interfere with other systems

The ContextEntry module formalizes the structure of context stack entries

A custom context can be specified by the user that is specific to the system being logged

The exception context is used to track exceptions

The HTTP request context tracks incoming HTTP requests

The HTTP response context tracks outgoing HTTP responses

The organization context tracks the organization of the currently authenticated user

The SQL Query context tracks SQL query performance

The Server context tracks information about the host your system runs on

Tracks the time to render a template

The LogEntry module formalizes the structure of every log entry

The Logger module is at the heart of Timber’s integration. It specifies a backend that can be used with the standard Logger application distributed with Elixir

Automatically captures context information about HTTP requests and responses in Plug-based frameworks like Phoenix

A Transport specifies the way in which Timber.Logger should actually output log events

The IODevice transport mechanism allows you to log directly to stdout (default; see below) or any other IODevice of your choice

Utility functions for Timber

Exceptions

Error raised when the device being sought is non-existent or otherwise cannot be found or used