---
name: "percept_profile"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:19.2.1+dfsg-2+deb9u3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/percept_profile"
---

# percept\_profile(3erl)

Percept Collector.

## NAME

percept\_profile - Percept Collector.

## DESCRIPTION

Percept Collector

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

## DATA TYPES

- **percept\_option() = procs \| ports \| exclusive:**

  ## EXPORTS

**start(Filename::string()) -\> {ok, Port} \| {already\_started, Port}**\

Equivalent to **start(Filename, \[procs\])**.

**start(Filename::string(), Options::\[percept\_option()\]) -\> {ok, Port} \| {already\_started, Port}**\

Types:

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(Filename::string(), MFA::mfa(), Options::\[percept\_option()\]) -\> ok \| {already\_started, Port} \| {error, not\_started}**\

Types:

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() -\> ok \| {error, not\_started}**\

Stops profiling.

## AUTHORS

*\<\>*