View Source Logster (Logster v2.0.0-rc.5)
Single line, easy to parse logs for Elixir Phoenix and Plug applications.
See the project README for more details.
Summary
Functions
Logs a alert message. See Logster.log/3
for more information.
Attaches a telemetry handler to the :phoenix
event stream for logging.
Logs a critical message. See Logster.log/3
for more information.
Logs a debug message. See Logster.log/3
for more information.
Detaches logster's telemetry handler from the :phoenix
event stream.
Logs a emergency message. See Logster.log/3
for more information.
Logs a error message. See Logster.log/3
for more information.
Logs a info message. See Logster.log/3
for more information.
Logs a message with the given level
.
Logs details about the given conn
Logs a notice message. See Logster.log/3
for more information.
Logs a warning message. See Logster.log/3
for more information.
Types
@type fields_or_message_or_func() :: Keyword.t() | Logger.message() | (-> Keyword.t())
Functions
@spec alert( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a alert message. See Logster.log/3
for more information.
Returns :ok
.
@spec attach_phoenix_logger() :: :ok
Attaches a telemetry handler to the :phoenix
event stream for logging.
Returns :ok
.
@spec critical( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a critical message. See Logster.log/3
for more information.
Returns :ok
.
@spec debug( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a debug message. See Logster.log/3
for more information.
Returns :ok
.
@spec detach_phoenix_logger() :: :ok
Detaches logster's telemetry handler from the :phoenix
event stream.
Returns :ok
.
@spec emergency( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a emergency message. See Logster.log/3
for more information.
Returns :ok
.
@spec error( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a error message. See Logster.log/3
for more information.
Returns :ok
.
@spec info( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a info message. See Logster.log/3
for more information.
Returns :ok
.
@spec levels() :: [Logger.level()]
@spec log( level :: Logger.level(), fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a message with the given level
.
If given an enumerable, the enumerable will be formatted using the configured formatter.
Returns :ok
.
Example
Logster.log(:info, service: "payment-processor", event: "start-processing", customer: "1234")
will produce the following log entry when using the logfmt
formatter:
16:54:29.919 [info] service=payment-processor event=start-processing customer=1234
@spec log_conn(conn :: Plug.Conn.t(), duration_us :: integer(), opts :: Keyword.t()) :: :ok
Logs details about the given conn
See the module documentation for more information on configuration options.
Returns :ok
.
@spec notice( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a notice message. See Logster.log/3
for more information.
Returns :ok
.
@spec warning( fields_or_message_or_func :: fields_or_message_or_func(), metadata :: Logger.metadata() ) :: :ok
Logs a warning message. See Logster.log/3
for more information.
Returns :ok
.