Selecto.Performance.HookBehaviour behaviour (Selecto v0.4.5)

Behaviour for implementing custom performance monitoring hooks.

Modules implementing this behaviour can be used as hook providers for the Selecto performance monitoring system.

Summary

context()

hook_fn()

hook_point()

Handle a hook point execution.

init(opts)

Initialize the hook provider.

Clean up resources when the hook provider is unregistered.

@type context() :: map()

@type hook_fn() :: (context() -> context())

@type hook_point() :: atom()

@callback handle_hook(hook_point(), context(), state :: term()) :: context()

Handle a hook point execution.

Receives the hook point name, current context, and provider state. Should return an updated context.

@callback init(opts :: keyword()) :: {:ok, term()} | {:error, term()}

Initialize the hook provider.

Called once when the hook provider is registered. Should return {:ok, state} or {:error, reason}.

(optional)

@callback terminate(reason :: term(), state :: term()) :: :ok

Clean up resources when the hook provider is unregistered.