Rewrite NotificationsTrace by rmosolgo · Pull Request #5270 · rmosolgo/graphql-ruby

rmosolgo · 2025-03-10T15:15:56Z

Trying to update this to handle fiber starts/stops better.

This PR covers ActiveSupport::Notifications, Dry::Notifications, New Relic, Data Dog, and Sentry. I'll address the others in a later PR.

Breaking change to DataDog trace: prepare_span now receives an object instead of a Hash.

Do I really need begin_/finish_ methods for parts of execution that don't call out to app code? (no)
Update NotificationsTrace
Add a test for AS::N trace
Migrate other traces to this system - Started with New Relic and Sentry.
What about AS::N payloads? (And Dry::Monitor) I want avoid creating that Hash by default, but those will need it for backwards compat.
Make sure platform-specific traces still work when there are multiple

github-actions · 2025-03-10T18:04:47Z

lib/graphql/tracing/notifications_trace.rb

+        end
+
+        def instrument(keyword, payload, &block)
+          raise "Implement #{self.class}#instrument to measure the block"


instance method instrument missing tests for line 19 (coverage: 0.0)

github-actions · 2025-03-10T18:04:47Z

lib/graphql/tracing/notifications_trace.rb

+            @platform_resolve_type_key_cache[payload]
+          when :dataloader_source
+            @platform_source_class_key_cache[payload.class]
+          when :parse then self.class::PARSE_NAME


instance method name_for missing tests for lines 56, 57, 62, 56, 57, 61 (coverage: 0.75)

github-actions · 2025-03-10T18:04:48Z

lib/graphql/tracing/notifications_trace.rb

+          attr_reader :keyword, :payload
+
+          def start
+            raise "Implement #{self.class}#start to begin a new event (#{inspect})"


instance method start missing tests for line 76 (coverage: 0.0)

github-actions · 2025-03-10T18:04:49Z

lib/graphql/tracing/notifications_trace.rb

+          end
+
+          def finish
+            raise "Implement #{self.class}#finish to end this event (#{inspect})"


instance method finish missing tests for line 80 (coverage: 0.0)

github-actions · 2025-03-10T18:04:50Z

lib/graphql/tracing/notifications_trace.rb

+        }.compare_by_identity
+
+        def instrument(keyword, payload, &block)
+          name = EVENT_NAMES.fetch(keyword)


instance method instrument missing tests for lines 99, 100 (coverage: 0.0)

github-actions · 2025-03-10T18:04:50Z

lib/graphql/tracing/notifications_trace.rb

+
+        class Event < NotificationsTrace::Engine::Event
+          def start
+            @name = EVENT_NAMES.fetch(@keyword)


instance method start missing tests for lines 105, 106 (coverage: 0.0)

github-actions · 2025-03-10T18:04:51Z

lib/graphql/tracing/notifications_trace.rb

-        RUBY
+
+          def finish
+            Dry::Monitor.stop(@name, @payload)


instance method finish missing tests for line 110 (coverage: 0.0)

github-actions · 2025-03-10T18:04:52Z

lib/graphql/tracing/notifications_trace.rb

+      # @param trace_resolve_type [Boolean] If `false`, skip tracing `resolve_type?` calls
+      def initialize(engine:, set_transaction_name: false, trace_scalars: false, trace_authorized: true, trace_resolve_type: true, **rest)
+        if defined?(Dry::Monitor) && engine == Dry::Monitor
+          # Backwards compat


instance method initialize missing tests for lines 123, 122 (coverage: 0.75)

github-actions · 2025-03-10T18:04:53Z

lib/graphql/tracing/notifications_trace.rb

+
+      def lex(query_string:)
+        @notifications_engine.instrument(:lex, query_string) do
+          super


block block missing tests for line 141 (coverage: 0.0)

github-actions · 2025-03-10T18:04:54Z

lib/graphql/tracing/sentry_trace.rb

+              operation_names = queries.map{|q| operation_name(q) }
+              span.set_description(operation_names.join(", "))
+
+              if queries.size == 1


block block (span) missing tests for lines 33, 33, 33 (coverage: 0.9444)

github-actions · 2025-03-10T18:04:55Z

lib/graphql/tracing/sentry_trace.rb

+          selected_op = query.selected_operation
+          if selected_op
+            [selected_op.operation_type, selected_op.name].compact.join(' ')
+          else


instance method operation_name missing tests for lines 66, 65 (coverage: 0.6)

github-actions · 2025-03-10T18:04:55Z

lib/graphql/tracing/sentry_trace.rb

-      def instrument_sentry_execution(platform_key, trace_method, data=nil, &block)
-        return yield unless Sentry.initialized?
+        def platform_resolve_type_key(type)
+          "graphql.resolve_type.#{type.graphql_name}"


instance method platform_resolve_type_key missing tests for line 79 (coverage: 0.0)

github-actions · 2025-03-10T18:04:56Z

lib/graphql/tracing/sentry_trace.rb

-          result = yield
-          return result unless span
+        def platform_source_class_key(source_class)
+          "graphql.source.#{source_class.name.gsub("::", ".")}"


instance method platform_source_class_key missing tests for line 83 (coverage: 0.0)

github-actions · 2025-03-10T21:06:57Z

lib/graphql/tracing/monitor_trace.rb

+        end
+
+        def instrument(keyword, object, &block)
+          raise "Implement #{self.class}#instrument to measure the block"


instance method instrument missing tests for line 20 (coverage: 0.0)

github-actions · 2025-03-10T21:06:58Z

lib/graphql/tracing/monitor_trace.rb

+            @platform_resolve_type_key_cache[object]
+          when :dataloader_source
+            @platform_source_class_key_cache[object.class]
+          when :parse then self.class::PARSE_NAME


instance method name_for missing tests for lines 57, 58, 63, 57, 58, 62 (coverage: 0.75)

github-actions · 2025-03-10T21:06:59Z

lib/graphql/tracing/monitor_trace.rb

+          attr_reader :keyword, :object
+
+          def start
+            raise "Implement #{self.class}#start to begin a new event (#{inspect})"


instance method start missing tests for line 77 (coverage: 0.0)

github-actions · 2025-03-10T21:06:59Z

lib/graphql/tracing/monitor_trace.rb

+          end
+
+          def finish
+            raise "Implement #{self.class}#finish to end this event (#{inspect})"


instance method finish missing tests for line 81 (coverage: 0.0)

github-actions · 2025-03-10T21:07:00Z

lib/graphql/tracing/monitor_trace.rb

+      end
+
+      def self.create_module(monitor_name)
+        if !monitor_name.match?(/[a-z]+/)


class method create_module missing tests for lines 87, 88, 87, 87 (coverage: 0.6667)

github-actions · 2025-03-10T21:07:01Z

lib/graphql/tracing/notifications_trace.rb

+      # @api private
+      class Adapter
+        def instrument(keyword, payload, &block)
+          raise "Implement #{self.class}#instrument to measure the block"


instance method instrument missing tests for line 13 (coverage: 0.0)

github-actions · 2025-03-10T21:07:02Z

lib/graphql/tracing/notifications_trace.rb

+          attr_reader :name, :payload
+
+          def start
+            raise "Implement #{self.class}#start to begin a new event (#{inspect})"


instance method start missing tests for line 31 (coverage: 0.0)

github-actions · 2025-03-10T21:07:03Z

lib/graphql/tracing/notifications_trace.rb

+          end
+
+          def finish
+            raise "Implement #{self.class}#finish to end this event (#{inspect})"


instance method finish missing tests for line 35 (coverage: 0.0)

github-actions · 2025-03-10T21:07:04Z

lib/graphql/tracing/notifications_trace.rb

+      # @api private
+      class DryMonitorAdapter < Adapter
+        def instrument(...)
+          Dry::Monitor.instrument(...)


instance method instrument missing tests for line 43 (coverage: 0.0)

github-actions · 2025-03-10T21:07:04Z

lib/graphql/tracing/notifications_trace.rb

+
+        class Event < Adapter::Event
+          def start
+            Dry::Monitor.start(@name, @payload)


instance method start missing tests for line 48 (coverage: 0.0)

github-actions · 2025-03-10T21:07:05Z

lib/graphql/tracing/notifications_trace.rb

+          end
+
+          def finish
+            Dry::Monitor.stop(@name, @payload)


instance method finish missing tests for line 52 (coverage: 0.0)

github-actions · 2025-03-10T21:07:06Z

lib/graphql/tracing/notifications_trace.rb

+
+      # @param engine [Class] The notifications engine to use, eg `Dry::Monitor` or `ActiveSupport::Notifications`
+      def initialize(engine:, **rest)
+        adapter = if defined?(Dry::Monitor) && engine == Dry::Monitor


instance method initialize missing tests for lines 78, 79, 78, 79 (coverage: 0.75)

github-actions · 2025-03-10T21:07:07Z

lib/graphql/tracing/notifications_trace.rb

+
+      def lex(**payload)
+        @notifications.instrument("lex.graphql", payload) do
+          super


block block missing tests for line 97 (coverage: 0.0)

github-actions · 2025-03-10T21:07:07Z

lib/graphql/tracing/notifications_trace.rb

+      end
+
+      def finish_notifications_event
+        if ev = Fiber[CURRENT_EV_KEY]


instance method finish_notifications_event missing tests for lines 184, 184, 184 (coverage: 0.75)

github-actions · 2025-03-10T21:07:08Z

lib/graphql/tracing/sentry_trace.rb

+              operation_names = queries.map{|q| operation_name(q) }
+              span.set_description(operation_names.join(", "))
+
+              if queries.size == 1


block block (span) missing tests for lines 32, 32, 32 (coverage: 0.9444)

github-actions · 2025-03-10T21:07:09Z

lib/graphql/tracing/sentry_trace.rb

+          selected_op = query.selected_operation
+          if selected_op
+            [selected_op.operation_type, selected_op.name].compact.join(' ')
+          else


instance method operation_name missing tests for lines 65, 64 (coverage: 0.6)

github-actions · 2025-03-10T21:07:10Z

lib/graphql/tracing/sentry_trace.rb

-      def instrument_sentry_execution(platform_key, trace_method, data=nil, &block)
-        return yield unless Sentry.initialized?
+        def platform_resolve_type_key(type)
+          "graphql.resolve_type.#{type.graphql_name}"


instance method platform_resolve_type_key missing tests for line 78 (coverage: 0.0)

github-actions · 2025-03-10T21:07:10Z

lib/graphql/tracing/sentry_trace.rb

-          result = yield
-          return result unless span
+        def platform_source_class_key(source_class)
+          "graphql.source.#{source_class.name.gsub("::", ".")}"


instance method platform_source_class_key missing tests for line 82 (coverage: 0.0)

zvkemp · 2025-08-11T15:43:02Z

Were the execute_query, execute_query_lazy, and analyze_query instrumentations intentionally omitted from this refactor? We've noticed those are no longer published to our ActiveSupport::Notifications subscriber.

rmosolgo added 6 commits March 10, 2025 10:57

Rewrite NotificationsTrace, remove needless Trace methods

a6da7ff

Add engine system for AS::N and Dry::Monitor

edfc5b5

migrate SentryTrace

387b997

Update spec

b30b0ca

Migrate NewRelic

9c869b8

Update requires

a139345

github-actions bot reviewed Mar 10, 2025

View reviewed changes

Update specs and lint

7e29ce8

rmosolgo force-pushed the update-asn branch from 35a4531 to 7e29ce8 Compare March 10, 2025 18:21

rmosolgo added 3 commits March 10, 2025 16:29

Split out MonitorTrace from NotificationsTrace, simplify them both

1a09092

Generate methods to avoid naming conflicts

9a495cf

Update spec

2fe6ed7

github-actions bot reviewed Mar 10, 2025

View reviewed changes

rmosolgo mentioned this pull request Mar 10, 2025

Fix(NewRelic) reimplement trace_scalars #5271

Merged

rmosolgo mentioned this pull request Mar 24, 2025

Updating OTEL Instrumentation for Dataloaders #5293

Closed

rmosolgo added 6 commits March 24, 2025 10:11

Merge branch 'master' into update-asn

4ce8997

Migrate DataDogTrace

63ef098

Fix lint error

d1ab0c9

fix specs

50a3f41

update spec

5d4df33

Update Cparser spec

4ebc02f

rmosolgo added this to the 2.4.16 milestone Mar 24, 2025

rmosolgo merged commit 48d110e into master Mar 24, 2025
15 checks passed

rmosolgo removed this from the 2.4.16 milestone Mar 25, 2025

rmosolgo deleted the update-asn branch March 25, 2025 11:00

rmosolgo mentioned this pull request Mar 25, 2025

Revert "Rewrite NotificationsTrace" #5297

Merged

rmosolgo restored the update-asn branch March 25, 2025 11:01

rmosolgo mentioned this pull request Mar 25, 2025

Update Tracers to handle Fiber starts/stops #5298

Merged

Conversation

rmosolgo commented Mar 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 10, 2025

rmosolgo commented Mar 10, 2025 •

edited

Loading