Merge pull request #201 from getsentry/do-not-require-enable-source-code

do not require enable_source_code_context configuration

Author: mitchellhenke

README.md

@@ -84,7 +84,7 @@ end
 | `sample_rate` | False | 1.0 | |
 | `in_app_module_whitelist` | False | `[]` | |
 | `report_deps` | False | True | Will attempt to load Mix dependencies at compile time to report alongside events |
-| `enable_source_code_context` | True | | |
+| `enable_source_code_context` | False | False | |
 | `root_source_code_path` | Required if `enable_source_code_context` is enabled | | Should generally be set to `File.cwd!`|
 | `context_lines` | False  | 3 | |
 | `source_code_exclude_patterns` | False  | `[~r"/_build/", ~r"/deps/", ~r"/priv/"]` | |

docs/config.rst

@@ -44,10 +44,6 @@ Required settings
 
   The DSN provided by Sentry.
 
-.. describe:: enable_source_code_context
-
-  When true, Sentry will read and store source code files to report the source code that caused an exception.
-
 .. describe:: root_source_code_path
 
   This is only required if ``enable_source_code_context`` is enabled.  Should generally be set to ``File.cwd!``.
@@ -112,6 +108,10 @@ Optional settings
 
   Will attempt to load Mix dependencies at runtime to report alongside events.  Defaults to `true`.
 
+.. describe:: enable_source_code_context
+
+  When true, Sentry will read and store source code files to report the source code that caused an exception.
+
 .. describe:: context_lines
 
   The number of lines of source code before and after the line that caused the exception to be included.  Defaults to ``3``.

lib/sentry/config.ex

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

lib/sentry/event.ex

@@ -35,7 +35,7 @@ defmodule Sentry.Event do
   @type t :: %__MODULE__{}
 
   alias Sentry.{Event, Util, Config}
-  @source_code_context_enabled Application.fetch_env!(:sentry, :enable_source_code_context)
+  @source_code_context_enabled Config.enable_source_code_context()
   @source_files if(@source_code_context_enabled, do: Sentry.Sources.load_files(), else: nil)
 
   @enable_deps_reporting Config.report_deps()