ErrorTracker.Ignorer behaviour (ErrorTracker v0.7.0)

Behaviour for ignoring errors.

Ignoring vs muting errors

Ignoring an error keeps it from being tracked by the ErrorTracker. While this may be useful in certain cases, in other cases you may prefer to track the error but don't send telemetry events. Take a look at the ErrorTracker.mute/1 function to see how to mute errors.

The ErrorTracker tracks every error that happens in your application. In certain cases you may want to ignore some errors and don't track them. To do so you can implement this behaviour.

defmodule MyApp.ErrorIgnorer do
  @behaviour ErrorTracker.Ignorer

  @impl true
  def ignore?(error = %ErrorTracker.Error{}, context) do
    # return true if the error should be ignored
  end
end

Once implemented, include it in the ErrorTracker configuration:

config :error_tracker, ignorer: MyApp.ErrorIgnorer

With this configuration in place, the ErrorTracker will call MyApp.ErrorIgnorer.ignore?/2 before tracking errors. If the function returns true the error will be ignored and won't be tracked.

A note on performance

Keep in mind that the ignore?/2 will be called in the context of the ErrorTracker itself. Slow code will have a significant impact in the ErrorTracker performance. Buggy code can bring the ErrorTracker process down.

Summary

Callbacks

ignore?(error, context)

Decide wether the given error should be ignored or not.

Callbacks

ignore?(error, context)

@callback ignore?(error :: ErrorTracker.Error.t(), context :: map()) :: boolean()

Decide wether the given error should be ignored or not.

This function receives both the current Error and context and should return a boolean indicating if it should be ignored or not. If the function returns true the error will be ignored, otherwise it will be tracked.