Implements :gen_event behaviour, handles incoming Logger messages.

Usage

Add the following to your config.exs:

config :logger
  backends: [..., LogflareEx.LoggerBackend]

You can then log as per normal:

require Logger
Logger.info("some event", my: "data")

Configuration

There are 3 levels of configuration available, and these are listed in priority order:

1. Runtime Logger configuration, such as Logger.configure(...)
2. Module level configuration via config.exs, such as config :logflare_ex, Elixir.LogflareEx.LoggerBackend, source_token: ...
3. Application level configuration via config.exs, such asconfig :logflare_ex, source_token: ...

Options will then be merged together, with each level overriding the previous.

Metadata

To add custom metadata, use Logger.metadata/1

Logger.metadata(some: "data")

On the payload sent to Logflare API, the above metadata will be merged into the metadata field, resulting in the following schema path metadata.some.

Any additional Logger metadata provided in the Logger.info/2 call will be merged together by Logger. This merging is not handled by the library.

This backend also enriches the log event with certaon fields:

• metadata.context - context of the log event, including vm information, pid, module, etc.
• metadata.level - log level, corresponding to the Logger level set.
• metadata.stacktrace - stacktrace of the error, if the event is an error.

JSON-Encoding Conversions

To ensure that payload sent to Logflare API is JSON serializable and searchable by the selected backend, certain conversions are applied to the terms received.

• atoms are converted to strings. For example, :value to "value".
• charlists are converted to strings For example, 'value' to "value".
• tuples converted to lists For example, {1, 2} to [1, 2].
• keyword lists converted to maps For example, [my: :value] to %{"my"=> "value"}.
• structs converted to maps For example, %MyStruct{} to %{some: "default key"}.
• NaiveDateTime and DateTime are converted using the String.Chars protocol For example, %NaiveDateTime{} to 1337-04-19 00:00:00.
• pids are converted to strings For example, #PID<0.109.0> to "<0.109.0>"