instrumentation.md

layout	doc_stub	search	section	title	desc	index
guide	false	true	Fields	Instrumentation	Wrap and modify resolution behavior at schema build-time	3

Field instrumentation can be attached during schema definition:

MySchema = GraphQL::Schema.define do
  instrument(:field, FieldTimerInstrumentation.new)
end

The instrumenter is an object which responds to #instrument(type, field). #instrument should return a GraphQL::Field instance which will be used during query execution. #instrument is called with each type-field pair for all Object types and Interface types in your schema.

Here's an example field instrumenter:

class FieldTimerInstrumentation
  # If a field was flagged to be timed,
  # wrap its resolve proc with a timer.
  def instrument(type, field)
    if field.metadata[:timed]
      old_resolve_proc = field.resolve_proc
      new_resolve_proc = ->(obj, args, ctx) {
        Rails.logger.info("#{type.name}.#{field.name} START: #{Time.now.to_i}")
        resolved = old_resolve_proc.call(obj, args, ctx)
        Rails.logger.info("#{type.name}.#{field.name} END: #{Time.now.to_i}")
        resolved
      }

      # Return a copy of `field`, with a new resolve proc
      field.redefine do
        resolve(new_resolve_proc)
      end
    else
      field
    end
  end
end

It can be attached as shown above. You can use redefine { ... } to make a shallow copy of the {{ "GraphQL::Field" | api_doc }} and extend its definition.

{{ "GraphQL::Field#lazy_resolve_proc" | api_doc }} can also be instrumented. This is called for objects registered with {% internal_link "lazy execution","/schema/lazy_execution" %}.