sentry docs

Author: mitchellhenke

docs/config.rst

@@ -52,6 +52,11 @@ Optional settings
   Set this to true if you want to capture all exceptions that occur even outside of a request cycle. This
   defaults to false.
 
+.. describe:: filter
+
+  Set this to a module that implements the ``Sentry.EventFilter`` behaviour if you would like to prevent
+  certain exceptions from being sent.  See below for further documentation.
+
 Testing Your Configuration
 --------------------------
 

docs/index.rst

@@ -107,6 +107,33 @@ new process and it fails you might lose your context. That said using the contex
   # adds an breadcrumb to the request to help debug
   Sentry.Context.add_breadcrumb(%{my: "crumb"})
 
+Filtering Events
+--------------
+
+If you would like to prevent certain exceptions, the :filter configuration option
+allows you to implement the ``Sentry.EventFilter`` behaviour.  The first argument is the
+source of the event, and the second is the exception to be sent.  ``Sentry.Plug``
+will have a source of ``:plug``, and ``Sentry.Logger`` will have a source of ``:logger``.
+If an exception does not come from either of those sources, the source will be nil
+unless the ``:event_source`` option is passed to ``Sentry.capture_exception/2``
+
+A configuration like below will prevent sending ``Phoenix.Router.NoRouteError`` from ``Sentry.Plug``, but
+allows other exceptions to be sent.
+
+.. code-block:: elixir
+  # sentry_event_filter.exs
+  defmodule MyApp.SentryEventFilter do
+    @behaviour Sentry.EventFilter
+
+    def exclude_exception?(:plug, %Elixir.Phoenix.Router.NoRouteError{}), do: true
+    def exclude_exception?(_, ), do: false
+  end
+
+  # config.exs
+  config :sentry, filter: MyApp.SentryEventFilter,
+    included_environments: ~w(production staging),
+    environment_name: System.get_env("RELEASE_LEVEL") || "development"
+
 Deep Dive
 ---------
 

docs/usage.rst

@@ -71,6 +71,9 @@ With calls to ``capture_exception`` additional data can be supplied as a keyword
             "email" => "clever-girl"
         }
 
+.. describe:: event_source
+
+    The source of the event.  Used by the `Sentry.EventFilter` behaviour.
 
 Breadcrumbs
 -----------