tracing => traces_sample_rate

Author: solnic

config/config.exs

@@ -11,7 +11,7 @@ if config_env() == :test do
     send_max_attempts: 1,
     dedup_events: false,
     test_mode: true,
-    tracing: true
+    traces_sample_rate: 1.0
 
   config :logger, backends: []
 

lib/sentry/client.ex

@@ -117,7 +117,7 @@ defmodule Sentry.Client do
 
     result_type = Keyword.get_lazy(opts, :result, &Config.send_result/0)
     client = Keyword.get_lazy(opts, :client, &Config.client/0)
-    sample_rate = Keyword.get_lazy(opts, :sample_rate, &Config.sample_rate/0)
+    sample_rate = Keyword.get_lazy(opts, :sample_rate, &Config.traces_sample_rate/0)
     before_send = Keyword.get_lazy(opts, :before_send, &Config.before_send/0)
     after_send_event = Keyword.get_lazy(opts, :after_send_event, &Config.after_send_event/0)
 

lib/sentry/config.ex

@@ -125,13 +125,14 @@ defmodule Sentry.Config do
       be used as the value for this option.
       """
     ],
-    tracing: [
-      type: :boolean,
-      default: false,
+    traces_sample_rate: [
+      type: {:custom, __MODULE__, :__validate_traces_sample_rate__, []},
+      default: 0.0,
       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.
+      The sample rate for transaction events. A value between 0.0 and 1.0 (inclusive).
+      A value of 0.0 means no transactions will be sampled, while 1.0 means all transactions
+      will be sampled. This value is also used to determine if tracing is enabled - if it's
+      greater than 0, tracing is enabled.
 
       This feature requires `opentelemetry` package and you can optionally use integrations with Bandit, Phoenix or Ecto.
       """
@@ -601,6 +602,9 @@ defmodule Sentry.Config do
   @spec sample_rate() :: float()
   def sample_rate, do: fetch!(:sample_rate)
 
+  @spec traces_sample_rate() :: float()
+  def traces_sample_rate, do: fetch!(:traces_sample_rate)
+
   @spec hackney_opts() :: keyword()
   def hackney_opts, do: fetch!(:hackney_opts)
 
@@ -639,7 +643,7 @@ defmodule Sentry.Config do
   def integrations, do: fetch!(:integrations)
 
   @spec tracing?() :: boolean()
-  def tracing?, do: fetch!(:tracing)
+  def tracing?, do: fetch!(:traces_sample_rate) > 0.0
 
   @spec put_config(atom(), term()) :: :ok
   def put_config(key, value) when is_atom(key) do
@@ -740,6 +744,15 @@ defmodule Sentry.Config do
     end
   end
 
+  def __validate_traces_sample_rate__(float) do
+    if is_float(float) and float >= 0.0 and float <= 1.0 do
+      {:ok, float}
+    else
+      {:error,
+       "expected :traces_sample_rate to be a float between 0.0 and 1.0 (included), got: #{inspect(float)}"}
+    end
+  end
+
   def __validate_json_library__(nil) do
     {:error, "nil is not a valid value for the :json_library option"}
   end

test/sentry/config_test.exs

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

test/sentry/opentelemetry/span_processor_test.exs

@@ -26,7 +26,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
 
   @tag span_storage: true
   test "sends captured root spans as transactions" do
-    put_test_config(environment_name: "test", tracing: true)
+    put_test_config(environment_name: "test", traces_sample_rate: 1.0)
 
     Sentry.Test.start_collecting_sentry_reports()
 
@@ -46,7 +46,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
 
   @tag span_storage: true
   test "sends captured spans as transactions with child spans" do
-    put_test_config(environment_name: "test", tracing: true)
+    put_test_config(environment_name: "test", traces_sample_rate: 1.0)
 
     Sentry.Test.start_collecting_sentry_reports()
 
@@ -84,7 +84,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
 
   @tag span_storage: true
   test "removes span records from storage after sending a transaction", %{table_name: table_name} do
-    put_test_config(environment_name: "test", tracing: true)
+    put_test_config(environment_name: "test", traces_sample_rate: 1.0)
 
     Sentry.Test.start_collecting_sentry_reports()