module for any and all configuration

Author: mitchellhenke

lib/mix/tasks/sentry.send_test_event.ex

@@ -1,5 +1,6 @@
 defmodule Mix.Tasks.Sentry.SendTestEvent do
   use Mix.Task
+  alias Sentry.Config
 
   @shortdoc "Attempts to send a test event to check Sentry configuration"
   @moduledoc """
@@ -21,8 +22,8 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
     Mix.shell.info "public_key: #{public_key}"
     Mix.shell.info "secret_key: #{secret_key}"
     Mix.shell.info "included_environments: #{inspect included_environments()}"
-    Mix.shell.info "current environment_name: #{inspect environment_name()}"
-    Mix.shell.info "hackney_opts: #{inspect hackney_opts()}\n"
+    Mix.shell.info "current environment_name: #{inspect Config.environment_name()}"
+    Mix.shell.info "hackney_opts: #{inspect Config.hackney_opts()}\n"
   end
 
   defp included_environments do
@@ -33,12 +34,8 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
     end
   end
 
-  defp environment_name, do: Application.get_env(:sentry, :environment_name)
-
-  defp hackney_opts, do: Application.get_env(:sentry, :hackney_opts, [])
-
   defp maybe_send_event do
-    env_name = environment_name()
+    env_name = Config.environment_name()
     included_envs = included_environments()
 
     if env_name in included_envs do

lib/sentry.ex

@@ -1,7 +1,7 @@
 defmodule Sentry do
   use Application
   import Supervisor.Spec
-  alias Sentry.Event
+  alias Sentry.{Event, Config}
   require Logger
 
   @moduledoc """
@@ -91,17 +91,14 @@ defmodule Sentry do
   See `Sentry.Logger`
   """
 
-  @use_error_logger Application.get_env(:sentry, :use_error_logger, false)
-  @default_environment_name Mix.env
-  @max_hackney_connections Application.get_env(:sentry, :hackney_pool_max_connections, 50)
-  @hackney_timeout Application.get_env(:sentry, :hackney_pool_timeout, 5000)
+  @use_error_logger Config.use_error_logger()
 
   @type task :: {:ok, Task.t} | :error | :excluded | :ignored
 
   def start(_type, _opts) do
     children = [
       supervisor(Task.Supervisor, [[name: Sentry.TaskSupervisor]]),
-      :hackney_pool.child_spec(Sentry.Client.hackney_pool_name(),  [timeout: @hackney_timeout, max_connections: @max_hackney_connections])
+      :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]
 
@@ -118,7 +115,7 @@ defmodule Sentry do
   """
   @spec capture_exception(Exception.t, Keyword.t) :: task
   def capture_exception(exception, opts \\ []) do
-    filter_module = Application.get_env(:sentry, :filter, Sentry.DefaultEventFilter)
+    filter_module = Config.filter()
     {source, opts} = Keyword.pop(opts, :event_source)
 
     if filter_module.exclude_exception?(exception, source) do
@@ -156,9 +153,9 @@ defmodule Sentry do
     :ignored
   end
   def send_event(%Event{} = event, opts) do
-    included_environments = Application.get_env(:sentry, :included_environments, [:dev, :test, :prod])
-    environment_name = Application.get_env(:sentry, :environment_name, @default_environment_name)
-    client = Application.get_env(:sentry, :client, Sentry.Client)
+    included_environments = Config.included_environments()
+    environment_name = Config.environment_name()
+    client = Config.client()
 
     if environment_name in included_environments do
       client.send_event(event, opts)

lib/sentry/client.ex

@@ -34,14 +34,13 @@ defmodule Sentry.Client do
         end
   """
 
-  alias Sentry.{Event, Util}
+  alias Sentry.{Event, Util, Config}
 
   require Logger
 
   @type get_dsn :: {String.t, String.t, Integer.t}
   @sentry_version 5
   @max_attempts 4
-  @default_sample_rate 1.0
   @hackney_pool_name :sentry_pool
 
   quote do
@@ -60,7 +59,7 @@ defmodule Sentry.Client do
   @spec send_event(Event.t) :: {:ok, Task.t | String.t} | :error | :unsampled
   def send_event(%Event{} = event, opts \\ []) do
     result = Keyword.get(opts, :result, :async)
-    sample_rate = Keyword.get(opts, :sample_rate) || Application.get_env(:sentry, :sample_rate, @default_sample_rate)
+    sample_rate = Keyword.get(opts, :sample_rate) || Config.sample_rate()
 
     event = maybe_call_before_send_event(event)
 
@@ -126,7 +125,7 @@ defmodule Sentry.Client do
   Hackney options can be set via the `hackney_opts` configuration option.
   """
   def request(method, url, headers, body) do
-    hackney_opts = Application.get_env(:sentry, :hackney_opts, [])
+    hackney_opts = Config.hackney_opts()
                    |> Keyword.put_new(:pool, @hackney_pool_name)
     with {:ok, 200, _, client} <- :hackney.request(method, url, headers, body, hackney_opts),
          {:ok, body} <- :hackney.body(client),
@@ -186,7 +185,7 @@ defmodule Sentry.Client do
   end
 
   def maybe_call_after_send_event(result, event) do
-    case Application.get_env(:sentry, :after_send_event) do
+    case Config.after_send_event() do
       function when is_function(function, 2) ->
         function.(event, result)
       {module, function} ->
@@ -201,7 +200,7 @@ defmodule Sentry.Client do
   end
 
   def maybe_call_before_send_event(event) do
-    case Application.get_env(:sentry, :before_send_event) do
+    case Config.before_send_event do
       function when is_function(function, 1) ->
         function.(event)
       {module, function} ->

lib/sentry/config.ex

@@ -0,0 +1,89 @@
+defmodule Sentry.Config do
+  @default_included_environments [:dev, :test, :prod]
+  @default_environment_name Mix.env
+  @default_max_hackney_connections 50
+  @default_hackney_timeout 5000
+  @default_exclude_patterns [~r"/_build/", ~r"/deps/", ~r"/priv/"]
+  @default_path_pattern "**/*.ex"
+  @default_context_lines 3
+  @default_sample_rate 1.0
+
+  def validate_config! do
+  end
+
+  def included_environments do
+    Application.get_env(:sentry, :included_environments, @default_included_environments)
+  end
+
+  def environment_name do
+    Application.get_env(:sentry, :environment_name, @default_environment_name)
+  end
+
+  def max_hackney_connections do
+    Application.get_env(:sentry, :hackney_pool_max_connections, @default_max_hackney_connections)
+  end
+
+  def hackney_timeout do
+    Application.get_env(:sentry, :hackney_pool_timeout, @default_hackney_timeout)
+  end
+
+  def tags do
+    Application.get_env(:sentry, :tags, %{})
+  end
+
+  def release do
+    Application.get_env(:sentry, :release)
+  end
+
+  def server_name do
+    Application.get_env(:sentry, :server_name)
+  end
+
+  def filter do
+    Application.get_env(:sentry, :filter, Sentry.DefaultEventFilter)
+  end
+
+  def client do
+    Application.get_env(:sentry, :client, Sentry.Client)
+  end
+
+  def use_error_logger do
+    Application.get_env(:sentry, :use_error_logger, false)
+  end
+
+  def root_path do
+    Application.fetch_env!(:sentry, :root_source_code_path)
+  end
+
+  def path_pattern do
+    Application.get_env(:sentry, :source_code_path_pattern, @default_path_pattern)
+  end
+
+  def exclude_patterns do
+    Application.get_env(:sentry, :source_code_exclude_patterns, @default_exclude_patterns)
+  end
+
+  def context_lines do
+    Application.get_env(:sentry, :context_lines, @default_context_lines)
+  end
+
+  def in_app_module_whitelist do
+    Application.get_env(:sentry, :in_app_module_whitelist, [])
+  end
+
+  def sample_rate do
+    Application.get_env(:sentry, :sample_rate, @default_sample_rate)
+  end
+
+  def hackney_opts do
+    Application.get_env(:sentry, :hackney_opts, [])
+  end
+
+  def before_send_event do
+    Application.get_env(:sentry, :before_send_event)
+  end
+
+  def after_send_event do
+    Application.get_env(:sentry, :after_send_event)
+  end
+end

lib/sentry/event.ex

@@ -32,7 +32,7 @@ defmodule Sentry.Event do
 
   @type t :: %__MODULE__{}
 
-  alias Sentry.{Event, Util}
+  alias Sentry.{Event, Util, Config}
   @source_code_context_enabled Application.fetch_env!(:sentry, :enable_source_code_context)
   @source_files if(@source_code_context_enabled, do: Sentry.Sources.load_files(), else: nil)
 
@@ -70,7 +70,7 @@ defmodule Sentry.Event do
             |> Map.merge(Keyword.get(opts, :extra, %{}))
     user = user_context
            |> Map.merge(Keyword.get(opts, :user, %{}))
-    tags = Application.get_env(:sentry, :tags, %{})
+    tags = Config.tags()
            |> Map.merge(tags_context)
            |> Map.merge(Keyword.get(opts, :tags, %{}))
     request = request_context
@@ -79,11 +79,11 @@ defmodule Sentry.Event do
 
     level = Keyword.get(opts, :level, "error")
 
-    release = Application.get_env(:sentry, :release)
+    release = Config.release()
 
-    server_name = Application.get_env(:sentry, :server_name)
+    server_name = Config.server_name()
 
-    env = Application.get_env(:sentry, :environment_name)
+    env = Config.environment_name()
 
     %Event{
       culprit: culprit_from_stacktrace(stacktrace),
@@ -160,7 +160,7 @@ defmodule Sentry.Event do
 
   @spec stacktrace_to_frames(Exception.stacktrace) :: [map]
   def stacktrace_to_frames(stacktrace) do
-    in_app_module_whitelist = Application.get_env(:sentry, :in_app_module_whitelist, [])
+    in_app_module_whitelist = Config.in_app_module_whitelist()
     stacktrace
     |> Enum.map(fn(line) ->
         {mod, function, arity, location} = line

lib/sentry/sources.ex

@@ -1,4 +1,5 @@
 defmodule Sentry.Sources do
+  alias Sentry.Config
   @moduledoc """
   This module is responsible for providing functionality that stores
   the text of source files during compilation for displaying the
@@ -49,14 +50,10 @@ defmodule Sentry.Sources do
   @type file_map :: %{pos_integer() => String.t}
   @type source_map :: %{String.t => file_map}
 
-  @default_exclude_patterns [~r"/_build/", ~r"/deps/", ~r"/priv/"]
-  @default_path_pattern "**/*.ex"
-  @default_context_lines 3
-
   def load_files do
-    root_path = Application.fetch_env!(:sentry, :root_source_code_path)
-    path_pattern = Application.get_env(:sentry, :source_code_path_pattern, @default_path_pattern)
-    exclude_patterns = Application.get_env(:sentry, :source_code_exclude_patterns, @default_exclude_patterns)
+    root_path = Config.root_path()
+    path_pattern = Config.path_pattern()
+    exclude_patterns = Config.exclude_patterns()
 
     Path.join(root_path, path_pattern)
     |> Path.wildcard()
@@ -83,7 +80,7 @@ defmodule Sentry.Sources do
   """
   @spec get_source_context(source_map, String.t, pos_integer()) :: {[String.t], String.t | nil, [String.t]}
   def get_source_context(files, file_name, line_number) do
-    context_lines = Application.get_env(:sentry, :context_lines, @default_context_lines)
+    context_lines = Config.context_lines()
     file = Map.get(files, file_name)
 
     do_get_source_context(file, line_number, context_lines)