use before_send_event to filter

Author: mitchellhenke

lib/sentry.ex

@@ -117,9 +117,9 @@ defmodule Sentry do
   @spec capture_exception(Exception.t() | atom() | {atom(), atom()}, Keyword.t()) :: send_result
   def capture_exception(exception, opts \\ []) do
     filter_module = Config.filter()
-    {source, opts} = Keyword.pop(opts, :event_source)
+    event_source = Keyword.get(opts, :event_source)
 
-    if filter_module.exclude_exception?(exception, source) do
+    if filter_module.exclude_exception?(exception, event_source) do
       :excluded
     else
       exception

lib/sentry/client.ex

@@ -40,7 +40,8 @@ defmodule Sentry.Client do
 
   require Logger
 
-  @type send_event_result :: {:ok, Task.t() | String.t() | pid()} | :error | :unsampled
+  @type send_event_result ::
+          {:ok, Task.t() | String.t() | pid()} | :error | :unsampled | :excluded
   @type dsn :: {String.t(), String.t(), String.t()} | :error
   @sentry_version 5
   @max_attempts 4
@@ -66,10 +67,15 @@ defmodule Sentry.Client do
 
     event = maybe_call_before_send_event(event)
 
-    if sample_event?(sample_rate) do
-      encode_and_send(event, result)
-    else
-      :unsampled
+    case {event, sample_event?(sample_rate)} do
+      {false, _} ->
+        :excluded
+
+      {%Event{}, false} ->
+        :unsampled
+
+      {%Event{}, true} ->
+        encode_and_send(event, result)
     end
   end
 
@@ -257,14 +263,14 @@ defmodule Sentry.Client do
     result
   end
 
-  @spec maybe_call_before_send_event(Event.t()) :: Event.t()
+  @spec maybe_call_before_send_event(Event.t()) :: Event.t() | false
   def maybe_call_before_send_event(event) do
     case Config.before_send_event() do
       function when is_function(function, 1) ->
-        function.(event)
+        function.(event) || false
 
       {module, function} ->
-        apply(module, function, [event])
+        apply(module, function, [event]) || false
 
       nil ->
         event

lib/sentry/event.ex

@@ -20,6 +20,7 @@ defmodule Sentry.Event do
             server_name: nil,
             environment: nil,
             exception: nil,
+            original_exception: nil,
             release: nil,
             stacktrace: %{
               frames: []
@@ -29,7 +30,8 @@ defmodule Sentry.Event do
             user: %{},
             breadcrumbs: [],
             fingerprint: [],
-            modules: %{}
+            modules: %{},
+            event_source: nil
 
   @type t :: %__MODULE__{}
 
@@ -47,14 +49,16 @@ defmodule Sentry.Event do
   @doc """
   Creates an Event struct out of context collected and options
   ## Options
-    * `:exception` - expection
+    * `:exception` - Sentry-formatted exception
+    * `:original_exception` - Original exception
     * `:message` - message
     * `:stacktrace` - a list of Exception.stacktrace()
     * `:extra` - map of extra context
     * `:user` - map of user context
     * `:tags` - map of tags context
     * `:request` - map of request context
     * `:breadcrumbs` - list of breadcrumbs
+    * `:event_source` - the source of the event
     * `:level` - error level
     * `:fingerprint` -  list of the fingerprint for grouping this event
   """
@@ -69,9 +73,12 @@ defmodule Sentry.Event do
     } = Sentry.Context.get_all()
 
     exception = Keyword.get(opts, :exception)
+    original_exception = Keyword.get(opts, :original_exception)
 
     message = Keyword.get(opts, :message)
 
+    event_source = Keyword.get(opts, :event_source)
+
     stacktrace =
       Keyword.get(opts, :stacktrace, [])
       |> coerce_stacktrace()
@@ -113,6 +120,7 @@ defmodule Sentry.Event do
       environment: env,
       server_name: server_name,
       exception: exception,
+      original_exception: original_exception,
       stacktrace: %{
         frames: stacktrace_to_frames(stacktrace)
       },
@@ -123,7 +131,8 @@ defmodule Sentry.Event do
       breadcrumbs: breadcrumbs,
       request: request,
       fingerprint: fingerprint,
-      modules: Util.mix_deps_versions(@deps)
+      modules: Util.mix_deps_versions(@deps),
+      event_source: event_source
     }
     |> add_metadata()
   end
@@ -163,7 +172,7 @@ defmodule Sentry.Event do
       end
 
     module = Keyword.get(opts, :module)
-    exception = [%{type: type, value: value, module: module}]
+    transformed_exception = [%{type: type, value: value, module: module}]
 
     message =
       :error
@@ -172,8 +181,9 @@ defmodule Sentry.Event do
       |> String.trim()
 
     opts
-    |> Keyword.put(:exception, exception)
+    |> Keyword.put(:exception, transformed_exception)
     |> Keyword.put(:message, message)
+    |> Keyword.put(:original_exception, exception)
     |> create_event()
   end