Add span and trace origins (#2319)

* Add :origin attribute to span and use in trace context and span hash * Add origin to Rack::CaptureExceptions * Add origin to Net::HTTP * Add origin to Redis * Add origin to Metrics * Add origin to DelayedJob * Add origin to OpenTelemetry * Add origin to Resque * Add origin to Sidekiq * Add origin to Rails
getsentry · Jun 7, 2024 · c317a7a · c317a7a
1 parent bcf8827
commit c317a7a
Show file tree

Hide file tree

Showing 34 changed files with 182 additions and 28 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,10 @@
   - Fixes [#2297](https://github.com/getsentry/sentry-ruby/issues/2297)
 - Don't mutate `enabled_environments` when using `Sentry::TestHelper` ([#2317](https://github.com/getsentry/sentry-ruby/pull/2317))
 
+### Internal
+
+- Add `origin` to spans and transactions to track integration sources for instrumentation ([#2319](https://github.com/getsentry/sentry-ruby/pull/2319))
+
 ## 5.17.3
 
 ### Internal

diff --git a/sentry-delayed_job/lib/sentry/delayed_job/plugin.rb b/sentry-delayed_job/lib/sentry/delayed_job/plugin.rb
@@ -8,7 +8,8 @@ class Plugin < ::Delayed::Plugin
       # need to symbolize strings as keyword arguments in Ruby 2.4~2.6
       DELAYED_JOB_CONTEXT_KEY = :"Delayed-Job"
       ACTIVE_JOB_CONTEXT_KEY = :"Active-Job"
-      OP_NAME = "queue.delayed_job".freeze
+      OP_NAME = "queue.delayed_job"
+      SPAN_ORIGIN = "auto.queue.delayed_job"
 
       callbacks do |lifecycle|
         lifecycle.before(:enqueue) do |job, *args, &block|
@@ -93,7 +94,13 @@ def self.report?(job)
       end
 
       def self.start_transaction(scope, env, contexts)
-        options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
+        options = {
+          name: scope.transaction_name,
+          source: scope.transaction_source,
+          op: OP_NAME,
+          origin: SPAN_ORIGIN
+        }
+
         transaction = Sentry.continue_trace(env, **options)
         Sentry.start_transaction(transaction: transaction, custom_sampling_context: contexts, **options)
       end

diff --git a/sentry-delayed_job/spec/sentry/delayed_job_spec.rb b/sentry-delayed_job/spec/sentry/delayed_job_spec.rb
@@ -383,6 +383,7 @@ def perform
       expect(transaction.contexts.dig(:trace, :span_id)).to be_a(String)
       expect(transaction.contexts.dig(:trace, :status)).to eq("ok")
       expect(transaction.contexts.dig(:trace, :op)).to eq("queue.delayed_job")
+      expect(transaction.contexts.dig(:trace, :origin)).to eq("auto.queue.delayed_job")
     end
 
     it "records transaction with exception" do

diff --git a/sentry-opentelemetry/lib/sentry/opentelemetry/span_processor.rb b/sentry-opentelemetry/lib/sentry/opentelemetry/span_processor.rb
@@ -11,6 +11,7 @@ class SpanProcessor < ::OpenTelemetry::SDK::Trace::SpanProcessor
 
       SEMANTIC_CONVENTIONS = ::OpenTelemetry::SemanticConventions::Trace
       INTERNAL_SPAN_KINDS = %i[client internal]
+      SPAN_ORIGIN = "auto.otel"
 
       # The mapping from otel span ids to sentry spans
       # @return [Hash]
@@ -34,7 +35,8 @@ def on_start(otel_span, parent_context)
           sentry_parent_span.start_child(
             span_id: trace_data.span_id,
             description: otel_span.name,
-            start_timestamp: otel_span.start_timestamp / 1e9
+            start_timestamp: otel_span.start_timestamp / 1e9,
+            origin: SPAN_ORIGIN
           )
         else
           options = {
@@ -45,7 +47,8 @@ def on_start(otel_span, parent_context)
             parent_span_id: trace_data.parent_span_id,
             parent_sampled: trace_data.parent_sampled,
             baggage: trace_data.baggage,
-            start_timestamp: otel_span.start_timestamp / 1e9
+            start_timestamp: otel_span.start_timestamp / 1e9,
+            origin: SPAN_ORIGIN
           }
 
           Sentry.start_transaction(**options)

diff --git a/sentry-opentelemetry/spec/sentry/opentelemetry/span_processor_spec.rb b/sentry-opentelemetry/spec/sentry/opentelemetry/span_processor_spec.rb
@@ -92,6 +92,7 @@
           expect(event.contexts).to include(:trace)
           expect(event.contexts[:trace][:trace_id]).to eq(root_span.context.hex_trace_id)
           expect(event.contexts[:trace][:span_id]).to eq(root_span.context.hex_span_id)
+          expect(event.contexts[:trace][:origin]).to eq('auto.otel')
         end
       end
     end
@@ -134,6 +135,7 @@
       expect(transaction.span_id).to eq(span_id)
       expect(transaction.trace_id).to eq(trace_id)
       expect(transaction.start_timestamp).to eq(root_span.start_timestamp / 1e9)
+      expect(transaction.origin).to eq('auto.otel')
 
       expect(transaction.parent_span_id).to eq(nil)
       expect(transaction.parent_sampled).to eq(nil)
@@ -168,6 +170,7 @@
         expect(sentry_span.trace_id).to eq(trace_id)
         expect(sentry_span.description).to eq(child_db_span.name)
         expect(sentry_span.start_timestamp).to eq(child_db_span.start_timestamp / 1e9)
+        expect(sentry_span.origin).to eq('auto.otel')
       end
     end
   end
@@ -215,6 +218,7 @@
       subject.on_finish(finished_db_span)
 
       expect(sentry_span.op).to eq('db')
+      expect(sentry_span.origin).to eq('auto.otel')
       expect(sentry_span.description).to eq(finished_db_span.attributes['db.statement'])
       expect(sentry_span.data).to include(finished_db_span.attributes)
       expect(sentry_span.data).to include({ 'otel.kind' => finished_db_span.kind })
@@ -235,6 +239,7 @@
       subject.on_finish(finished_http_span)
 
       expect(sentry_span.op).to eq('http.client')
+      expect(sentry_span.origin).to eq('auto.otel')
       expect(sentry_span.description).to eq('GET www.google.com/search')
       expect(sentry_span.data).to include(finished_http_span.attributes)
       expect(sentry_span.data).to include({ 'otel.kind' => finished_http_span.kind })
@@ -259,6 +264,7 @@
       subject.on_finish(finished_root_span)
 
       expect(transaction.op).to eq('http.server')
+      expect(transaction.origin).to eq('auto.otel')
       expect(transaction.name).to eq(finished_root_span.name)
       expect(transaction.status).to eq('ok')
       expect(transaction.contexts[:otel]).to eq({

diff --git a/sentry-rails/lib/sentry/rails/action_cable.rb b/sentry-rails/lib/sentry/rails/action_cable.rb
@@ -3,6 +3,7 @@ module Rails
     module ActionCableExtensions
       class ErrorHandler
         OP_NAME = "websocket.server".freeze
+        SPAN_ORIGIN = "auto.http.rails.actioncable"
 
         class << self
           def capture(connection, transaction_name:, extra_context: nil, &block)
@@ -33,7 +34,13 @@ def capture(connection, transaction_name:, extra_context: nil, &block)
           end
 
           def start_transaction(env, scope)
-            options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
+            options = {
+              name: scope.transaction_name,
+              source: scope.transaction_source,
+              op: OP_NAME,
+              origin: SPAN_ORIGIN
+            }
+
             transaction = Sentry.continue_trace(env, **options)
             Sentry.start_transaction(transaction: transaction, **options)
           end

diff --git a/sentry-rails/lib/sentry/rails/active_job.rb b/sentry-rails/lib/sentry/rails/active_job.rb
@@ -17,6 +17,7 @@ def already_supported_by_sentry_integration?
 
       class SentryReporter
         OP_NAME = "queue.active_job".freeze
+        SPAN_ORIGIN = "auto.queue.active_job".freeze
 
         class << self
           def record(job, &block)
@@ -27,7 +28,12 @@ def record(job, &block)
                   if job.is_a?(::Sentry::SendEventJob)
                     nil
                   else
-                    Sentry.start_transaction(name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME)
+                    Sentry.start_transaction(
+                      name: scope.transaction_name,
+                      source: scope.transaction_source,
+                      op: OP_NAME,
+                      origin: SPAN_ORIGIN
+                    )
                   end
 
                 scope.set_span(transaction) if transaction

diff --git a/sentry-rails/lib/sentry/rails/capture_exceptions.rb b/sentry-rails/lib/sentry/rails/capture_exceptions.rb
@@ -2,6 +2,7 @@ module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
       RAILS_7_1 = Gem::Version.new(::Rails.version) >= Gem::Version.new("7.1.0.alpha")
+      SPAN_ORIGIN = 'auto.http.rails'.freeze
 
       def initialize(_)
         super
@@ -32,7 +33,12 @@ def capture_exception(exception, env)
       end
 
       def start_transaction(env, scope)
-        options = { name: scope.transaction_name, source: scope.transaction_source, op: transaction_op }
+        options = {
+          name: scope.transaction_name,
+          source: scope.transaction_source,
+          op: transaction_op,
+          origin: SPAN_ORIGIN
+        }
 
         if @assets_regexp && scope.transaction_name.match?(@assets_regexp)
           options.merge!(sampled: false)

diff --git a/sentry-rails/lib/sentry/rails/controller_transaction.rb b/sentry-rails/lib/sentry/rails/controller_transaction.rb
@@ -1,6 +1,8 @@
 module Sentry
   module Rails
     module ControllerTransaction
+      SPAN_ORIGIN = 'auto.view.rails'.freeze
+
       def self.included(base)
         base.prepend_around_action(:sentry_around_action)
       end
@@ -11,7 +13,7 @@ def sentry_around_action
         if Sentry.initialized?
           transaction_name = "#{self.class}##{action_name}"
           Sentry.get_current_scope.set_transaction_name(transaction_name, source: :view)
-          Sentry.with_child_span(op: "view.process_action.action_controller", description: transaction_name) do |child_span|
+          Sentry.with_child_span(op: "view.process_action.action_controller", description: transaction_name, origin: SPAN_ORIGIN) do |child_span|
             if child_span
               begin
                 result = yield

diff --git a/sentry-rails/lib/sentry/rails/tracing/action_controller_subscriber.rb b/sentry-rails/lib/sentry/rails/tracing/action_controller_subscriber.rb
@@ -9,6 +9,7 @@ class ActionControllerSubscriber < AbstractSubscriber
 
         EVENT_NAMES = ["process_action.action_controller"].freeze
         OP_NAME = "view.process_action.action_controller".freeze
+        SPAN_ORIGIN = "auto.view.rails".freeze
 
         def self.subscribe!
           Sentry.logger.warn <<~MSG
@@ -22,6 +23,7 @@ def self.subscribe!
 
             record_on_current_span(
               op: OP_NAME,
+              origin: SPAN_ORIGIN,
               start_timestamp: payload[START_TIMESTAMP_NAME],
               description: "#{controller}##{action}",
               duration: duration

diff --git a/sentry-rails/lib/sentry/rails/tracing/action_view_subscriber.rb b/sentry-rails/lib/sentry/rails/tracing/action_view_subscriber.rb
@@ -6,10 +6,17 @@ module Tracing
       class ActionViewSubscriber < AbstractSubscriber
         EVENT_NAMES = ["render_template.action_view"].freeze
         SPAN_PREFIX = "template.".freeze
+        SPAN_ORIGIN = "auto.template.rails".freeze
 
         def self.subscribe!
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
-            record_on_current_span(op: SPAN_PREFIX + event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:identifier], duration: duration)
+            record_on_current_span(
+              op: SPAN_PREFIX + event_name,
+              origin: SPAN_ORIGIN,
+              start_timestamp: payload[START_TIMESTAMP_NAME],
+              description: payload[:identifier],
+              duration: duration
+            )
           end
         end
       end

diff --git a/sentry-rails/lib/sentry/rails/tracing/active_record_subscriber.rb b/sentry-rails/lib/sentry/rails/tracing/active_record_subscriber.rb
@@ -6,6 +6,7 @@ module Tracing
       class ActiveRecordSubscriber < AbstractSubscriber
         EVENT_NAMES = ["sql.active_record"].freeze
         SPAN_PREFIX = "db.".freeze
+        SPAN_ORIGIN = "auto.db.rails".freeze
         EXCLUDED_EVENTS = ["SCHEMA", "TRANSACTION"].freeze
 
         SUPPORT_SOURCE_LOCATION = ActiveSupport::BacktraceCleaner.method_defined?(:clean_frame)
@@ -28,7 +29,13 @@ def subscribe!
             subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
               next if EXCLUDED_EVENTS.include? payload[:name]
 
-              record_on_current_span(op: SPAN_PREFIX + event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:sql], duration: duration) do |span|
+              record_on_current_span(
+                op: SPAN_PREFIX + event_name,
+                origin: SPAN_ORIGIN,
+                start_timestamp: payload[START_TIMESTAMP_NAME],
+                description: payload[:sql],
+                duration: duration
+              ) do |span|
                 span.set_tag(:cached, true) if payload.fetch(:cached, false) # cached key is only set for hits in the QueryCache, from Rails 5.1
 
                 connection = payload[:connection]

diff --git a/sentry-rails/lib/sentry/rails/tracing/active_storage_subscriber.rb b/sentry-rails/lib/sentry/rails/tracing/active_storage_subscriber.rb
@@ -19,9 +19,17 @@ class ActiveStorageSubscriber < AbstractSubscriber
           analyze.active_storage
         ].freeze
 
+        SPAN_ORIGIN = "auto.file.rails".freeze
+
         def self.subscribe!
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
-            record_on_current_span(op: "file.#{event_name}".freeze, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:service], duration: duration) do |span|
+            record_on_current_span(
+              op: "file.#{event_name}".freeze,
+              origin: SPAN_ORIGIN,
+              start_timestamp: payload[START_TIMESTAMP_NAME],
+              description: payload[:service],
+              duration: duration
+            ) do |span|
               payload.each do |key, value|
                 span.set_data(key, value) unless key == START_TIMESTAMP_NAME
               end

diff --git a/sentry-rails/spec/sentry/rails/action_cable_spec.rb b/sentry-rails/spec/sentry/rails/action_cable_spec.rb
@@ -204,7 +204,8 @@ def disconnect
           expect(transaction["contexts"]).to include(
             "trace" => hash_including(
               "op" => "websocket.server",
-              "status" => "internal_error"
+              "status" => "internal_error",
+              "origin" => "auto.http.rails.actioncable"
             )
           )
         end
@@ -230,7 +231,8 @@ def disconnect
           expect(subscription_transaction["contexts"]).to include(
             "trace" => hash_including(
               "op" => "websocket.server",
-              "status" => "ok"
+              "status" => "ok",
+              "origin" => "auto.http.rails.actioncable"
             )
           )
 
@@ -259,7 +261,8 @@ def disconnect
           expect(action_transaction["contexts"]).to include(
             "trace" => hash_including(
               "op" => "websocket.server",
-              "status" => "internal_error"
+              "status" => "internal_error",
+              "origin" => "auto.http.rails.actioncable"
             )
           )
         end
@@ -281,7 +284,8 @@ def disconnect
           expect(subscription_transaction["contexts"]).to include(
             "trace" => hash_including(
               "op" => "websocket.server",
-              "status" => "ok"
+              "status" => "ok",
+              "origin" => "auto.http.rails.actioncable"
             )
           )
 
@@ -308,7 +312,8 @@ def disconnect
           expect(transaction["contexts"]).to include(
             "trace" => hash_including(
               "op" => "websocket.server",
-              "status" => "internal_error"
+              "status" => "internal_error",
+              "origin" => "auto.http.rails.actioncable"
             )
           )
         end

diff --git a/sentry-rails/spec/sentry/rails/activejob_spec.rb b/sentry-rails/spec/sentry/rails/activejob_spec.rb
@@ -182,6 +182,7 @@ def post.to_global_id
       expect(transaction.contexts.dig(:trace, :span_id)).to be_present
       expect(transaction.contexts.dig(:trace, :status)).to eq("ok")
       expect(transaction.contexts.dig(:trace, :op)).to eq("queue.active_job")
+      expect(transaction.contexts.dig(:trace, :origin)).to eq("auto.queue.active_job")
 
       expect(transaction.spans.count).to eq(1)
       expect(transaction.spans.first[:op]).to eq("db.sql.active_record")
@@ -199,6 +200,7 @@ def post.to_global_id
         expect(transaction.contexts.dig(:trace, :trace_id)).to be_present
         expect(transaction.contexts.dig(:trace, :span_id)).to be_present
         expect(transaction.contexts.dig(:trace, :status)).to eq("internal_error")
+        expect(transaction.contexts.dig(:trace, :origin)).to eq("auto.queue.active_job")
 
         event = transport.events.last
         expect(event.transaction).to eq("FailedWithExtraJob")

diff --git a/sentry-rails/spec/sentry/rails/tracing/action_controller_subscriber_spec.rb b/sentry-rails/spec/sentry/rails/tracing/action_controller_subscriber_spec.rb
@@ -36,6 +36,7 @@
 
       span = transaction[:spans][0]
       expect(span[:op]).to eq("view.process_action.action_controller")
+      expect(span[:origin]).to eq("auto.view.rails")
       expect(span[:description]).to eq("HelloController#world")
       expect(span[:trace_id]).to eq(transaction.dig(:contexts, :trace, :trace_id))
       expect(span[:data].keys).to match_array(["http.response.status_code", :format, :method, :path, :params])

diff --git a/sentry-rails/spec/sentry/rails/tracing/action_view_subscriber_spec.rb b/sentry-rails/spec/sentry/rails/tracing/action_view_subscriber_spec.rb
@@ -25,6 +25,7 @@
       # ignore the first span, which is for controller action
       span = transaction[:spans][1]
       expect(span[:op]).to eq("template.render_template.action_view")
+      expect(span[:origin]).to eq("auto.template.rails")
       expect(span[:description]).to match(/test_template\.html\.erb/)
       expect(span[:trace_id]).to eq(transaction.dig(:contexts, :trace, :trace_id))
     end

diff --git a/sentry-rails/spec/sentry/rails/tracing/active_record_subscriber_spec.rb b/sentry-rails/spec/sentry/rails/tracing/active_record_subscriber_spec.rb
@@ -34,6 +34,7 @@
 
       span = transaction[:spans][0]
       expect(span[:op]).to eq("db.sql.active_record")
+      expect(span[:origin]).to eq("auto.db.rails")
       expect(span[:description]).to eq("SELECT \"posts\".* FROM \"posts\"")
       expect(span[:tags].key?(:cached)).to eq(false)
       expect(span[:trace_id]).to eq(transaction.dig(:contexts, :trace, :trace_id))
@@ -134,6 +135,7 @@ def foo
 
       cached_query_span = transaction[:spans][1]
       expect(cached_query_span[:op]).to eq("db.sql.active_record")
+      expect(cached_query_span[:origin]).to eq("auto.db.rails")
       expect(cached_query_span[:description]).to eq("SELECT \"posts\".* FROM \"posts\"")
       expect(cached_query_span[:tags]).to include({ cached: true })