Grizzly.Trace (grizzly v9.1.0)

Module that tracks the commands that are sent and received by Grizzly

The trace will hold in memory the last 300 messages. If you want to generate a log file of the trace records you use Grizzly.Trace.dump/1.

The log format is:

timestamp source destination sequence_number command_name command_parameters

If you want to list the records that are currently being held in memory you can use Grizzly.Trace.list/0.

If you want to start traces from a fresh start you can call Grizzly.Trace.clear/0.

Summary

Types

dest()

format()

list_opt()

log_opt()

src()

trace_opt()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear(name \\ __MODULE__)

Reset the trace buffer.

dump(file)

Dump trace records into a file using Erlang External Term Format.

format(records, format \\ :text)

Serialize a list of trace records into a binary. The format can be one of

list()

See list/2.

list(opts)

See list/2.

list(name, opts)

List all records in the trace buffer.

log(name \\ __MODULE__, src, dest, binary)

Add a record to the trace buffer.

print()

print(fmt_or_opts)

print(records_or_format, opts)

Write trace records to standard out. See format/2 for the available formats.

record_keepalives(enabled? \\ true)

See record_keepalives/2.

record_keepalives(name, enabled?)

Enable or disable logging of keepalive frames.

resize(name \\ __MODULE__, size)

Change the max size of the trace buffer from the default of 300.

start_link(opts \\ [])

Start the trace server.

Types

dest()

@type dest() :: Grizzly.node_id() | :grizzly

format()

@type format() :: :text | :raw

list_opt()

@type list_opt() :: {:node_id, Grizzly.node_id()}

log_opt()

@type log_opt() :: {:src, src()} | {:dest, dest()}

src()

@type src() :: Grizzly.node_id() | :grizzly

trace_opt()

@type trace_opt() ::
  {:name, atom()} | {:size, pos_integer()} | {:record_keepalives, boolean()}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

clear(name \\ MODULE)

@spec clear(GenServer.server()) :: :ok

Reset the trace buffer.

dump(file)

@spec dump(binary()) :: :ok | {:error, atom()}

Dump trace records into a file using Erlang External Term Format.

format(records, format \\ :text)

@spec format([Grizzly.Trace.Record.t()], format()) :: binary()

Serialize a list of trace records into a binary. The format can be one of:

:text - Each record is on a new line and is formatted as timestamp source destination sequence_number command_name command_binary. This is the default format.
:raw - Each record is on a new line and is formatted as timestamp source -> destination: binary.

list()

@spec list() :: [Grizzly.Trace.Record.t()]

See list/2.

list(opts)

@spec list(GenServer.server() | [list_opt()]) :: [Grizzly.Trace.Record.t()]

See list/2.

list(name, opts)

@spec list(GenServer.server(), [list_opt()]) :: [Grizzly.Trace.Record.t()]

List all records in the trace buffer.

log(name \\ MODULE, src, dest, binary)

@spec log(GenServer.server(), src(), dest(), binary()) :: :ok

Add a record to the trace buffer.

print()

@spec print() :: :ok

print(fmt_or_opts)

print(records_or_format, opts)

@spec print([Grizzly.Trace.Record.t()] | format(), [list_opt()]) :: :ok

Write trace records to standard out. See format/2 for the available formats.

record_keepalives(enabled? \\ true)

@spec record_keepalives(boolean()) :: :ok

See record_keepalives/2.

record_keepalives(name, enabled?)

@spec record_keepalives(GenServer.server(), boolean()) :: :ok

Enable or disable logging of keepalive frames.

resize(name \\ MODULE, size)

@spec resize(GenServer.server(), pos_integer()) :: :ok

Change the max size of the trace buffer from the default of 300.

start_link(opts \\ [])

@spec start_link([trace_opt()]) :: GenServer.on_start()

Start the trace server.