1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
|
# frozen_string_literal: true
module GraphQL
module Tracing
# This class uses the AppopticsAPM SDK from the appoptics_apm gem to create
# traces for GraphQL.
#
# There are 4 configurations available. They can be set in the
# appoptics_apm config file or in code. Please see:
# {https://docs.appoptics.com/kb/apm_tracing/ruby/configure}
#
# AppOpticsAPM::Config[:graphql][:enabled] = true|false
# AppOpticsAPM::Config[:graphql][:transaction_name] = true|false
# AppOpticsAPM::Config[:graphql][:sanitize_query] = true|false
# AppOpticsAPM::Config[:graphql][:remove_comments] = true|false
module AppOpticsTrace
# These GraphQL events will show up as 'graphql.prep' spans
PREP_KEYS = ['lex', 'parse', 'validate', 'analyze_query', 'analyze_multiplex'].freeze
# These GraphQL events will show up as 'graphql.execute' spans
EXEC_KEYS = ['execute_multiplex', 'execute_query', 'execute_query_lazy'].freeze
# During auto-instrumentation this version of AppOpticsTracing is compared
# with the version provided in the appoptics_apm gem, so that the newer
# version of the class can be used
def self.version
Gem::Version.new('1.0.0')
end
# rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
[
'lex',
'parse',
'validate',
'analyze_query',
'analyze_multiplex',
'execute_multiplex',
'execute_query',
'execute_query_lazy',
].each do |trace_method|
module_eval <<-RUBY, __FILE__, __LINE__
def #{trace_method}(**data)
return super if !defined?(AppOpticsAPM) || gql_config[:enabled] == false
layer = span_name("#{trace_method}")
kvs = metadata(data, layer)
kvs[:Key] = "#{trace_method}" if (PREP_KEYS + EXEC_KEYS).include?("#{trace_method}")
transaction_name(kvs[:InboundQuery]) if kvs[:InboundQuery] && layer == 'graphql.execute'
::AppOpticsAPM::SDK.trace(layer, kvs) do
kvs.clear # we don't have to send them twice
super
end
end
RUBY
end
# rubocop:enable Development/NoEvalCop
def execute_field(query:, field:, ast_node:, arguments:, object:)
return_type = field.type.unwrap
trace_field = if return_type.kind.scalar? || return_type.kind.enum?
(field.trace.nil? && @trace_scalars) || field.trace
else
true
end
platform_key = if trace_field
@platform_key_cache[AppOpticsTrace].platform_field_key_cache[field]
else
nil
end
if platform_key && trace_field
return super if !defined?(AppOpticsAPM) || gql_config[:enabled] == false
layer = platform_key
kvs = metadata({query: query, field: field, ast_node: ast_node, arguments: arguments, object: object}, layer)
::AppOpticsAPM::SDK.trace(layer, kvs) do
kvs.clear # we don't have to send them twice
super
end
else
super
end
end
def execute_field_lazy(query:, field:, ast_node:, arguments:, object:)
execute_field(query: query, field: field, ast_node: ast_node, arguments: arguments, object: object)
end
def authorized(**data)
return super if !defined?(AppOpticsAPM) || gql_config[:enabled] == false
layer = @platform_key_cache[AppOpticsTrace].platform_authorized_key_cache[data[:type]]
kvs = metadata(data, layer)
::AppOpticsAPM::SDK.trace(layer, kvs) do
kvs.clear # we don't have to send them twice
super
end
end
def authorized_lazy(**data)
return super if !defined?(AppOpticsAPM) || gql_config[:enabled] == false
layer = @platform_key_cache[AppOpticsTrace].platform_authorized_key_cache[data[:type]]
kvs = metadata(data, layer)
::AppOpticsAPM::SDK.trace(layer, kvs) do
kvs.clear # we don't have to send them twice
super
end
end
def resolve_type(**data)
return super if !defined?(AppOpticsAPM) || gql_config[:enabled] == false
layer = @platform_key_cache[AppOpticsTrace].platform_resolve_type_key_cache[data[:type]]
kvs = metadata(data, layer)
::AppOpticsAPM::SDK.trace(layer, kvs) do
kvs.clear # we don't have to send them twice
super
end
end
def resolve_type_lazy(**data)
return super if !defined?(AppOpticsAPM) || gql_config[:enabled] == false
layer = @platform_key_cache[AppOpticsTrace].platform_resolve_type_key_cache[data[:type]]
kvs = metadata(data, layer)
::AppOpticsAPM::SDK.trace(layer, kvs) do
kvs.clear # we don't have to send them twice
super
end
end
include PlatformTrace
def platform_field_key(field)
"graphql.#{field.owner.graphql_name}.#{field.graphql_name}"
end
def platform_authorized_key(type)
"graphql.authorized.#{type.graphql_name}"
end
def platform_resolve_type_key(type)
"graphql.resolve_type.#{type.graphql_name}"
end
private
def gql_config
::AppOpticsAPM::Config[:graphql] ||= {}
end
def transaction_name(query)
return if gql_config[:transaction_name] == false ||
::AppOpticsAPM::SDK.get_transaction_name
split_query = query.strip.split(/\W+/, 3)
split_query[0] = 'query' if split_query[0].empty?
name = "graphql.#{split_query[0..1].join('.')}"
::AppOpticsAPM::SDK.set_transaction_name(name)
end
def multiplex_transaction_name(names)
return if gql_config[:transaction_name] == false ||
::AppOpticsAPM::SDK.get_transaction_name
name = "graphql.multiplex.#{names.join('.')}"
name = "#{name[0..251]}..." if name.length > 254
::AppOpticsAPM::SDK.set_transaction_name(name)
end
def span_name(key)
return 'graphql.prep' if PREP_KEYS.include?(key)
return 'graphql.execute' if EXEC_KEYS.include?(key)
key[/^graphql\./] ? key : "graphql.#{key}"
end
# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
def metadata(data, layer)
data.keys.map do |key|
case key
when :context
graphql_context(data[key], layer)
when :query
graphql_query(data[key])
when :query_string
graphql_query_string(data[key])
when :multiplex
graphql_multiplex(data[key])
when :path
[key, data[key].join(".")]
else
[key, data[key]]
end
end.tap { _1.flatten!(2) }.each_slice(2).to_h.merge(Spec: 'graphql')
end
# rubocop:enable Metrics/AbcSize, Metrics/MethodLength
def graphql_context(context, layer)
context.errors && context.errors.each do |err|
AppOpticsAPM::API.log_exception(layer, err)
end
[[:Path, context.path.join('.')]]
end
def graphql_query(query)
return [] unless query
query_string = query.query_string
query_string = remove_comments(query_string) if gql_config[:remove_comments] != false
query_string = sanitize(query_string) if gql_config[:sanitize_query] != false
[[:InboundQuery, query_string],
[:Operation, query.selected_operation_name]]
end
def graphql_query_string(query_string)
query_string = remove_comments(query_string) if gql_config[:remove_comments] != false
query_string = sanitize(query_string) if gql_config[:sanitize_query] != false
[:InboundQuery, query_string]
end
def graphql_multiplex(data)
names = data.queries.map(&:operations).map!(&:keys).tap(&:flatten!).tap(&:compact!)
multiplex_transaction_name(names) if names.size > 1
[:Operations, names.join(', ')]
end
def sanitize(query)
return unless query
# remove arguments
query.gsub(/"[^"]*"/, '"?"') # strings
.gsub(/-?[0-9]*\.?[0-9]+e?[0-9]*/, '?') # ints + floats
.gsub(/\[[^\]]*\]/, '[?]') # arrays
end
def remove_comments(query)
return unless query
query.gsub(/#[^\n\r]*/, '')
end
end
end
end
|