Add tracing config option

Author: solnic

config/config.exs

@@ -10,7 +10,8 @@ if config_env() == :test do
     send_result: :sync,
     send_max_attempts: 1,
     dedup_events: false,
-    test_mode: true
+    test_mode: true,
+    tracing: true
 
   config :logger, backends: []
 

lib/sentry/application.ex

@@ -26,20 +26,27 @@ defmodule Sentry.Application do
 
     integrations_config = Config.integrations()
 
+    maybe_span_storage =
+      if Config.tracing?() do
+        [Sentry.OpenTelemetry.SpanStorage]
+      else
+        []
+      end
+
     children =
       [
         {Registry, keys: :unique, name: Sentry.Transport.SenderRegistry},
         Sentry.Sources,
         Sentry.Dedupe,
         Sentry.ClientReport.Sender,
-        Sentry.OpenTelemetry.SpanStorage,
         {Sentry.Integrations.CheckInIDMappings,
          [
            max_expected_check_in_time:
              Keyword.fetch!(integrations_config, :max_expected_check_in_time)
          ]}
       ] ++
         maybe_http_client_spec ++
+        maybe_span_storage ++
         [Sentry.Transport.SenderPool]
 
     cache_loaded_applications()

lib/sentry/config.ex

@@ -125,6 +125,17 @@ defmodule Sentry.Config do
       be used as the value for this option.
       """
     ],
+    tracing: [
+      type: :boolean,
+      default: false,
+      doc: """
+      Whether to enable tracing functionality based on OpenTelemetry. When enabled,
+      the Sentry SDK will use OpenTelemetry to collect and report distributed tracing
+      data to Sentry.
+
+      This feature requires `opentelemetry` package and its integrations with Bandit, Phoenix or Ecto.
+      """
+    ],
     included_environments: [
       type: {:or, [{:in, [:all]}, {:list, {:or, [:atom, :string]}}]},
       deprecated: "Use :dsn to control whether to send events to Sentry.",
@@ -627,6 +638,9 @@ defmodule Sentry.Config do
   @spec integrations() :: keyword()
   def integrations, do: fetch!(:integrations)
 
+  @spec tracing?() :: boolean()
+  def tracing?, do: fetch!(:tracing)
+
   @spec put_config(atom(), term()) :: :ok
   def put_config(key, value) when is_atom(key) do
     unless key in @valid_keys do

test/sentry/config_test.exs

@@ -157,6 +157,15 @@ defmodule Sentry.ConfigTest do
       end
     end
 
+    test ":tracing" do
+      assert Config.validate!(tracing: true)[:tracing] == true
+      assert Config.validate!([])[:tracing] == false
+
+      assert_raise ArgumentError, ~r/invalid value for :tracing option/, fn ->
+        Config.validate!(tracing: "not_a_boolean")
+      end
+    end
+
     test ":json_library" do
       assert Config.validate!(json_library: Jason)[:json_library] == Jason
 

test/sentry/opentelemetry/span_processor_test.exs

@@ -36,7 +36,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
   end
 
   test "sends captured root spans as transactions" do
-    put_test_config(environment_name: "test")
+    put_test_config(environment_name: "test", tracing: true)
 
     Sentry.Test.start_collecting_sentry_reports()
 
@@ -55,7 +55,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
   end
 
   test "sends captured spans as transactions with child spans" do
-    put_test_config(environment_name: "test")
+    put_test_config(environment_name: "test", tracing: true)
 
     Sentry.Test.start_collecting_sentry_reports()
 
@@ -92,7 +92,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
   end
 
   test "removes span records from storage after sending a transaction" do
-    put_test_config(environment_name: "test")
+    put_test_config(environment_name: "test", tracing: true)
 
     Sentry.Test.start_collecting_sentry_reports()