Honeybadger.Filter behaviour (Honeybadger v0.16.0) 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 receives 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

Link to this callback

filter_breadcrumbs(list)

View Source

Specs

filter_breadcrumbs([Honeybadger.Breadcrumbs.Breadcrumb.t()]) :: [
  Honeybadger.Breadcrumbs.Breadcrumb.t()
]

Filter breadcrumbs. This filter function receives 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

Specs

filter_cgi_data(map()) :: map()

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.).

Specs

filter_context(map()) :: map()

Filter the context Map. The context is a map of application supplied data.

Link to this callback

filter_error_message(arg1)

View Source

Specs

filter_error_message(String.t()) :: String.t()

Filter the error message string. This is the message from the most recently thrown error.

Specs

filter_params(map()) :: map()

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"}

Specs

filter_session(map()) :: map()

For applications that use Honeybadger.Plug, filter the session.