Add global :extra config (#866)

Author: Gladear

lib/sentry/config.ex

@@ -197,6 +197,14 @@ defmodule Sentry.Config do
       A map of tags to be sent with every event.
       """
     ],
+    extra: [
+      type: {:map, :atom, :any},
+      type_doc: "`t:Sentry.Context.extra/0`",
+      default: %{},
+      doc: """
+      A map of extra data to be sent with every event.
+      """
+    ],
     max_breadcrumbs: [
       type: :non_neg_integer,
       default: 100,
@@ -546,6 +554,9 @@ defmodule Sentry.Config do
   @spec tags() :: map()
   def tags, do: fetch!(:tags)
 
+  @spec extra() :: map()
+  def extra, do: fetch!(:extra)
+
   @spec release() :: String.t() | nil
   def release, do: get(:release)
 

lib/sentry/event.ex

@@ -200,7 +200,11 @@ defmodule Sentry.Event do
       attachments: attachments_context
     } = Sentry.Context.get_all()
 
-    extra = Map.merge(extra_context, Keyword.fetch!(opts, :extra))
+    extra =
+      Config.extra()
+      |> Map.merge(extra_context)
+      |> Map.merge(Keyword.fetch!(opts, :extra))
+
     user = Map.merge(user_context, Keyword.fetch!(opts, :user))
     request = Map.merge(request_context, Keyword.fetch!(opts, :request))
 

test/event_test.exs

@@ -94,6 +94,17 @@ defmodule Sentry.EventTest do
       assert map_size(event.modules) > 0
     end
 
+    test "includes the config defaults" do
+      put_test_config(
+        tags: %{"test-tag" => "test-value"},
+        extra: %{"some-data": "with-a-value"}
+      )
+
+      assert %Event{} = event = Event.create_event([])
+      assert event.tags == %{"test-tag" => "test-value"}
+      assert event.extra == %{"some-data": "with-a-value"}
+    end
+
     test "fills in passed-in options" do
       assert %Event{} = event = Event.create_event(level: :info)
       assert event.level == :info
@@ -144,6 +155,50 @@ defmodule Sentry.EventTest do
       end
     end
 
+    test "fills in `:tags` and `:extra` with precedence of options > context > config" do
+      put_test_config(
+        tags: %{
+          "not-overriden" => "config",
+          "overriden-by-context" => "config",
+          "overriden-by-options" => "config"
+        },
+        extra: %{
+          "not-overriden": "config",
+          "overriden-by-context": "config",
+          "overriden-by-options": "config"
+        }
+      )
+
+      Sentry.Context.set_tags_context(%{
+        "overriden-by-context" => "context",
+        "overriden-by-options" => "context"
+      })
+
+      Sentry.Context.set_extra_context(%{
+        "overriden-by-context": "context",
+        "overriden-by-options": "context"
+      })
+
+      assert %Event{} =
+               event =
+               Event.create_event(
+                 tags: %{"overriden-by-options" => "options"},
+                 extra: %{"overriden-by-options": "options"}
+               )
+
+      assert event.tags == %{
+               "not-overriden" => "config",
+               "overriden-by-context" => "context",
+               "overriden-by-options" => "options"
+             }
+
+      assert event.extra == %{
+               "not-overriden": "config",
+               "overriden-by-context": "context",
+               "overriden-by-options": "options"
+             }
+    end
+
     test "supports the :fingerprint option" do
       assert %Event{} = event = Event.create_event(fingerprint: ["foo", "bar"])
       assert event.fingerprint == ["foo", "bar"]