Module percept_profile

Description
Data Types
Function Index
Function Details

Percept Collector.

Description

Percept Collector

This module provides the user interface for the percept data collection (profiling).

Data Types

percept_option()

percept_option() = procs | ports | exclusive

Function Index

start/1	Equivalent to `start(Filename, [procs])`.
start/2	Starts profiling with supplied options.
start/3	Starts profiling at the entrypoint specified by the MFA.
stop/0	Stops profiling.

Function Details

start/1

start(Filename::string()) -> {ok, Port} | {already_started, Port}

Equivalent to start(Filename, [procs]).

start/2

start(Filename::string(), Options::[percept_option()]) -> {ok, Port} | {already_started, Port}

Port = port()

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.

start/3

start(Filename::string(), MFA::mfa(), Options::[percept_option()]) -> ok | {already_started, Port} | {error, not_started}

Port = port()

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.

stop/0

stop() -> ok | {error, not_started}

Stops profiling.

Generated by EDoc