grizzly
grizzly
v6.7.0

View Source Grizzly.Trace (grizzly v6.7.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.

Link to this section Summary

Types

dest()
format()
log_opt()
src()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear()

Force clear the records from the trace

dump(file, format \\ :text)

Dump the trace records into a file. See format/2 for the available formats.

format(records, format \\ :text)

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

list()

List all the records currently being traced

log(binary, opts \\ [])

Log the trace information

start_link(args)

Start the trace server

Link to this section Types

Link to this type

dest()

View Source 
@type dest() :: String.t()
Link to this type

format()

View Source 
@type format() :: :text | :term
Link to this type

log_opt()

View Source 
@type log_opt() :: {:src, src()} | {:dest, dest()}
Link to this type

src()

View Source 
@type src() :: String.t()

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

clear()

View Source 
@spec clear() :: :ok

Force clear the records from the trace

Link to this function

dump(file, format \\ :text)

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

Dump the trace records into a file. See format/2 for the available formats.

Link to this function

format(records, format \\ :text)

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

Serializes 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_parameters. This is the default format.

  • :term - The trace is serialized as a list of Record.t() structs in Erlang external term format. This is useful if you want to load the trace on another machine.

Link to this function

list()

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

List all the records currently being traced

Link to this function

log(binary, opts \\ [])

View Source 
@spec log(binary(), [log_opt()]) :: :ok

Log the trace information

Link to this function

start_link(args)

View Source 
@spec start_link(keyword()) :: GenServer.on_start()

Start the trace server