GraphQL - individual tracers for missing notification keys

Author: zvkemp

lib/skylight/normalizers/graphql/base.rb

@@ -65,9 +65,9 @@ class Execute < Base
     # This is a new, combined normalizer for execute_query and execute_multiplex,
     # to be used for graphql >= 2.5
     #
-    def normalize(trace, _name, payload)
+    def normalize(trace, name, payload)
       if payload[:query]
-        _execute_query_normalize
+        _execute_query_normalize(trace, name, payload)
       else
         [CAT, "graphql.#{key}", nil]
       end
@@ -123,7 +123,7 @@ def _execute_multiplex_normalize_after(trace, _span, _name, payload)
     end
   end
 
-  class ExecuteQuery < Base
+  class ExecuteQuery < Execute
     register_graphql
   end
 

lib/skylight/probes/graphql.rb

@@ -35,6 +35,48 @@ def execute_multiplex(**metadata, &blk)
           end
         end
 
+        # GraphQL versions >= 2.5 are missing this notification
+        module ExecuteQueryNotification
+          def execute_query(**metadata, &blk)
+            if @notifications_engine
+              @notifications_engine.instrument("execute_query.graphql", metadata, &blk)
+            elsif @notifications
+              @notifications.instrument("execute_query.graphql", metadata, &blk)
+            else
+              # safety fallback in case graphql's authors unexpectedly rename @notifications_engine or @notifications
+              super
+            end
+          end
+        end
+
+        # GraphQL versions >= 2.5 are missing this notification
+        module ExecuteQueryLazyNotification
+          def execute_query_lazy(**metadata, &blk)
+            if @notifications_engine
+              @notifications_engine.instrument("execute_query_lazy.graphql", metadata, &blk)
+            elsif @notifications
+              @notifications.instrument("execute_query_lazy.graphql", metadata, &blk)
+            else
+              # safety fallback in case graphql's authors unexpectedly rename @notifications_engine or @notifications
+              super
+            end
+          end
+        end
+
+        # GraphQL versions >= 2.5 are missing this notification
+        module AnalyzeQueryNotification 
+          def analyze_query(**metadata, &blk)
+            if @notifications_engine
+              @notifications_engine.instrument("analyze_query.graphql", metadata, &blk)
+            elsif @notifications
+              @notifications.instrument("analyze_query.graphql", metadata, &blk)
+            else
+              # safety fallback in case graphql's authors unexpectedly rename @notifications_engine or @notifications
+              super
+            end
+          end
+        end
+        
         module ClassMethods
           def new_trace(*, **)
             unless @__sk_instrumentation_installed
@@ -44,6 +86,18 @@ def new_trace(*, **)
                 trace_with(ExecuteMultiplexNotification)
               end
 
+              unless ::GraphQL::Tracing::ActiveSupportNotificationsTrace.instance_methods.include?(:execute_query)
+                trace_with(ExecuteQueryNotification)
+              end
+
+              unless ::GraphQL::Tracing::ActiveSupportNotificationsTrace.instance_methods.include?(:execute_query_lazy)
+                trace_with(ExecuteQueryLazyNotification)
+              end
+
+              unless ::GraphQL::Tracing::ActiveSupportNotificationsTrace.instance_methods.include?(:analyze_query)
+                trace_with(AnalyzeQueryNotification)
+              end
+
               @__sk_instrumentation_installed = true
             end