From f28a1b8086a95d1dbdf018020b9e24ecd8a115f1 Mon Sep 17 00:00:00 2001
From: ruslandoga <doga.ruslan@gmail.com>
Date: Tue, 8 Oct 2024 17:26:35 +0700
Subject: [PATCH] Log Oban errors (and still report them to Sentry) (#4657)

* log oban errors in CE

* update changelog

* not just ce

* add comment
---
 CHANGELOG.md               |  1 +
 lib/oban_error_reporter.ex | 22 ++++++++++++++++------
 2 files changed, 17 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e633739313..3fe057d66a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file.
 
 - Add ability to review and revoke particular logged in user sessions
 - Add ability to change password from user settings screen
+- Add error logs for background jobs plausible/analytics#4657
 
 ### Removed
 
diff --git a/lib/oban_error_reporter.ex b/lib/oban_error_reporter.ex
index a17520c153..1ac0a27c50 100644
--- a/lib/oban_error_reporter.ex
+++ b/lib/oban_error_reporter.ex
@@ -1,4 +1,5 @@
 defmodule ObanErrorReporter do
+  use Plausible
   require Logger
 
   def handle_event(name, measurements, metadata, _) do
@@ -21,20 +22,17 @@ defmodule ObanErrorReporter do
       |> Map.merge(measure)
 
     on_job_exception(job)
-
-    Sentry.capture_exception(meta.reason, stacktrace: meta.stacktrace, extra: extra)
+    capture_error(meta, extra)
   end
 
   defp handle_event([:oban, :notifier, :exception], _timing, meta) do
     extra = Map.take(meta, ~w(channel payload)a)
-
-    Sentry.capture_exception(meta.reason, stacktrace: meta.stacktrace, extra: extra)
+    capture_error(meta, extra)
   end
 
   defp handle_event([:oban, :plugin, :exception], _timing, meta) do
     extra = Map.take(meta, ~w(plugin)a)
-
-    Sentry.capture_exception(meta.reason, stacktrace: meta.stacktrace, extra: extra)
+    capture_error(meta, extra)
   end
 
   defp on_job_exception(%Oban.Job{
@@ -65,4 +63,16 @@ defmodule ObanErrorReporter do
   end
 
   defp on_job_exception(_job), do: :ignore
+
+  # Logs the error and sends it to Sentry
+  defp capture_error(meta, extra) do
+    Logger.error(
+      # this message is ignored by Sentry
+      "Background job (#{inspect(extra)}) failed:\n\n  " <>
+        Exception.format(:error, meta.reason, meta.stacktrace),
+      # Sentry report is built entirely from crash_reason
+      crash_reason: {meta.reason, meta.stacktrace},
+      sentry: %{extra: extra}
+    )
+  end
 end