et_viewer - Erlang 23 Documentation

Module

et_viewer

Module Summary

Displays a sequence chart for trace events (messages/actions)

Description

Exports

file(FileName) -> {ok, ViewerPid} | {error, Reason}

Types

Start a new event viewer and a corresponding collector and load them with trace events from a trace file.

start() -> ok

Simplified start of a sequence chart viewer with global tracing activated.

Convenient to be used from the command line (erl -s et_viewer).

start(Options) -> ok

Start of a sequence chart viewer without linking to the parent process.

start_link(Options) -> {ok, ViewerPid} | {error, Reason}

Types

Start a sequence chart viewer for trace events (messages/actions)

A filter_fun() takes an event record as sole argument and returns false | true | {true, NewEvent}.

If the collector_pid is undefined a new et_collector will be started with the following parameter settings: parent_pid, event_order, trace_global, trace_pattern, trace_port, trace_max_queue, trace_client, dict_insert and dict_delete. The new et_viewer will register itself as an et_collector subscriber.

Default values:

parent_pid - self().
title - "et_viewer".
detail_level - max.
is_suspended - false.
scale - 2.
width - 800.
height - 600.
collector_pid - undefined.
event_order - trace_ts.
active_filter - collector.
max_actors - 5.
actors - ["UNKNOWN"].
first_event - first.
hide_unknown - false.
hide_actions - false.
display_mode - all.

get_collector_pid(ViewerPid) -> CollectorPid

Types

Returns the identifier of the collector process.

stop(ViewerPid) -> ok

Types

Stops a viewer process.