Defines the contract for reporting terminal DAG task errors.

Sentry example

With the :sentry package installed and configured, an adapter can report task errors through Sentry.capture_exception/2:

defmodule MyApp.SentryErrorReporter do
  @behaviour Gust.DAG.Run.ErrorReporter

  @impl true
  def capture(exception, stacktrace, metadata) do
    Sentry.capture_exception(exception, stacktrace: stacktrace, tags: metadata) 
    :ok
  end
end

config :gust,
  error_tracking: [reporter: MyApp.SentryErrorReporter]

Custom Reporter example

Implement capture/3 in an adapter module and configure it under the :error_tracking application environment:

defmodule MyApp.ErrorReporter do
  @behaviour Gust.DAG.Run.ErrorReporter

  @impl true
  def capture(exception, stacktrace, metadata) do
      Req.post!("https://errors.example.com/events",
        json: %{
          message: Exception.message(exception),
          stacktrace: Exception.format_stacktrace(stacktrace),
          metadata: metadata
        }
      )

    :ok
  end
end

config :gust,
  error_tracking: [reporter: MyApp.ErrorReporter]

capture/3 runs asynchronously in Gust.DAG.Run.ErrorReporter.Worker. Exceptions, exits, and throws from an adapter are logged and contained so they cannot interrupt DAG execution.