File: et_selector.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (86 lines) | stat: -rw-r--r-- 3,024 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
.TH et_selector 3 "et  1.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
et_selector \- Define event transforms and trace patterns
.SH DESCRIPTION
.LP


.SH EXPORTS
.LP
.B
make_pattern(RawPattern) -> TracePattern
.br
.RS
.TP
Types
RawPattern = detail_level()
.br
TracePattern = erlang_trace_pattern_match_spec()
.br
detail_level() = min | max | integer(X) when X =< 0, X >= 100
.br
.RE
.RS
.LP
Makes a trace pattern suitable to feed change_pattern/1
.LP
Min detail level deactivates tracing of calls to phone_home/4,5
.LP
Max detail level activates tracing of all calls to phone_home/4,5
.LP
integer(X) detail level activates tracing of all calls to phone_home/4,5 whose detail level argument is lesser than X\&.
.LP
See also erlang:trace_pattern/2 for more info about its match_spec()
.RE
.LP
.B
change_pattern(Pattern) -> ok
.br
.RS
.TP
Types
Pattern = detail_level() | empty_match_spec() | erlang_trace_pattern_match_spec()
.br
detail_level() = min | max | integer(X) when X =<0, X >= 100
.br
empty_match_spec() = [] 
.br
.RE
.RS
.LP
Activates/deactivates tracing by changing the current trace pattern\&.
.LP
Min detail level deactivates tracing of calls to phone_home/4,5
.LP
Max detail level activates tracing of all calls to phone_home/4,5
.LP
integer(X) detail level activates tracing of all calls to phone_home/4,5 whose detail level argument is lesser than X\&.
.LP
An empty match spec deactivates tracing of calls to phone_home/4,5
.LP
Other match specs activates tracing of calls to phone_home/4,5 accordlingly with erlang:trace_pattern/2\&.
.RE
.LP
.B
parse_event(Mod, ValidTraceData) -> false | true | {true, Event}
.br
.RS
.TP
Types
Mod = module_name() | undefined <v>module_name() = atom() <v>ValidTraceData = erlang_trace_data() | record(event)
.br
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}
.br
.RE
.RS
.LP
Transforms trace data and makes an event record out of it\&.
.LP
See erlang:trace/3 for more info about the semantics of the trace data\&.
.LP
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\&.
.LP
See et:phone_home/4 and et:phone_home/5 for details\&.
.LP
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
.RE