Class: GraphQL::Tracing::DataDogTracing

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

Instance Method Summary collapse

Methods inherited from PlatformTracing

#initialize, #trace, use

Constructor Details

This class inherits a constructor from GraphQL::Tracing::PlatformTracing

Instance Method Details

#analytics_available?Boolean

Returns:

  • (Boolean)

71
72
73
74
75
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 71

def analytics_available?
  defined?(Datadog::Contrib::Analytics) \
    && Datadog::Contrib::Analytics.respond_to?(:enabled?) \
    && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate)
end

#analytics_enabled?Boolean

Returns:

  • (Boolean)

77
78
79
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 77

def analytics_enabled?
  analytics_available? && Datadog::Contrib::Analytics.enabled?(options.fetch(:analytics_enabled, false))
end

#analytics_sample_rateObject


81
82
83
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 81

def analytics_sample_rate
  options.fetch(:analytics_sample_rate, 1.0)
end

#platform_authorized_key(type) ⇒ Object


89
90
91
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 89

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

#platform_field_key(type, field) ⇒ Object


85
86
87
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 85

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

#platform_resolve_type_key(type) ⇒ Object


93
94
95
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 93

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

#platform_trace(platform_key, key, data) ⇒ Object


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 17

def platform_trace(platform_key, key, data)
  tracer.trace(platform_key, service: service_name) do |span|
    span.span_type = 'custom'
    if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
      span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
      span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, key)
    end

    if key == 'execute_multiplex'
      operations = data[:multiplex].queries.map(&:selected_operation_name).join(', ')

      resource = if operations.empty?
        first_query = data[:multiplex].queries.first
        fallback_transaction_name(first_query && first_query.context)
      else
        operations
      end
      span.resource = resource if resource

      # For top span of query, set the analytics sample rate tag, if available.
      if analytics_enabled?
        Datadog::Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
      end
    end

    if key == 'execute_query'
      span.set_tag(:selected_operation_name, data[:query].selected_operation_name)
      span.set_tag(:selected_operation_type, data[:query].selected_operation.operation_type)
      span.set_tag(:query_string, data[:query].query_string)
    end

    prepare_span(key, data, span)

    yield
  end
end

#prepare_span(key, data, span) ⇒ Object

Implement this method in a subclass to apply custom tags to datadog spans

Parameters:

  • key (String)

    The event being traced

  • data (Hash)

    The runtime data for this event (@see GraphQL::Tracing for keys for each event)

  • span (Datadog::Tracing::SpanOperation)

    The datadog span for this event


62
63
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 62

def prepare_span(key, data, span)
end

#service_nameObject


54
55
56
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 54

def service_name
  options.fetch(:service, 'ruby-graphql')
end

#tracerObject


65
66
67
68
69
# File 'lib/graphql/tracing/data_dog_tracing.rb', line 65

def tracer
  default_tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer

  options.fetch(:tracer, default_tracer)
end