ring_logger v0.6.0 RingLogger.Client
Interact with the RingLogger
Link to this section Summary
Functions
Attach the current IEx session to the logger. It will start printing log messages
Returns a specification to start this module under a supervisor
Update the client configuration
Detach the current IEx session from the logger
Helper method for formatting log messages per the current client’s configuration
Run a regular expression on each entry in the log and print out the matchers
Invoked when the server is started. start_link/3 or start/3 will
block until it returns
Get the next set of the messages in the log
Reset the index into the log for tail/1 to the oldest entry
Start up a client GenServer. Except for just getting the contents of the ring buffer, you’ll
need to create one of these. See configure/2 for information on options
Stop a client
Get the last n messages
Link to this section Functions
Attach the current IEx session to the logger. It will start printing log messages.
Returns a specification to start this module under a supervisor.
See Supervisor.
configure(GenServer.server(), [RingLogger.client_option()]) :: :ok
Update the client configuration.
Options include:
:io- Defaults to:stdio:colors-:metadata- A KV list of additional metadata:format- A custom format string, or a {module, function} tuple (see https://hexdocs.pm/logger/master/Logger.html#module-custom-formatting):level- The minimum log level to report.
Detach the current IEx session from the logger.
format(GenServer.server(), RingLogger.entry()) :: :ok
Helper method for formatting log messages per the current client’s configuration.
grep(GenServer.server(), Regex.t(), keyword()) :: :ok | {:error, term()}
Run a regular expression on each entry in the log and print out the matchers.
Supported options:
:pager- an optional 2-arity function that takes an IO device and what to print
Invoked when the server is started. start_link/3 or start/3 will
block until it returns.
args is the argument term (second argument) passed to start_link/3.
Returning {:ok, state} will cause start_link/3 to return
{:ok, pid} and the process to enter its loop.
Returning {:ok, state, timeout} is similar to {:ok, state}
except handle_info(:timeout, state) will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate} is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3 for more information on hibernation.
Returning {:ok, state, {:continue, continue}} is similar to
{:ok, state} except that immediately after entering the loop
the c:handle_continue/2 callback will be invoked with the value
continue as first argument.
Returning :ignore will cause start_link/3 to return :ignore and
the process will exit normally without entering the loop or calling
c:terminate/2. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer. The remainder of the supervision tree will be started
and so the GenServer should not be required by other processes.
It can be started later with Supervisor.restart_child/2 as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServeris disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor. Likely this approach involves callingSupervisor.restart_child/2after a delay to attempt a restart.
Returning {:stop, reason} will cause start_link/3 to return
{:error, reason} and the process to exit with reason reason without
entering the loop or calling c:terminate/2.
Callback implementation for GenServer.init/1.
next(GenServer.server(), keyword()) :: :ok | {:error, term()}
Get the next set of the messages in the log.
Supported options:
:pager- an optional 2-arity function that takes an IO device and what to print
Reset the index into the log for tail/1 to the oldest entry.
Start up a client GenServer. Except for just getting the contents of the ring buffer, you’ll
need to create one of these. See configure/2 for information on options.
Stop a client.
Get the last n messages.
Supported options:
:pager- an optional 2-arity function that takes an IO device and what to print