Class: GraphQL::Tracing::NotificationsTracing

Inherits:
Object
  • Object
show all
Defined in:
lib/graphql/tracing/notifications_tracing.rb

Overview

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

See Also:

Constant Summary collapse

KEYS =

A cache of frequently-used keys to avoid needless string allocations

{
  "lex" => "lex.graphql",
  "parse" => "parse.graphql",
  "validate" => "validate.graphql",
  "analyze_multiplex" => "analyze_multiplex.graphql",
  "analyze_query" => "analyze_query.graphql",
  "execute_query" => "execute_query.graphql",
  "execute_query_lazy" => "execute_query_lazy.graphql",
  "execute_field" => "execute_field.graphql",
  "execute_field_lazy" => "execute_field_lazy.graphql",
  "authorized" => "authorized.graphql",
  "authorized_lazy" => "authorized_lazy.graphql",
  "resolve_type" => "resolve_type.graphql",
  "resolve_type_lazy" => "resolve_type.graphql",
}
MAX_KEYS_SIZE = 
100

Instance Method Summary collapse

Constructor Details

#initialize(notifications_engine) ⇒ NotificationsTracing

Initialize a new NotificationsTracing instance

Parameters:

  • notifications_engine (Object) —

    The notifications engine to use



33
34
35
 
# File 'lib/graphql/tracing/notifications_tracing.rb', line 33

def initialize(notifications_engine)
  @notifications_engine = notifications_engine
end

Instance Method Details

#trace(key, metadata) { ... } ⇒ Object

Sends a GraphQL tracing event to the notification handler

. notifications_engine = Dry::Monitor::Notifications.new(:graphql) . tracer = GraphQL::Tracing::NotificationsTracing.new(notifications_engine) . tracer.trace("lex") { ... }

Parameters:

  • key (string) —

    The key for the event

  • metadata (Hash) —

    The metadata for the event

Yields:

  • The block to execute for the event



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/graphql/tracing/notifications_tracing.rb', line 47

def trace(key, metadata, &blk)
  prefixed_key = KEYS[key] || "#{key}.graphql"

  # Cache the new keys while making sure not to induce a memory leak
  if KEYS.size < MAX_KEYS_SIZE
    KEYS[key] ||= prefixed_key
  end

  @notifications_engine.instrument(prefixed_key, metadata, &blk)
end