Module oc_stat_exporter

• Description
• Data Types
• Function Index
• Function Details

Exporter exports the collected records as view data.

This module defines the oc_stat_exporter behaviour.
Required callback functions: export/2.

Data Types

exporter()

      exporter() = module()
      

Function Index

batch_register/1	Register many Exporters at once.
code_change/3
deregister/1	Deregisters an Exporter.
handle_call/3
handle_cast/2
handle_info/2
init/1
register/1	Equivalent to register(Exporter, []).
register/2	Registers an Exporter with Config.
registered/1	Checks whether Exporter is registered.
start_link/0
terminate/2

Function Details

batch_register/1

      batch_register(Exporters) -> ok
      

• Exporters = [exporter()]

Register many Exporters at once.

code_change/3

code_change(OldVsn, State, Extra) -> any()

deregister/1

      deregister(Exporter) -> ok
      

• Exporter = exporter()

Deregisters an Exporter.

handle_call/3

handle_call(X1, From, State) -> any()

handle_cast/2

handle_cast(X1, State) -> any()

handle_info/2

handle_info(X1, State) -> any()

init/1

init(Args) -> any()

register/1

      register(Exporter) -> ok
      

• Exporter = exporter()

Equivalent to register(Exporter, []).

register/2

      register(Exporter, Config) -> ok
      

• Exporter = exporter()
• Config = any()

Registers an Exporter with Config. Collected data will be reported via all the registered exporters. Once you no longer want data to be exported, invoke deregister/1 with the previously registered exporter.

registered/1

      registered(Exporter) -> boolean()
      

• Exporter = exporter()

Checks whether Exporter is registered.

start_link/0

start_link() -> any()

terminate/2

terminate(X1, State) -> any()