@spec report(String.t() | Exception.t(), Keyword.t(), Exception.stacktrace()) :: :ok

Reports an exception via the logs, traces, and other third party services.

Emits a Logger.error message with correctly formatted metadata. Sets the current APM trace to error and attaches the exception. Possibly reports the error to third party services like Sentry or Slack via APIs.

Exceptions

This function works on Exception structs. If you pass it in a binary, it will create a new RuntimeError exception with the binary as the message.

Examples

# This will report a new RuntimeError with the message of
# "something went wrong" and a stacktrace.
def do_something() do
  report("something went wrong")
  :ok
end

# This will report the exception and rewrite the message
# with "something went wrong" but using the stacktrace from
# this catch block.
def process_message(message) do
  # do something
catch
  error ->
    report(error, [message: "something went wrong"], __STACKTRACE__)
    :error
end

# This will report the error received from `do_process_event/1`
# adding event metadata and fetching the stacktrace.
def process_event(event) do
  with {:error, error} <- do_process_event(event) do
    report(error, event: event)
    {:error, error}
  end
end