Merge pull request #196 from getsentry/remove-use-error-logger

remove use_error_logger configuration

Author: mitchellhenke

README.md

@@ -47,13 +47,22 @@ use Sentry.Plug
 
 ### Capture All Exceptions
 
-This library comes with an extension to capture all Error messages that the Plug handler might not. Simply set `use_error_logger` to true.
+This library comes with an extension to capture all error messages that the Plug handler might not.  This is based on the Erlang [error_logger](http://erlang.org/doc/man/error_logger.html).
 
-This is based on the Erlang [error_logger](http://erlang.org/doc/man/error_logger.html).
+To set this up, add `:ok = :error_logger.add_report_handler(Sentry.Logger)` to your application's start function. Example:
 
 ```elixir
-config :sentry,
-  use_error_logger: true
+def start(_type, _opts) do
+  children = [
+    supervisor(Task.Supervisor, [[name: Sentry.TaskSupervisor]]),
+    :hackney_pool.child_spec(Sentry.Client.hackney_pool_name(),  [timeout: Config.hackney_timeout(), max_connections: Config.max_hackney_connections()])
+  ]
+  opts = [strategy: :one_for_one, name: Sentry.Supervisor]
+
+  :ok = :error_logger.add_report_handler(Sentry.Logger)
+
+  Supervisor.start_link(children, opts)
+end
 ```
 
 ## Configuration
@@ -66,7 +75,6 @@ config :sentry,
 | `tags` | False  | `%{}` | |
 | `release` | False  | None | |
 | `server_name` | False  | None | |
-| `use_error_logger` | False  | False | |
 | `client` | False  | `Sentry.Client` | If you need different functionality for the HTTP client, you can define your own module that implements the `Sentry.HTTPClient` behaviour and set `client` to that module |
 | `hackney_opts` | False  | `[pool: :sentry_pool]` | |
 | `hackney_pool_max_connections` | False  | 50 | |

docs/config.rst

@@ -17,6 +17,21 @@ If using an environment with Plug or Phoenix add the following to your router:
   use Plug.ErrorHandler
   use Sentry.Plug
 
+If you'd like to capture errors from separate processes like `Task` that may crash, add the line ``:ok = :error_logger.add_report_handler(Sentry.Logger)`` to your application's start function:
+
+.. code-block:: elixir
+  def start(_type, _opts) do
+    children = [
+      supervisor(Task.Supervisor, [[name: Sentry.TaskSupervisor]]),
+      :hackney_pool.child_spec(Sentry.Client.hackney_pool_name(),  [timeout: Config.hackney_timeout(), max_connections: Config.max_hackney_connections()])
+    ]
+    opts = [strategy: :one_for_one, name: Sentry.Supervisor]
+
+    :ok = :error_logger.add_report_handler(Sentry.Logger)
+
+    Supervisor.start_link(children, opts)
+  end
+
 Required settings
 ------------------
 
@@ -55,11 +70,6 @@ Optional settings
 
   The name of the server to send with each report. This defaults to nothing.
 
-.. describe:: use_error_logger
-
-  Set this to true if you want to capture all exceptions that occur even outside of a request cycle. This
-  defaults to false.
-
 .. describe:: client
 
   If you need different functionality for the HTTP client, you can define your own module that implements the `Sentry.HTTPClient` behaviour and set `client` to that module.

lib/sentry.ex

@@ -91,8 +91,6 @@ defmodule Sentry do
   See `Sentry.Logger`
   """
 
-  @use_error_logger Config.use_error_logger()
-
   @type task :: {:ok, Task.t} | :error | :excluded | :ignored
 
   def start(_type, _opts) do
@@ -102,10 +100,6 @@ defmodule Sentry do
     ]
     opts = [strategy: :one_for_one, name: Sentry.Supervisor]
 
-    if @use_error_logger do
-      :error_logger.add_report_handler(Sentry.Logger)
-    end
-
     Supervisor.start_link(children, opts)
   end
 

lib/sentry/config.ex

@@ -55,10 +55,6 @@ defmodule Sentry.Config do
     get_config(:client, default: Sentry.Client, check_dsn: false)
   end
 
-  def use_error_logger do
-    get_config(:use_error_logger, default: false, check_dsn: false)
-  end
-
   def root_source_code_path do
     path = get_config(:root_source_code_path)
 

lib/sentry/logger.ex

@@ -1,14 +1,23 @@
 defmodule Sentry.Logger do
   require Logger
   @moduledoc """
-    Use this if you'd like to capture all Error messages that the Plug handler might not. Simply set `use_error_logger` to true.
+  This is based on the Erlang [error_logger](http://erlang.org/doc/man/error_logger.html).
 
-    This is based on the Erlang [error_logger](http://erlang.org/doc/man/error_logger.html).
+  To set this up, add `:ok = :error_logger.add_report_handler(Sentry.Logger)` to your application's start function. Example:
 
-    ```elixir
-    config :sentry,
-      use_error_logger: true
-    ```
+  ```elixir
+  def start(_type, _opts) do
+    children = [
+      supervisor(Task.Supervisor, [[name: Sentry.TaskSupervisor]]),
+      :hackney_pool.child_spec(Sentry.Client.hackney_pool_name(),  [timeout: Config.hackney_timeout(), max_connections: Config.max_hackney_connections()])
+    ]
+    opts = [strategy: :one_for_one, name: Sentry.Supervisor]
+
+    :ok = :error_logger.add_report_handler(Sentry.Logger)
+
+    Supervisor.start_link(children, opts)
+  end
+  ```
   """
 
   use GenEvent