Honeybadger v0.14.0 Honeybadger.Filter behaviour View Source
Specification of user overrideable filter functions.
See moduledoc for Honeybadger.Filter.Mixin
for details on implementing
your own filter.
Link to this section Summary
Callbacks
Filter breadcrumbs. This filter function recieves a list of Breadcrumb structs. You could use any Enum function to constrain the set. Let's say you want to remove any breadcrumb that have metadata that contain SSN
For applications that use Honeybadger.Plug
, filter the cgi_data.
Filter the context Map. The context is a map of application supplied data.
Filter the error message string. This is the message from the most recently thrown error.
For applications that use Honeybadger.Plug
, filters the query parameters.
The parameters is a map of String.t
to String.t
, e.g.
For applications that use Honeybadger.Plug
, filter the session.
Link to this section Callbacks
filter_breadcrumbs(list)
View Sourcefilter_breadcrumbs([Honeybadger.Breadcrumbs.Breadcrumb.t()]) :: [ Honeybadger.Breadcrumbs.Breadcrumb.t() ]
Filter breadcrumbs. This filter function recieves a list of Breadcrumb structs. You could use any Enum function to constrain the set. Let's say you want to remove any breadcrumb that have metadata that contain SSN:
def filter_breadcrumbs(breadcrumbs) do Enum.reject(breadcrumbs, fn breadcrumb -> do
Map.has_key?(breadcrumb.metadata, :ssn)
end) end
For applications that use Honeybadger.Plug
, filter the cgi_data.
cgi_data
is a map of String.t
to String.t
which includes HTTP headers
and other pre-defined request data (including PATH_INFO
, QUERY_STRING
,
SERVER_PORT
etc.).
Filter the context Map. The context is a map of application supplied data.
Filter the error message string. This is the message from the most recently thrown error.
For applications that use Honeybadger.Plug
, filters the query parameters.
The parameters is a map of String.t
to String.t
, e.g.:
%{"user_name" => "fred", "password" => "12345"}
For applications that use Honeybadger.Plug
, filter the session.