Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
safe(r) Oban telemetry (#3743)
ruslandoga423f72a0ad40
diff --git a/lib/oban_error_reporter.ex b/lib/oban_error_reporter.exindex d9c3b46795..fcd97f61dc 100644--- a/lib/oban_error_reporter.ex+++ b/lib/oban_error_reporter.ex@@ -1,5 +1,20 @@defmodule ObanErrorReporter do- def handle_event([:oban, :job, :exception], measure, %{job: job} = meta, _) do+ require Logger++ def handle_event(name, measurements, metadata, _) do+ # handling telemetry event in a try/catch block+ # to avoid handler detachment in the case of an error+ # see https://hexdocs.pm/telemetry/telemetry.html#attach/4+ try do+ handle_event(name, measurements, metadata)+ catch+ kind, reason ->+ message = Exception.format(kind, reason, __STACKTRACE__)+ Logger.error(message)+ end+ end++ defp handle_event([:oban, :job, :exception], measure, %{job: job} = meta) doextra =job|> Map.take([:id, :args, :meta, :queue, :worker])@@ -10,13 +25,13 @@ defmodule ObanErrorReporter doSentry.capture_exception(meta.reason, stacktrace: meta.stacktrace, extra: extra)end- def handle_event([:oban, :notifier, :exception], _timing, meta, _) do+ defp handle_event([:oban, :notifier, :exception], _timing, meta) doextra = Map.take(meta, ~w(channel payload)a)Sentry.capture_exception(meta.reason, stacktrace: meta.stacktrace, extra: extra)end- def handle_event([:oban, :plugin, :exception], _timing, meta, _) do+ defp handle_event([:oban, :plugin, :exception], _timing, meta) doextra = Map.take(meta, ~w(plugin)a)Sentry.capture_exception(meta.reason, stacktrace: meta.stacktrace, extra: extra)diff --git a/test/workers/oban_error_reporter_test.exs b/test/workers/oban_error_reporter_test.exsnew file mode 100644index 0000000000..7bbac9d7c6--- /dev/null+++ b/test/workers/oban_error_reporter_test.exs@@ -0,0 +1,43 @@+defmodule ObanErrorReporterTest do+ use ExUnit.Case, async: true++ describe "handle_event/4" do+ setup do+ :telemetry.attach_many(+ "oban-errors-test",+ [[:oban, :job, :exception], [:oban, :notifier, :exception], [:oban, :plugin, :exception]],+ &ObanErrorReporter.handle_event/4,+ %{}+ )++ on_exit(fn -> :ok = :telemetry.detach("oban-errors-test") end)+ end++ @tag :capture_log+ test "doesn't detach on failure" do+ :ok =+ :telemetry.execute(+ [:oban, :job, :exception],+ _bad_measurements = %{},+ _bad_metadata = %{job: :bad_job}+ )++ handlers = :telemetry.list_handlers([:oban, :job, :exception])+ assert Enum.any?(handlers, &(&1.id == "oban-errors-test"))+ end++ test "logs an error on failure" do+ log =+ ExUnit.CaptureLog.capture_log(fn ->+ :ok =+ :telemetry.execute(+ [:oban, :job, :exception],+ _bad_measurements = %{},+ _bad_metadata = %{job: :bad_job}+ )+ end)++ assert log =~ "[error] ** (BadMapError) expected a map, got: :bad_job"+ end+ end+end