Module erlang_passage

Description
Data Types
Function Index
Function Details

erlang module wrapper for providing tracing facility.

Description

erlang module wrapper for providing tracing facility.

The tracing facility is based on passage.

Data Types

spawn_option()

spawn_option() = {span, passage:maybe_span()} | {span_reference_type, passage:ref_type()} | {start_span, passage:operation_name()} | {start_span_options, passage:start_span_options()} | (ErlangSpawnOption::term())

span: The current span. This is used as the parent span of the spawned process. The default value is passage:maybe_span().
span_reference_type: The span reference type between the current span and the span of the spawned process. The default value is follows_from.
start_span: If this option presents, a new span will be automatically started in the spawned process.
start_span_options: Options for the starting span in the spawned process. If start_span option is absent, this will be ignored. The default value is [].
ErlangSpawnOption: Other options defined in erlang module. See the description of erlang:spawn_opt/4 for more details.

spawn_options()

spawn_options() = [spawn_option()]

Options for spawn_opt functions.

Function Index

spawn/1	Equivalent to `spawn_opt(Fun, [])`.
spawn/2	Equivalent to `spawn_opt(Node, Fun, [])`.
spawn/3	Equivalent to `spawn_opt(Module, Function, Args, [])`.
spawn/4	Equivalent to `spawn_opt(Node, Module, Function, Args, [])`.
spawn_link/1	Equivalent to `spawn_opt(Fun, [link])`.
spawn_link/2	Equivalent to `spawn_opt(Node, Fun, [link])`.
spawn_link/3	Equivalent to `spawn_opt(Module, Function, Args, [link])`.
spawn_link/4	Equivalent to `spawn_opt(Node, Module, Function, Args, [link])`.
spawn_monitor/1	Equivalent to `spawn_opt(Fun, [monitor])`.
spawn_monitor/3	Equivalent to `spawn_opt(Module, Function, Args, [monitor])`.
spawn_opt/2	The same as erlang:spawn_opt/2 except for propagating the current span to the spawned process.
spawn_opt/3	The same as erlang:spawn_opt/3 except for propagating the current span to the spawned process.
spawn_opt/4	Equivalent to `spawn_opt(fun () -> apply(Module, Function, Args) end, Options)`.
spawn_opt/5	Equivalent to `spawn_opt(Node, fun () -> apply(Module, Function, Args) end, Options)`.

Function Details

spawn/1

spawn(Fun::function()) -> pid()

Equivalent to spawn_opt(Fun, []).

spawn/2

spawn(Node::node(), Fun::function()) -> pid()

Equivalent to spawn_opt(Node, Fun, []).

spawn/3

spawn(Module::module(), Function::atom(), Args::[term()]) -> pid()

Equivalent to spawn_opt(Module, Function, Args, []).

spawn/4

spawn(Node::node(), Module::module(), Function::atom(), Args::[term()]) -> pid()

Equivalent to spawn_opt(Node, Module, Function, Args, []).

spawn_link/1

spawn_link(Fun::function()) -> pid()

Equivalent to spawn_opt(Fun, [link]).

spawn_link/2

spawn_link(Node::node(), Fun::function()) -> pid()

Equivalent to spawn_opt(Node, Fun, [link]).

spawn_link/3

spawn_link(Module::module(), Function::atom(), Args::[term()]) -> pid()

Equivalent to spawn_opt(Module, Function, Args, [link]).

spawn_link/4

spawn_link(Node::node(), Module::module(), Function::atom(), Args::[term()]) -> pid()

Equivalent to spawn_opt(Node, Module, Function, Args, [link]).

spawn_monitor/1

spawn_monitor(Fun::function()) -> {pid(), reference()}

Equivalent to spawn_opt(Fun, [monitor]).

spawn_monitor/3

spawn_monitor(Module::module(), Function::atom(), Args::[term()]) -> {pid(), reference()}

Equivalent to spawn_opt(Module, Function, Args, [monitor]).

spawn_opt/2

spawn_opt(Fun::function(), Options::spawn_options()) -> pid() | {pid(), reference()}

The same as erlang:spawn_opt/2 except for propagating the current span to the spawned process.

The propagated span is saved in the process dictionary of the spawned process. So the functions of passage_pd module can be used in the process.

spawn_opt/3

spawn_opt(Node::node(), Fun::function(), Options::spawn_options()) -> pid() | {pid(), reference()}

The same as erlang:spawn_opt/3 except for propagating the current span to the spawned process.

The propagated span is saved in the process dictionary of the spawned process. So the functions of passage_pd module can be used in the process.

If Node has no capability to handle tracing, this will switch to the ordinary erlang:spawn_opt/3 function internally.

spawn_opt/4

spawn_opt(Module::module(), Function::atom(), Args::[term()], Options::spawn_options()) -> pid() | {pid(), reference()}

Equivalent to spawn_opt(fun () -> apply(Module, Function, Args) end, Options).

spawn_opt/5

spawn_opt(Node::node(), Module::module(), Function::atom(), Args::[term()], Options::spawn_options()) -> pid() | {pid(), reference()}

Equivalent to spawn_opt(Node, fun () -> apply(Module, Function, Args) end, Options).

Generated by EDoc, Nov 4 2017, 15:50:32.