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()    |
36                 erlang_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  <v>module_name()  =  atom()
62                 <v>ValidTraceData = erlang_trace_data() | record(event)
63                 erlang_trace_data()  =  {trace,  Pid,  Label, Info} | {trace,
64                 Pid, Label, Info,  Extra}  |  {trace_ts,  Pid,  Label,  Info,
65                 ReportedTS} | {trace_ts, Pid, Label, Info, Extra, ReportedTS}
66                 | {seq_trace, Label, Info} | {seq_trace, Label, Info, Report‐
67                 edTS} | {drop, NumberOfDroppedItems}
68
69              Transforms trace data and makes an event record out of it.
70
71              See  erlang:trace/3  for  more  info  about the semantics of the
72              trace data.
73
74              An event record consists of the following fields:
75
76                detail_level:
77                  Noise has a high level as opposed to essentials.
78
79                trace_ts:
80                  Time when the trace was generated. Same as event_ts if omit‐
81                  ted in trace data.
82
83                event_ts:
84                  Time when the event record was created.
85
86                from:
87                  From actor, such as sender of a message.
88
89                to:
90                  To actor, such as receiver of message.
91
92                label:
93                  Label intended to provide a brief event summary.
94
95                contents:
96                  All nitty gritty details of the event.
97
98              See et:trace_me/4and et:trace_me/5 for details.
99
100              Returns:
101
102                {true, Event}:
103                  where  Event  is  an  #event{} record representing the trace
104                  data
105
106                true:
107                  means that the trace data already is  an  event  record  and
108                  that it is valid as it is. No transformation is needed.
109
110                false:
111                  means  that  the  trace  data is uninteresting and should be
112                  dropped
113
114
115
116Ericsson AB                        et 1.6.1                     et_selector(3)