Parapet.Integration behaviour (parapet v1.0.0)

Copy Markdown View Source

Behaviour for Parapet ecosystem integration adapters.

Every integration adapter that plugs into Parapet.attach/1 implements this behaviour. Adopters activate an integration uniformly via:

Parapet.attach(adapters: [:my_integration])

Declaring @behaviour Parapet.Integration on an adapter module turns a missing or mis-named setup/0 into a compile-time warning, preventing the UndefinedFunctionError that would otherwise surface only at runtime.

Stable

This module is stable as of v1.0.0. Its public API will not change without a major-version bump and a full deprecation cycle. See Stability & Deprecation Policy for details.

Summary

Callbacks

Sets up the integration adapter, attaching telemetry handlers and performing any required initialization. Called by Parapet.attach/1 when this adapter is activated.

Callbacks

setup()

(since 1.0.0)
@callback setup() :: any()

Sets up the integration adapter, attaching telemetry handlers and performing any required initialization. Called by Parapet.attach/1 when this adapter is activated.