User's Guide
Reference Manual
Release Notes
PDF
Top

Event Tracer (ET)
Reference Manual
Version 1.5.1

Expand All
Contract All

Table of Contents

- et
  - Top of manual page
  - trace_me/5
  - trace_me/4
  - phone_home/4
  - phone_home/5
  - report_event/4
  - report_event/5
- et_collector
  - Top of manual page
  - start_link/1
  - stop/1
  - save_event_file/3
  - load_event_file/2
  - report/2
  - report_event/5
  - report_event/6
  - make_key/2
  - get_table_handle/1
  - get_global_pid/0
  - change_pattern/2
  - dict_insert/3
  - dict_insert/3
  - dict_insert/3
  - dict_lookup/2
  - dict_delete/2
  - dict_match/2
  - multicast/2
  - start_trace_client/3
  - iterate/3
  - iterate/5
  - clear_table/1
- et_selector
  - Top of manual page
  - make_pattern/1
  - change_pattern/1
  - parse_event/2
- et_viewer
  - Top of manual page
  - file/1
  - start/0
  - start/1
  - start_link/1
  - get_collector_pid/1
  - stop/1

# et_selector

### MODULE

et_selector

### MODULE SUMMARY

Define event transforms and trace patterns

### DESCRIPTION

### EXPORTS

make_pattern(RawPattern) -> TracePattern

Types:

RawPattern = detail_level()
TracePattern = erlang_trace_pattern_match_spec()
detail_level() = min | max | integer(X) when X >= 0, X =< 100

Makes a trace pattern suitable to feed change_pattern/1

Min detail level deactivates tracing of calls to et:trace_me/4,5

Max detail level activates tracing of all calls to et:trace_me/4,5

integer(X) detail level activates tracing of all calls to et:trace_me/4,5 whose detail level argument is lesser than X.

See also erlang:trace_pattern/2 for more info about its match_spec()

change_pattern(Pattern) -> ok

Types:

Pattern = detail_level() | empty_match_spec() | erlang_trace_pattern_match_spec()
detail_level() = min | max | integer(X) when X >= 0, X =< 100
empty_match_spec() = []

Activates/deactivates tracing by changing the current trace pattern.

min detail level deactivates tracing of calls to et:trace_me/4,5

max detail level activates tracing of all calls to et:trace_me/4,5

integer(X) detail level activates tracing of all calls to et:trace_me/4,5 whose detail level argument is lesser than X.

An empty match spec deactivates tracing of calls to et:trace_me/4,5

Other match specs activates tracing of calls to et:trace_me/4,5 accordingly with erlang:trace_pattern/2.

parse_event(Mod, ValidTraceData) -> false | true | {true, Event}

Types:

Mod = module_name() | undefined <v>module_name() = atom() <v>ValidTraceData = erlang_trace_data() | record(event)
erlang_trace_data() = {trace, Pid, Label, Info} | {trace, Pid, Label, Info, Extra} | {trace_ts, Pid, Label, Info, ReportedTS} | {trace_ts, Pid, Label, Info, Extra, ReportedTS} | {seq_trace, Label, Info} | {seq_trace, Label, Info, ReportedTS} | {drop, NumberOfDroppedItems}

Transforms trace data and makes an event record out of it.

See erlang:trace/3 for more info about the semantics of the trace data.

An event record consists of the following fields:

detail_level

  Noise has a high level as opposed to essentials.

trace_ts

  Time when the trace was generated. Same as event_ts if omitted in trace data.

event_ts

  Time when the event record was created.

from

  From actor, such as sender of a message.

to

  To actor, such as receiver of message.

label

  Label intended to provide a brief event summary.

contents

  All nitty gritty details of the event.

See et:trace_me/4and et:trace_me/5 for details.

Returns:

{true, Event}

  where Event is an #event{} record representing the trace data

true

  means that the trace data already is an event record and that it is valid as it is. No transformation is needed.

false

  means that the trace data is uninteresting and should be dropped