Class: GraphQL::Tracing::ScoutTracing

Inherits:
PlatformTracing show all
Defined in:
lib/graphql/tracing/scout_tracing.rb

Constant Summary collapse

INSTRUMENT_OPTS =
{ scope: true }

Instance Method Summary collapse

Methods inherited from PlatformTracing

#instrument, #trace, #trace_field, use

Constructor Details

#initialize(options = {}) ⇒ ScoutTracing

Returns a new instance of ScoutTracing.

Parameters:

  • set_transaction_name (Boolean)

    If true, the GraphQL operation name will be used as the transaction name. This is not advised if you run more than one query per HTTP request, for example, with graphql-client or multiplexing. It can also be specified per-query with context[:set_scout_transaction_name].


22
23
24
25
26
# File 'lib/graphql/tracing/scout_tracing.rb', line 22

def initialize(options = {})
  self.class.include ScoutApm::Tracer
  @set_transaction_name = options.fetch(:set_transaction_name, false)
  super(options)
end

Instance Method Details

#platform_authorized_key(type) ⇒ Object


45
46
47
# File 'lib/graphql/tracing/scout_tracing.rb', line 45

def platform_authorized_key(type)
  "#{type.graphql_name}.authorized"
end

#platform_field_key(type, field) ⇒ Object


41
42
43
# File 'lib/graphql/tracing/scout_tracing.rb', line 41

def platform_field_key(type, field)
  "#{type.graphql_name}.#{field.graphql_name}"
end

#platform_resolve_type_key(type) ⇒ Object


49
50
51
# File 'lib/graphql/tracing/scout_tracing.rb', line 49

def platform_resolve_type_key(type)
  "#{type.graphql_name}.resolve_type"
end

#platform_trace(platform_key, key, data) ⇒ Object


28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/graphql/tracing/scout_tracing.rb', line 28

def platform_trace(platform_key, key, data)
  if key == "execute_query"
    set_this_txn_name = data[:query].context[:set_scout_transaction_name]
    if set_this_txn_name == true || (set_this_txn_name.nil? && @set_transaction_name)
      ScoutApm::Transaction.rename(transaction_name(data[:query]))
    end
  end

  self.class.instrument("GraphQL", platform_key, INSTRUMENT_OPTS) do
    yield
  end
end