1et_selector(3)             Erlang Module Definition             et_selector(3)
2
3
4

NAME

6       et_selector - Define event transforms and trace patterns
7

DESCRIPTION

EXPORTS

10       make_pattern(RawPattern) -> TracePattern
11
12              Types:
13
14                 RawPattern = detail_level()
15                 TracePattern = erlang_trace_pattern_match_spec()
16                 detail_level() = min | max | integer(X) when X >= 0, X =< 100
17
18              Makes a trace pattern suitable to feed change_pattern/1
19
20              Min detail level deactivates tracing of calls to et:trace_me/4,5
21
22              Max   detail   level   activates   tracing   of   all  calls  to
23              et:trace_me/4,5
24
25              integer(X) detail  level  activates  tracing  of  all  calls  to
26              et:trace_me/4,5 whose detail level argument is lesser than X.
27
28              See   also   erlang:trace_pattern/2  for  more  info  about  its
29              match_spec()
30
31       change_pattern(Pattern) -> ok
32
33              Types:
34
35                 Pattern  =  detail_level()   |   empty_match_spec()   |   er‐
36                 lang_trace_pattern_match_spec()
37                 detail_level() = min | max | integer(X) when X >= 0, X =< 100
38                 empty_match_spec() = []
39
40              Activates/deactivates tracing by changing the current trace pat‐
41              tern.
42
43              min detail level deactivates tracing of calls to et:trace_me/4,5
44
45              max  detail  level   activates   tracing   of   all   calls   to
46              et:trace_me/4,5
47
48              integer(X)  detail  level  activates  tracing  of  all  calls to
49              et:trace_me/4,5 whose detail level argument is lesser than X.
50
51              An  empty  match  spec   deactivates   tracing   of   calls   to
52              et:trace_me/4,5
53
54              Other  match specs activates tracing of calls to et:trace_me/4,5
55              accordingly with erlang:trace_pattern/2.
56
57       parse_event(Mod, ValidTraceData) -> false | true | {true, Event}
58
59              Types:
60
61                 Mod = module_name() | undefined
62                 module_name() = atom()
63                 ValidTraceData = erlang_trace_data() | record(event)
64                 erlang_trace_data() = {trace, Pid,  Label,  Info}  |  {trace,
65                 Pid,  Label,  Info, Extra} | {trace_ts, Pid, Label, Info, Re‐
66                 portedTS} | {trace_ts, Pid, Label, Info, Extra, ReportedTS} |
67                 {seq_trace,  Label,  Info} | {seq_trace, Label, Info, Report‐
68                 edTS} | {drop, NumberOfDroppedItems}
69
70              Transforms trace data and makes an event record out of it.
71
72              See erlang:trace/3 for more info  about  the  semantics  of  the
73              trace data.
74
75              An event record consists of the following fields:
76
77                detail_level:
78                  Noise has a high level as opposed to essentials.
79
80                trace_ts:
81                  Time when the trace was generated. Same as event_ts if omit‐
82                  ted in trace data.
83
84                event_ts:
85                  Time when the event record was created.
86
87                from:
88                  From actor, such as sender of a message.
89
90                to:
91                  To actor, such as receiver of message.
92
93                label:
94                  Label intended to provide a brief event summary.
95
96                contents:
97                  All nitty gritty details of the event.
98
99              See et:trace_me/4and et:trace_me/5 for details.
100
101              Returns:
102
103                {true, Event}:
104                  where Event is an #event{}  record  representing  the  trace
105                  data
106
107                true:
108                  means  that  the  trace  data already is an event record and
109                  that it is valid as it is. No transformation is needed.
110
111                false:
112                  means that the trace data is  uninteresting  and  should  be
113                  dropped
114
115
116
117Ericsson AB                        et 1.6.5                     et_selector(3)