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

NAME

6       et - Main API of the Event Trace (ET) application
7

DESCRIPTION

9       Interface module for the Event Trace (ET) application
10

EXPORTS

12       trace_me(DetailLevel, From, To, Label, Contents) -> hopefully_traced
13
14              Types:
15
16                 DetailLevel = integer(X) when X =< 0, X >= 100
17                 From = actor()
18                 To = actor()
19                 Label = atom() | string() | term()
20                 Contents = [{Key, Value}] | term()
21                 actor() = term()
22
23              A function that is intended to be traced.
24
25              This  function  is intended to be invoked at strategic places in
26              user applications in order to  enable  simplified  tracing.  The
27              functions  are extremely light weight as they do nothing besides
28              returning an atom. The functions are designed for being  traced.
29              The global tracing mechanism in et_collector defaults to set its
30              trace pattern to these functions.
31
32              The label is intended to provide a brief summary of  the  event.
33              It is preferred to use an atom but a string would also do.
34
35              The  contents can be any term but in order to simplify post pro‐
36              cessing of the traced events, a plain list of {Key,  Value}  tu‐
37              ples is preferred.
38
39              Some  events,  such as messages, are directed from some actor to
40              another. Other events (termed actions)  may  be  undirected  and
41              only have one actor.
42
43       trace_me(DetailLevel, FromTo, Label, Contents) -> hopefully_traced
44
45              Invokes et:trace_me/5 with both From and To set to FromTo.
46
47       phone_home(DetailLevel, FromTo, Label, Contents) -> hopefully_traced
48       phone_home(DetailLevel, From, To, Label, Contents) -> hopefully_traced
49
50              These functions sends a signal to the outer space and the caller
51              hopes that someone is listening. In  other  words,  they  invoke
52              et:trace_me/4 and et:trace_me/5 respectively.
53
54       report_event(DetailLevel, FromTo, Label, Contents) -> hopefully_traced
55       report_event(DetailLevel,   From,   To,   Label,   Contents)  ->  hope‐
56       fully_traced
57
58              Deprecated functions which for the time being are kept for back‐
59              wards compatibility. Invokes et:trace_me/4 and et:trace_me/5 re‐
60              spectively.
61
62
63
64Ericsson AB                        et 1.6.5                              et(3)