|
| 1 | +defmodule Sentry.Config do |
| 2 | + @moduledoc """ |
| 3 | + This module provides the functionality for fetching configuration settings and their defaults. |
| 4 | + """ |
| 5 | + |
| 6 | + @default_included_environments [:dev, :test, :prod] |
| 7 | + @default_environment_name Mix.env |
| 8 | + @default_max_hackney_connections 50 |
| 9 | + @default_hackney_timeout 5000 |
| 10 | + @default_exclude_patterns [~r"/_build/", ~r"/deps/", ~r"/priv/"] |
| 11 | + @default_path_pattern "**/*.ex" |
| 12 | + @default_context_lines 3 |
| 13 | + @default_sample_rate 1.0 |
| 14 | + |
| 15 | + def validate_config! do |
| 16 | + end |
| 17 | + |
| 18 | + def dsn do |
| 19 | + get_config(:dsn, check_dsn: false) |
| 20 | + end |
| 21 | + |
| 22 | + def included_environments do |
| 23 | + get_config(:included_environments, default: @default_included_environments, check_dsn: false) |
| 24 | + end |
| 25 | + |
| 26 | + def environment_name do |
| 27 | + get_config(:environment_name, default: @default_environment_name) |
| 28 | + end |
| 29 | + |
| 30 | + def max_hackney_connections do |
| 31 | + get_config(:hackney_pool_max_connections, default: @default_max_hackney_connections, check_dsn: false) |
| 32 | + end |
| 33 | + |
| 34 | + def hackney_timeout do |
| 35 | + get_config(:hackney_pool_timeout, default: @default_hackney_timeout, check_dsn: false) |
| 36 | + end |
| 37 | + |
| 38 | + def tags do |
| 39 | + get_config(:tags, default: %{}, check_dsn: false) |
| 40 | + end |
| 41 | + |
| 42 | + def release do |
| 43 | + get_config(:release) |
| 44 | + end |
| 45 | + |
| 46 | + def server_name do |
| 47 | + get_config(:server_name) |
| 48 | + end |
| 49 | + |
| 50 | + def filter do |
| 51 | + get_config(:filter, default: Sentry.DefaultEventFilter, check_dsn: false) |
| 52 | + end |
| 53 | + |
| 54 | + def client do |
| 55 | + get_config(:client, default: Sentry.Client, check_dsn: false) |
| 56 | + end |
| 57 | + |
| 58 | + def use_error_logger do |
| 59 | + get_config(:use_error_logger, default: false, check_dsn: false) |
| 60 | + end |
| 61 | + |
| 62 | + def root_source_code_path do |
| 63 | + path = get_config(:root_source_code_path) |
| 64 | + |
| 65 | + if path do |
| 66 | + path |
| 67 | + else |
| 68 | + raise ArgumentError.exception(":root_source_code_path must be configured") |
| 69 | + end |
| 70 | + end |
| 71 | + |
| 72 | + def source_code_path_pattern do |
| 73 | + get_config(:source_code_path_pattern, default: @default_path_pattern) |
| 74 | + end |
| 75 | + |
| 76 | + def source_code_exclude_patterns do |
| 77 | + get_config(:source_code_exclude_patterns, default: @default_exclude_patterns, check_dsn: false) |
| 78 | + end |
| 79 | + |
| 80 | + def context_lines do |
| 81 | + get_config(:context_lines, default: @default_context_lines, check_dsn: false) |
| 82 | + end |
| 83 | + |
| 84 | + def in_app_module_whitelist do |
| 85 | + get_config(:in_app_module_whitelist, default: [], check_dsn: false) |
| 86 | + end |
| 87 | + |
| 88 | + def sample_rate do |
| 89 | + get_config(:sample_rate, default: @default_sample_rate, check_dsn: false) |
| 90 | + end |
| 91 | + |
| 92 | + def hackney_opts do |
| 93 | + get_config(:hackney_opts, default: [], check_dsn: false) |
| 94 | + end |
| 95 | + |
| 96 | + def before_send_event do |
| 97 | + get_config(:before_send_event, check_dsn: false) |
| 98 | + end |
| 99 | + |
| 100 | + def after_send_event do |
| 101 | + get_config(:after_send_event, check_dsn: false) |
| 102 | + end |
| 103 | + |
| 104 | + defp get_config(key, opts \\ []) when is_atom(key) do |
| 105 | + default = Keyword.get(opts, :default) |
| 106 | + check_dsn = Keyword.get(opts, :check_dsn, true) |
| 107 | + |
| 108 | + environment_result = case get_from_application_environment(key) do |
| 109 | + {:ok, value} -> {:ok, value} |
| 110 | + :not_found -> get_from_system_environment(config_key_to_system_environment_key(key)) |
| 111 | + end |
| 112 | + |
| 113 | + result = case environment_result do |
| 114 | + {:ok, value} -> {:ok, value} |
| 115 | + :not_found -> if(check_dsn, do: get_from_dsn_query_string(Atom.to_string(key)), else: :not_found) |
| 116 | + end |
| 117 | + |
| 118 | + case result do |
| 119 | + {:ok, value} -> value |
| 120 | + :not_found -> default |
| 121 | + end |
| 122 | + end |
| 123 | + |
| 124 | + defp get_from_application_environment(key) when is_atom(key) do |
| 125 | + case Application.fetch_env(:sentry, key) do |
| 126 | + {:ok, {:system, env_var}} -> get_from_system_environment(env_var) |
| 127 | + {:ok, value} -> {:ok, value} |
| 128 | + :error -> :not_found |
| 129 | + end |
| 130 | + end |
| 131 | + |
| 132 | + defp get_from_system_environment(key) when is_binary(key) do |
| 133 | + case System.get_env(key) do |
| 134 | + nil -> :not_found |
| 135 | + value -> {:ok, value} |
| 136 | + end |
| 137 | + end |
| 138 | + |
| 139 | + defp get_from_dsn_query_string(key) when is_binary(key) do |
| 140 | + sentry_dsn = dsn() |
| 141 | + |
| 142 | + if sentry_dsn do |
| 143 | + %URI{query: query} = URI.parse(sentry_dsn) |
| 144 | + query = query || "" |
| 145 | + result = URI.decode_query(query) |
| 146 | + |> Map.fetch(key) |
| 147 | + |
| 148 | + case result do |
| 149 | + {:ok, value} -> {:ok, value} |
| 150 | + :error -> :not_found |
| 151 | + end |
| 152 | + else |
| 153 | + :not_found |
| 154 | + end |
| 155 | + end |
| 156 | + |
| 157 | + defp config_key_to_system_environment_key(key) when is_atom(key) do |
| 158 | + string_key = Atom.to_string(key) |
| 159 | + |> String.upcase |
| 160 | + |
| 161 | + "SENTRY_#{string_key}" |
| 162 | + end |
| 163 | +end |
0 commit comments