Packages
timber
0.2.0
3.1.2
3.1.1
3.1.0
3.0.0
3.0.0-alpha.3
3.0.0-alpha.2
3.0.0-alpha.1
2.8.4
2.8.3
2.8.2
2.8.1
2.8.0
2.7.0
2.6.1
2.6.0
2.5.6
2.5.5
2.5.4
2.5.3
2.5.2
2.5.1
2.5.0
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.4
2.3.3
2.3.1
2.3.0
2.2.1
2.2.0
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
2.0.0-rc7
2.0.0-rc6
2.0.0-rc5
2.0.0-rc4
2.0.0-rc3
2.0.0-rc2
2.0.0-rc1
1.1.18
1.1.17
1.1.16
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.16
1.0.15
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.3
0.2.2
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
🌲 Great Elixir Logging Made Easy. Official Timber.io Integration.
Current section
Files
Jump to
Current section
Files
lib/timber/transport.ex
defmodule Timber.Transport do
@moduledoc """
A Transport specifies the way in which `Timber.Logger` should actually output
log events.
While the `Timber.Logger` module will handle receiving and processing log events,
the process of actually outputting them is left to the trasnport. The transport
is also responsible for managing any necessary buffers and switching between
syncrhonous and asynchronous output.
"""
alias Timber.LogEntry
@typedoc """
The transport state can be used to keep track of stateful data for operations,
such as buffers and process IDs. It will always be passed as the final parameter
to any expected callback and is expected to be returned by the function.
"""
@type state :: any
@doc """
Flushes pending messages from any buffer
If your transport implements a buffer, this call should essentially be synchronous,
blocking until all messages in the buffer have been sent and confirmed output.
"""
@callback flush(state) :: state
@doc """
Initializes the transport with the provided configuration
The transport is expected to start any necessary processes at this point. References
to other processes should be kept in the state which is then returned.
"""
@callback init(Keyword.t) :: {:ok, state} | no_return
@doc """
Writes a log message to the transport
The log entry to write will be sent along with the state. Writing the log entry
is not expected to be immediate, but this function is expected to return quickly.
If the transport uses a buffer, that buffer should be maintained in the state which
is then returned.
"""
@callback write(LogEntry.t, state) :: {:ok, state} | no_return
@doc """
Handles `handle_info` process messaging forwarded from `Timber.Logger`
It is expected that your transport at least return `{:ok, state}` for
any given `info`.
"""
@callback handle_info(info :: tuple, state) :: {:ok, state} | no_return
@doc """
Passes configuration changes to the transport
The transport is expected to store any configuration on the state it
passes back.
"""
@callback configure(options :: Keyword.t, state) :: {:ok, state} | {:error, Exception.t}
end