lager (lager v1.1.0)

Lager API

Summary

Types

boolean_opt(Name)

log_level()

log_level_number()

pr_opt()

Functions

clear_all_traces()

clear_trace_by_destination(Id)

dispatch_log(Severity, MetadataList, Format, Args, TruncSize)

dispatch_log(Sink, Severity, MetadataList, Format, Args, TruncSize, Safety)

dispatch_log(Severity, Module, Function, Line, Pid, MetadataList, Format, Args, TruncSize)

do_log(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold, TraceFilters, SinkPid)

do_log(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold, TraceFilters, Sink, SinkPid)

do_log_unsafe(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold, TraceFilters, Sink, SinkPid)

get_loglevel(Handler)

get_loglevel(Sink, Handler)

get_loglevels(Sink)

install_trace(Pid, Level)

install_trace(Pid, Level, Options)

list_all_sinks()

log/3

log/4

log/5

log_unsafe(Level, MetadataList, Message, Args)

md()

md/1

posix_error(Error)

pr(Value, Module)

pr(Value, Module, Opts)

pr_stacktrace(Stacktrace)

pr_stacktrace/2

remove_trace(Pid)

rotate_all()

rotate_handler(Handler)

rotate_handler(Handler, Sink)

rotate_sink(Sink)

safe_format(Fmt, Args, Limit)

safe_format_chop(Fmt, Args, Limit)

set_loghwm(Handler, Hwm)

set_loghwm(Sink, Handler, Hwm)

set_loghwm(Sink, Handler, Ident, Hwm)

set_loglevel(Handler, Level)

set_loglevel(Handler, Ident, Level)

set_loglevel(Sink, Handler, Ident, Level)

start()

status()

stop_trace/1

stop_trace(Backend, Filter, Level)

trace(Backend, Filter)

trace(Backend, Filter, Level)

trace_console(Filter)

trace_console(Filter, Level)

trace_file(File, Filter)

trace_file(File, Filter, LevelOrOptions)

trace_file(File, Filter, Level, Options)

trace_func(FuncState, Event, ProcState)

trace_state(Pid, Level, Options)

unsafe_format(Fmt, Args)

update_loglevel_config(Sink)

Types

boolean_opt(Name)

-type boolean_opt(Name) :: Name | {Name, boolean()}.

log_level()

-type log_level() :: none | logger:level().

log_level_number()

-type log_level_number() :: 0..7.

pr_opt()

-type pr_opt() :: boolean_opt(compress).

Functions

clear_all_traces()

-spec clear_all_traces() -> no_return().

clear_trace_by_destination(Id)

-spec clear_trace_by_destination(term()) -> no_return().

dispatch_log(Severity, MetadataList, Format, Args, TruncSize)

-spec dispatch_log(Severity, MetadataList, Format, Args, TruncSize) -> ok
                      when
                          Severity :: log_level(),
                          MetadataList :: [{atom(), term()}],
                          Format :: string(),
                          Args :: list(),
                          TruncSize :: non_neg_integer().

dispatch_log(Sink, Severity, MetadataList, Format, Args, TruncSize, Safety)

-spec dispatch_log(Sink, Severity, MetadataList, Format, Args, TruncSize, Safety) -> ok | Error
                      when
                          Sink :: atom(),
                          Severity :: log_level(),
                          MetadataList :: [{atom(), term()}],
                          Format :: string(),
                          Args :: list(),
                          TruncSize :: non_neg_integer(),
                          Safety :: safe | unsafe,
                          Error :: {error, Reason},
                          Reason :: {bad_sink, Sink}.

dispatch_log(Severity, Module, Function, Line, Pid, MetadataList, Format, Args, TruncSize)

-spec dispatch_log(Severity, Module, Function, Line, Pid, MetadataList, Format, Args, TruncSize) -> ok
                      when
                          Severity :: log_level(),
                          Module :: module(),
                          Function :: atom(),
                          Line :: pos_integer(),
                          Pid :: pid(),
                          MetadataList :: [{atom(), term()}],
                          Format :: string(),
                          Args :: list(),
                          TruncSize :: non_neg_integer().

do_log(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold, TraceFilters, SinkPid)

-spec do_log(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold,
             TraceFilters, SinkPid) ->
                ok
                when
                    Severity :: log_level(),
                    MetadataList :: [{atom(), term()}],
                    Format :: string(),
                    Args :: list(),
                    TruncSize :: non_neg_integer(),
                    SeverityAsInt :: integer(),
                    LevelThreshold :: integer(),
                    TraceFilters :: term(),
                    SinkPid :: pid().

do_log(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold, TraceFilters, Sink, SinkPid)

-spec do_log(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold,
             TraceFilters, Sink, SinkPid) ->
                ok | Error
                when
                    Severity :: log_level(),
                    MetadataList :: [{atom(), term()}],
                    Format :: string(),
                    Args :: list(),
                    TruncSize :: non_neg_integer(),
                    SeverityAsInt :: integer(),
                    LevelThreshold :: integer(),
                    TraceFilters :: term(),
                    Sink :: atom(),
                    SinkPid :: pid(),
                    Error :: {error, Reason},
                    Reason :: {bad_sink, Sink}.

do_log_unsafe(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold, TraceFilters, Sink, SinkPid)

-spec do_log_unsafe(Severity, MetadataList, Format, Args, TruncSize, SeverityAsInt, LevelThreshold,
                    TraceFilters, Sink, SinkPid) ->
                       ok | Error
                       when
                           Severity :: log_level(),
                           MetadataList :: [{atom(), term()}],
                           Format :: string(),
                           Args :: list(),
                           TruncSize :: non_neg_integer(),
                           SeverityAsInt :: integer(),
                           LevelThreshold :: integer(),
                           TraceFilters :: term(),
                           Sink :: atom(),
                           SinkPid :: pid(),
                           Error :: {error, Reason},
                           Reason :: {bad_sink, Sink}.

get_loglevel(Handler)

-spec get_loglevel(term()) -> no_return().

get_loglevel(Sink, Handler)

-spec get_loglevel(term(), term()) -> no_return().

get_loglevels(Sink)

-spec get_loglevels(term()) -> no_return().

install_trace(Pid, Level)

-spec install_trace(term(), term()) -> no_return().

install_trace(Pid, Level, Options)

-spec install_trace(term(), term(), term()) -> no_return().

list_all_sinks()

-spec list_all_sinks() -> no_return().

log/3

-spec log(Level, Process | MetadataList, Message) -> ok
             when
                 Level :: log_level(),
                 Process :: pid() | atom(),
                 MetadataList :: [{atom(), term()}],
                 Message :: string().

log/4

-spec log(Level, Process | MetadataList, Message, Args) -> ok
             when
                 Level :: log_level(),
                 Process :: pid() | atom(),
                 MetadataList :: [{atom(), term()}],
                 Message :: string(),
                 Args :: list().

log/5

-spec log(Sink, Level, Process | MetadataList, Message, Args) -> ok | Error
             when
                 Sink :: atom(),
                 Level :: log_level(),
                 Process :: pid() | atom(),
                 MetadataList :: [{atom(), term()}],
                 Message :: string(),
                 Args :: list(),
                 Error :: {error, Reason},
                 Reason :: {bad_sink, Sink}.

log_unsafe(Level, MetadataList, Message, Args)

-spec log_unsafe(Level, MetadataList, Message, Args) -> ok
                    when
                        Level :: log_level(),
                        MetadataList :: [{atom(), term()}],
                        Message :: string(),
                        Args :: list().

md()

-spec md() -> [{atom(), any()}].

md/1

-spec md([{atom(), any()}, ...]) -> ok.

posix_error(Error)

-spec posix_error(term()) -> no_return().

pr(Value, Module)

-spec pr(Value, Module) -> MaybePrettyValue
            when
                Value :: Record | [Record] | NonRecord,
                Record :: tuple(),
                NonRecord :: term(),
                Module :: module(),
                MaybePrettyValue :: PrettyRecord | [PrettyRecord] | MaybePrettyNonRecord,
                PrettyRecord :: {RecordName, PrettyRecordFields},
                RecordName :: atom(),
                PrettyRecordFields :: #{RecordFieldName => MaybePrettyValue},
                RecordFieldName :: atom(),
                MaybePrettyNonRecord :: term().

pr(Value, Module, Opts)

-spec pr(Value, Module, Opts) -> MaybePrettyValue
            when
                Value :: Record | [Record] | NonRecord,
                Record :: tuple(),
                NonRecord :: term(),
                Module :: module(),
                MaybePrettyValue :: PrettyRecord | [PrettyRecord] | MaybePrettyNonRecord,
                PrettyRecord :: {RecordName, PrettyRecordFields},
                RecordName :: atom(),
                PrettyRecordFields :: #{RecordFieldName => MaybePrettyValue},
                RecordFieldName :: atom(),
                MaybePrettyNonRecord :: term(),
                Opts :: [pr_opt()].

pr_stacktrace(Stacktrace)

-spec pr_stacktrace(term()) -> no_return().

pr_stacktrace/2

-spec pr_stacktrace(term(), {atom(), term()}) -> no_return().

remove_trace(Pid)

-spec remove_trace(term()) -> no_return().

rotate_all()

-spec rotate_all() -> no_return().

rotate_handler(Handler)

-spec rotate_handler(term()) -> no_return().

rotate_handler(Handler, Sink)

-spec rotate_handler(term(), term()) -> no_return().

rotate_sink(Sink)

-spec rotate_sink(term()) -> no_return().

safe_format(Fmt, Args, Limit)

-spec safe_format(term(), term(), term()) -> no_return().

safe_format_chop(Fmt, Args, Limit)

-spec safe_format_chop(term(), term(), term()) -> no_return().

set_loghwm(Handler, Hwm)

-spec set_loghwm(term(), term()) -> no_return().

set_loghwm(Sink, Handler, Hwm)

-spec set_loghwm(term(), term(), term()) -> no_return().

set_loghwm(Sink, Handler, Ident, Hwm)

-spec set_loghwm(term(), term(), term(), term()) -> no_return().

set_loglevel(Handler, Level)

-spec set_loglevel(term(), term()) -> no_return().

set_loglevel(Handler, Ident, Level)

-spec set_loglevel(term(), term(), term()) -> no_return().

set_loglevel(Sink, Handler, Ident, Level)

-spec set_loglevel(term(), term(), term(), term()) -> no_return().

start()

-spec start() -> ok | {error, {atom(), term()}}.

status()

-spec status() -> no_return().

stop_trace/1

-spec stop_trace({term(), term(), term()}) -> no_return().

stop_trace(Backend, Filter, Level)

-spec stop_trace(term(), term(), term()) -> no_return().

trace(Backend, Filter)

-spec trace(term(), term()) -> no_return().

trace(Backend, Filter, Level)

-spec trace(term(), term(), term()) -> no_return().

trace_console(Filter)

-spec trace_console(term()) -> no_return().

trace_console(Filter, Level)

-spec trace_console(term(), term()) -> no_return().

trace_file(File, Filter)

-spec trace_file(term(), term()) -> no_return().

trace_file(File, Filter, LevelOrOptions)

-spec trace_file(term(), term(), term()) -> no_return().

trace_file(File, Filter, Level, Options)

-spec trace_file(term(), term(), term(), term()) -> no_return().

trace_func(FuncState, Event, ProcState)

-spec trace_func(term(), term(), term()) -> no_return().

trace_state(Pid, Level, Options)

-spec trace_state(term(), term(), term()) -> no_return().

unsafe_format(Fmt, Args)

-spec unsafe_format(term(), term()) -> no_return().

update_loglevel_config(Sink)

-spec update_loglevel_config(term()) -> no_return().