# LoggerBinary [![CI](https://github.com/tagbase-io/logger-binary/actions/workflows/test.yml/badge.svg)](https://github.com/tagbase-io/logger-binary/actions/workflows/test.yml)

A custom `Logger` formatter for handling binary data.

This formatter is designed to correctly format binary messages. It converts
non-printable binary data into a hexadecimal string representation and can
optionally add a directional indicator (`"< "` or `"> "`) when needed.

## Usage

```elixir
def deps do
  [
    {:logger_binary, "~> 0.2.0"}
  ]
end
```

```elixir
config :logger, LoggerBinary.Formatter, format: "[$level] $message\n"

config :logger, :console,
  format: {LoggerBinary.Formatter, :format},
  metadata: [:direction]
```

## Features

* Formats binary data as uppercase hexadecimal strings via `LoggerBinary.format/1`.
* Prepends formatted binary messages with a directional indicator if the `:direction`
  metadata is present. Supported values for the `:direction` metadata are `:in` and `:out`.
* Uses the default Logger format for all other types of messages (e.g., printable strings and charlists).

## Direction Indicator

You can add the `:direction` metadata to your log messages to indicate if the
binary data is an incoming or outgoing message:

```elixir
Logger.debug(<<0x01, 0x02, 0x03>>, direction: :in)
# Logs: "[debug] < 01 02 03"

Logger.debug(<<0x01, 0x02, 0x03>>, direction: :out)
# Logs: "[debug] > 01 02 03"
```

Without directional metadata, it simply logs the formatted binary:

```elixir
Logger.debug(<<0x01, 0x02, 0x03>>)
# Logs: "[debug] 01 02 03"
```

## Direct Formatting

You can also format binary data directly without logging:

```elixir
LoggerBinary.format(<<0xDE, 0xAD, 0xBE, 0xEF>>)
# Returns: "DE AD BE EF"

LoggerBinary.format(:timeout)
# Returns: ":timeout"
```