defmodule ThousandIsland.Logger do
@moduledoc """
Allows dynamically adding and altering the log level used to trace connections
within a Thousand Island server via the use of telemetry hooks. Should you wish
to do your own logging or tracking of these events, a complete list of the
telemetry events emitted by Thousand Island is described in the module
documentation for `ThousandIsland`.
"""
require Logger
@doc """
Start logging Thousand Island at the specified log level. Valid values for log
level are `:error`, `:info`, `:debug`, and `:trace`. Enabling a given log
level implicitly enables all higher log levels as well.
"""
@spec attach_logger(atom()) :: :ok | {:error, :already_exists}
def attach_logger(:error) do
events = [
[:listener, :error],
[:handler, :error],
[:socket, :handshake_error]
]
:telemetry.attach_many("#{__MODULE__}.error", events, &__MODULE__.log_error/4, nil)
end
def attach_logger(:info) do
attach_logger(:error)
events = [
[:listener, :start]
]
:telemetry.attach_many("#{__MODULE__}.info", events, &__MODULE__.log_info/4, nil)
end
def attach_logger(:debug) do
attach_logger(:info)
events = [
[:acceptor, :start],
[:acceptor, :accept],
[:acceptor, :shutdown],
[:handler, :start],
[:handler, :shutdown]
]
:telemetry.attach_many("#{__MODULE__}.debug", events, &__MODULE__.log_debug/4, nil)
end
def attach_logger(:trace) do
attach_logger(:debug)
events = [
[:handler, :async_recv],
[:socket, :handshake],
[:socket, :recv],
[:socket, :send],
[:socket, :sendfile],
[:socket, :shutdown],
[:socket, :close]
]
:telemetry.attach_many("#{__MODULE__}.trace", events, &__MODULE__.log_trace/4, nil)
end
@doc """
Stop logging Thousand Island at the specified log level. Disabling a given log
level implicitly disables all lower log levels as well.
"""
@spec detach_logger(atom()) :: :ok | {:error, :not_found}
def detach_logger(:error) do
detach_logger(:info)
:telemetry.detach("#{__MODULE__}.error")
end
def detach_logger(:info) do
detach_logger(:debug)
:telemetry.detach("#{__MODULE__}.info")
end
def detach_logger(:debug) do
detach_logger(:trace)
:telemetry.detach("#{__MODULE__}.debug")
end
def detach_logger(:trace) do
:telemetry.detach("#{__MODULE__}.trace")
end
@doc false
def log_error([:listener, :error], measurements, _metadata, _config) do
Logger.error("Listener error #{inspect(measurements.error)}")
end
def log_error([:handler, :error], measurements, metadata, _config) do
Logger.error("Handler #{metadata.connection_id} error #{inspect(measurements.error)}")
end
def log_error([:socket, :handshake_error], measurements, metadata, _config) do
Logger.error(
"Connection #{metadata.connection_id} handshake error #{inspect(measurements.error)}"
)
end
def log_info([:listener, :start], measurements, _metadata, _config) do
Logger.info("Listener listening on port #{measurements.port}")
end
def log_debug(event, measurements, metadata, _config) do
Logger.debug(
"#{inspect(event)} metadata: #{inspect(metadata)}, measurements: #{inspect(measurements)}"
)
end
def log_trace(event, measurements, metadata, _config) do
Logger.debug(
"#{inspect(event)} metadata: #{inspect(metadata)}, measurements: #{inspect(measurements)}"
)
end
end