ring_logger v0.3.0 RingLogger

Link to this section Summary

Types

Option values used by attach

Functions

Attach the current IEx session to the logger. It will start printing log messages

Callback implementation for c::gen_event.code_change/3

Update the logger configuration

Detach the current IEx session from the logger

Helper method for formatting log messages per the current client’s configuration

Get all log messages at the specified index and later

Callback implementation for c::gen_event.handle_call/2

Callback implementation for c::gen_event.handle_event/2

Callback implementation for c::gen_event.handle_info/2

Callback implementation for c::gen_event.init/1

Reset the index into the log for tail/1 to the oldest entry

Tail the messages in the log

Callback implementation for c::gen_event.terminate/2

Link to this section Types

Link to this type client_option()
client_option() ::
  {:io, term()}
  | {:color, term()}
  | {:metadata, Logger.metadata()}
  | {:format, String.t()}
  | {:level, Logger.level()}

Option values used by attach

Link to this section Functions

Link to this function attach(opts \\ [])
attach([client_option()]) :: :ok

Attach the current IEx session to the logger. It will start printing log messages.

Options include:

  • :io - Defaults to :stdio
  • :colors -
  • :metadata - A KV list of additional metadata
  • :format - A custom format string
  • :level - The minimum log level to report.
Link to this function code_change(old_vsn, state, extra)

Callback implementation for c::gen_event.code_change/3.

Link to this function configure(opts)

Update the logger configuration.

Options include:

  • :max_size - the max number of log messages to store at a time
Link to this function detach()
detach() :: :ok

Detach the current IEx session from the logger.

Link to this function format(message)
format(entry()) :: :ok

Helper method for formatting log messages per the current client’s configuration.

Link to this function get(index \\ 0)
get(non_neg_integer()) :: [entry()]

Get all log messages at the specified index and later.

Link to this function handle_call(arg, state)

Callback implementation for c::gen_event.handle_call/2.

Link to this function handle_event(arg1, state)

Callback implementation for c::gen_event.handle_event/2.

Link to this function handle_info(_, state)

Callback implementation for c::gen_event.handle_info/2.

Callback implementation for c::gen_event.init/1.

Link to this function reset(opts \\ [])
reset([client_option()]) :: [String.t()]

Reset the index into the log for tail/1 to the oldest entry.

Link to this function tail(opts \\ [])
tail([client_option()]) :: [String.t()]

Tail the messages in the log.

Link to this function terminate(reason, state)

Callback implementation for c::gen_event.terminate/2.