Honeybadger.EventFilter behaviour (Honeybadger v0.24.0)

View Source

Specification for filtering instrumented events.

Most users won't need this, but if you need complete control over filtering, implement this behaviour and configure like:

config :honeybadger,
  event_filter: MyApp.MyEventFilter

Summary

Callbacks

Filters all Insights events.

Filters an instrumented telemetry event.

Callbacks

filter_event(event)

@callback filter_event(event :: map()) :: map() | nil

Filters all Insights events.

Parameters

  • event - The current event map

Returns

The filtered metadata map that will be sent to Honeybadger or nil to skip the event.

filter_telemetry_event(data, raw_event, event)

@callback filter_telemetry_event(
  data :: map(),
  raw_event :: map(),
  event :: [atom(), ...]
) :: map() | nil

Filters an instrumented telemetry event.

Parameters

  • data - The current data for the event
  • raw_event - The raw event metadata
  • event - The telemetry event being processed, e.g. [:phoenix, :endpoint, :start]

Returns

The filtered metadata map that will be sent to Honeybadger or nil to skip the event.