Returns the default logger.

The default channel Logi.Channel.default_channel/0 which corresponds to the logger is started automatically when logi_ex application was started.

Returns the logger instance associated to logger.

Examples

iex> Logi.ensure_to_be_instance :unsaved
{:logi_logger, :unsaved, %{}, %{}, :undefined, :undefined}

iex> Logi.save :saved, Logi.new([channel: :foo])
iex> Logi.ensure_to_be_instance :foo
{:logi_logger, :foo, %{}, %{}, :undefined, :undefined}

iex> Logi.ensure_to_be_instance Logi.new([channel: :bar])
{:logi_logger, :bar, %{}, %{}, :undefined, :undefined}

Returns the saved loggers and deletes them from the process dictionary.

Examples

iex> Logi.save :foo, Logi.new

iex> Logi.erase
[foo: {:logi_logger, :logi_default_log, %{}, %{}, :undefined, :undefined}]

iex> Logi.erase
[]

Returns the logger associated with logger_id and deletes it from the process dictionary.

Returns :undefined if no logger is associated with logger_id.

Examples

iex> Logi.save :foo, Logi.new
iex> Logi.erase :foo
{:logi_logger, :logi_default_log, %{}, %{}, :undefined, :undefined}

iex> Logi.erase :foo
:undefined

Aggregates loggers into a logger instance.

The head logger in loggers becomes the root of the aggregation. e.g. from_list([new, new, new]) is equivalent to new([next: new([next: new])]).

Creates a new logger instance from map.

Default Values

• channel: Logi.Channel.default_channel
• headers: %{}
• metadata: %{}
• filter: none (optional)
• next: none (optional)

Examples

iex> Logi.to_map(Logi.from_map(%{}))
%{channel: :logi_default_log, headers: %{}, metadata: %{}}

Loads a logger which associated with the ID logger_id from the process dictionary.

Examples

iex> :error = Logi.load :foo_log

iex> Logi.save :foo_log, Logi.new
iex> {:ok, _} = Logi.load :foo_log

Equivalent to Logi.load(Logi.default_logger).

Returns true if x is a logger, otherwise false.

Saves logger with the ID logger_id to the process dictionary.

If logger_id already exists, the old logger instance is deleted and replaced by logger and the function returns the old instance. Otherwise it returns :undefined.

In the process, a saved logger instance can be referred by the ID.

Examples

iex> require Logi

iex> logger = Logi.new
iex> Logi.save :sample_log, logger

# The following two expression is equivalent.
iex> Logi.info "hello world", [], [logger: logger]  # referred by instance
iex> Logi.info "hello world", [], [logger: :sample_log] # referred by ID

Equivalent to Logi.save(Logi.default_logger, logger).

Returns the available severity list.

The list are ordered by the their severity level (see: severity_level/1).

Returns true if x is a severity, otherwise false.

Returns the level of severity.

The higher the severity is, the lower the level is.

Flattens the nested logger.

The nested loggers are collected as a flat list. The next fields of the resulting loggers are removed.

Examples

iex> logger0 = Logi.new
iex> logger1 = Logi.new([next: logger0])
iex> logger2 = Logi.new([next: logger1])
iex> [^logger0] = Logi.to_list(logger0)
iex> [^logger0, ^logger0] = Logi.to_list(logger1)
iex> [^logger0, ^logger0, ^logger0] = Logi.to_list(logger2)

Converts logger into a map form.

The optional entries (i.e. filter and next) will be omitted from the resulting map if the value is not set.

Examples

iex> Logi.to_map(Logi.new)
%{channel: :logi_default_log, headers: %{}, metadata: %{}}

iex> Logi.to_map(Logi.new([next: Logi.new]))
%{channel: :logi_default_log, headers: %{}, metadata: %{},
next: {:logi_logger, :logi_default_log, %{}, %{}, :undefined, :undefined}}

Returns the ID list of the saved loggers.

Examples

iex> Logi.save :foo, Logi.new
iex> Logi.which_loggers
[:foo]