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
|
.TH percept_profile 3 "percept 0.7.2" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
percept_profile \- Percept Collector\&.
.SH DESCRIPTION
.LP
Percept Collector
.LP
This module provides the user interface for the percept data collection (profiling)\&.
.SH DATA TYPES
.RS 2
.TP 4
.B
\fIpercept_option() = procs | ports | exclusive\fR:
.RE
.SH EXPORTS
.LP
.B
start(Filename::string()) -> {ok, Port} | {already_started, Port}
.br
.RS
.LP
Equivalent to start(Filename, [procs])\&.
.RE
.LP
.B
start(Filename::string(), Options::[percept_option()]) -> {ok, Port} | {already_started, Port}
.br
.RS
.TP
Types
Port = port()
.br
.RE
.RS
.LP
Starts profiling with supplied options\&. All events are stored in the file given by Filename\&. An explicit call to stop/0 is needed to stop profiling\&.
.RE
.LP
.B
start(Filename::string(), MFA::mfa(), Options::[percept_option()]) -> ok | {already_started, Port} | {error, not_started}
.br
.RS
.TP
Types
Port = port()
.br
.RE
.RS
.LP
Starts profiling at the entrypoint specified by the MFA\&. All events are collected, this means that processes outside the scope of the entry-point are also profiled\&. No explicit call to stop/0 is needed, the profiling stops when the entry function returns\&.
.RE
.LP
.B
stop() -> ok | {error, not_started}
.br
.RS
.LP
Stops profiling\&.
.RE
|