Module: GraphQL::Tracing::NotificationsTrace

Included in:
ActiveSupportNotificationsTrace
Defined in:
lib/graphql/tracing/notifications_trace.rb

Overview

This implementation forwards events to a notification handler (i.e. ActiveSupport::Notifications or Dry::Monitor::Notifications) with a graphql suffix.

See Also:

Defined Under Namespace

Classes: ActiveSupportNotificationsAdapter, Adapter, DryMonitorAdapter

Constant Summary collapse

CURRENT_EV_KEY = 
:__notifications_graphql_trace_event
PREVIOUS_EV_KEY = 
:__notifications_graphql_trace_previous_event

Instance Method Summary collapse

Instance Method Details

#begin_analyze_multiplex(multiplex, analyzers) ⇒ Object 



107
108
109
110
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 107

def begin_analyze_multiplex(multiplex, analyzers)
  begin_notifications_event("analyze.graphql", {multiplex: multiplex, analyzers: analyzers})
  super
end

#begin_authorized(type, object, context) ⇒ Object 



144
145
146
147
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 144

def begin_authorized(type, object, context)
  begin_notifications_event("authorized.graphql", {type: type, object: object, context: context})
  super
end

#begin_dataloader_source(source) ⇒ Object 



164
165
166
167
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 164

def begin_dataloader_source(source)
  begin_notifications_event("dataloader_source.graphql", { source: source })
  super
end

#begin_execute_field(field, object, arguments, query) ⇒ Object 



123
124
125
126
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 123

def begin_execute_field(field, object, arguments, query)
  begin_notifications_event("execute_field.graphql", {field: field, object: object, arguments: arguments, query: query})
  super
end

#begin_resolve_type(type, object, context) ⇒ Object 



154
155
156
157
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 154

def begin_resolve_type(type, object, context)
  begin_notifications_event("resolve_type.graphql", {type: type, object: object, context: context})
  super
end

#dataloader_fiber_resume(source) ⇒ Object 



138
139
140
141
142
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 138

def dataloader_fiber_resume(source)
  prev_ev = Fiber[PREVIOUS_EV_KEY]
  begin_notifications_event(prev_ev.name, prev_ev.payload)
  super
end

#dataloader_fiber_yield(source) ⇒ Object 



133
134
135
136
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 133

def dataloader_fiber_yield(source)
  Fiber[PREVIOUS_EV_KEY] = finish_notifications_event
  super
end

#end_analyze_multiplex(_multiplex, _analyzers) ⇒ Object 



112
113
114
115
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 112

def end_analyze_multiplex(_multiplex, _analyzers)
  finish_notifications_event
  super
end

#end_authorized(type, object, context, result) ⇒ Object 



149
150
151
152
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 149

def end_authorized(type, object, context, result)
  finish_notifications_event
  super
end

#end_dataloader_source(source) ⇒ Object 



169
170
171
172
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 169

def end_dataloader_source(source)
  finish_notifications_event
  super
end

#end_execute_field(_field, _object, _arguments, _query, _result) ⇒ Object 



128
129
130
131
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 128

def end_execute_field(_field, _object, _arguments, _query, _result)
  finish_notifications_event
  super
end

#end_resolve_type(type, object, context, resolved_type) ⇒ Object 



159
160
161
162
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 159

def end_resolve_type(type, object, context, resolved_type)
  finish_notifications_event
  super
end

#execute_multiplex(**payload) ⇒ Object 



117
118
119
120
121
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 117

def execute_multiplex(**payload)
  @notifications.instrument("execute.graphql", payload) do
    super
  end
end

#initialize(engine:, **rest) ⇒ Object

Parameters:

  • engine (Class) —

    The notifications engine to use, eg Dry::Monitor or ActiveSupport::Notifications



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 77

def initialize(engine:, **rest)
  adapter = if defined?(Dry::Monitor) && engine == Dry::Monitor
    DryMonitoringAdapter
  elsif defined?(ActiveSupport::Notifications) && engine == ActiveSupport::Notifications
    ActiveSupportNotificationsAdapter
  else
    engine
  end
  @notifications = adapter.new
  super
end

#lex(**payload) ⇒ Object 



95
96
97
98
99
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 95

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

#parse(**payload) ⇒ Object 



89
90
91
92
93
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 89

def parse(**payload)
  @notifications.instrument("parse.graphql", payload) do
    super
  end
end

#validate(**payload) ⇒ Object 



101
102
103
104
105
 
# File 'lib/graphql/tracing/notifications_trace.rb', line 101

def validate(**payload)
  @notifications.instrument("validate.graphql", payload) do
    super
  end
end