opentelemetry-instrumentation-graphql 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3371fa2b3365c58fa9a6d601b674883e30f83c8f42904c6995b217eee235205
-  data.tar.gz: 2d2005d4dbe68396b720afa7cd8395e1fdd2ac6488f6b41b7f36811dd4fedd15
+  metadata.gz: a43a35c233d2adf52df479778bab10dfb4596bf2e7086782741053a7ee65cc63
+  data.tar.gz: e4dee2b3c3e802bf713678d2968bb196e244d601f757c87f1849d21ce5ee743e
 SHA512:
-  metadata.gz: c8a335dc15df7b331af81333e92806ff2b94c5696924bc36201a2d79ab2ea64ed8e09f1a0eb0fe8427514cae82c225cd2fd4811d2544ab2c690e84d39c2ce99b
-  data.tar.gz: 2eba3563b8d087f3342c83a35b16cfe361d745926949b2584107816f29c133048af5541bee0f1d279fe692856ecf4c4315ba5e483f6f0abcdc6ea914a3ca87b4
+  metadata.gz: 4f1c9532656d0626302509ca2d4ffe805eef53d24ae360e3bf3b84bbc8ed6587496f7dcc9677f009fe3ca29bcd97523c8e419cb7fad309f1b64ca6fe582c52c0
+  data.tar.gz: fc763aa2ac3468c0ba901f6a9fee2b0e826f8117a3130a5f9f83e87fa10391f7b80ddfe8837a1e466e4e9312b9bd44033dc66f5a04bac27351b8c77d3ea51de4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-instrumentation-graphql
 
+### v0.26.0 / 2023-05-17
+
+* BREAKING CHANGE: GraphQL instrumentation: support new tracing API 
+
+* ADDED: GraphQL instrumentation: support new tracing API
+
 ### v0.25.0 / 2023-04-17
 
 * BREAKING CHANGE: Drop support for EoL Ruby 2.7 

data/lib/opentelemetry/instrumentation/graphql/instrumentation.rb

@@ -12,19 +12,31 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the GraphQL instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         compatible do
-          Gem::Requirement.new('<= 2.0.17').satisfied_by?(gem_version) ||
-            Gem::Requirement.new('~> 2.0.19').satisfied_by?(gem_version)
+          if config[:legacy_tracing]
+            legacy_tracing_requirement_satisfied?
+          else
+            Gem::Requirement.new('>= 2.0.18', '< 3.0.0').satisfied_by?(gem_version)
+          end
         end
 
         install do |config|
-          require_dependencies
-          install_tracer(config)
+          if config[:legacy_tracing]
+            require_relative 'tracers/graphql_tracer'
+            install_tracer(config)
+          else
+            require_relative 'tracers/graphql_trace'
+            install_new_tracer(config)
+          end
         end
 
         present do
           defined?(::GraphQL)
         end
 
+        def legacy_tracing_requirement_satisfied?
+          Gem::Requirement.new('<= 2.0.17').satisfied_by?(gem_version) || Gem::Requirement.new('~> 2.0.19').satisfied_by?(gem_version)
+        end
+
         ## Supported configuration keys for the install config hash:
         #
         # The enable_platform_field key expects a boolean value,
@@ -49,6 +61,7 @@ module OpenTelemetry
         option :enable_platform_authorized,   default: false, validate: :boolean
         option :enable_platform_resolve_type, default: false, validate: :boolean
         option :legacy_platform_span_names,   default: false, validate: :boolean
+        option :legacy_tracing,               default: false, validate: :boolean
 
         private
 
@@ -56,10 +69,6 @@ module OpenTelemetry
           Gem::Version.new(::GraphQL::VERSION)
         end
 
-        def require_dependencies
-          require_relative 'tracers/graphql_tracer'
-        end
-
         def install_tracer(config = {})
           if config[:schemas].empty?
             ::GraphQL::Schema.tracer(Tracers::GraphQLTracer.new)
@@ -71,6 +80,18 @@ module OpenTelemetry
             end
           end
         end
+
+        def install_new_tracer(config = {})
+          if config[:schemas].empty?
+            ::GraphQL::Schema.trace_with(Tracers::GraphQLTrace)
+          else
+            config[:schemas].each do |schema|
+              schema.trace_with(Tracers::GraphQLTrace)
+            rescue StandardError => e
+              OpenTelemetry.logger.error("Unable to patch schema #{schema}: #{e.message}")
+            end
+          end
+        end
       end
     end
   end

data/lib/opentelemetry/instrumentation/graphql/tracers/graphql_trace.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry'
+
+module OpenTelemetry
+  module Instrumentation
+    module GraphQL
+      module Tracers
+        # GraphQLTrace contains the OpenTelemetry tracer implementation compatible with
+        # the new GraphQL tracing API (>= 2.0.18)
+        module GraphQLTrace # rubocop:disable Metrics/ModuleLength
+          def initialize(trace_scalars: false, **_options)
+            @trace_scalars = trace_scalars
+            @platform_field_key_cache = Hash.new { |h, k| h[k] = platform_field_key(k) }
+            @platform_authorized_key_cache = Hash.new { |h, k| h[k] = platform_authorized_key(k) }
+            @platform_resolve_type_key_cache = Hash.new { |h, k| h[k] = platform_resolve_type_key(k) }
+            super
+          end
+
+          def execute_multiplex(multiplex:, &block)
+            tracer.in_span('graphql.execute_multiplex', &block)
+          end
+
+          def lex(query_string:, &block)
+            tracer.in_span('graphql.lex', &block)
+          end
+
+          def parse(query_string:, &block)
+            tracer.in_span('graphql.parse', &block)
+          end
+
+          def validate(query:, validate:, &block)
+            tracer.in_span('graphql.validate') do |span|
+              super.tap do |response|
+                errors = response[:errors]&.compact&.map(&:to_h)&.to_json
+                unless errors.nil?
+                  span.add_event(
+                    'graphql.validation.error',
+                    attributes: {
+                      'message' => errors
+                    }
+                  )
+                end
+              end
+            end
+          end
+
+          def analyze_multiplex(multiplex:, &block)
+            tracer.in_span('graphql.analyze_query', &block)
+          end
+
+          def analyze_query(query:, &block)
+            tracer.in_span('graphql.analyze_multiplex', &block)
+          end
+
+          def execute_query(query:, &block)
+            attributes = {}
+            attributes['graphql.operation.name'] = query.selected_operation_name if query.selected_operation_name
+            attributes['graphql.operation.type'] = query.selected_operation.operation_type
+            attributes['graphql.document'] = query.query_string
+
+            tracer.in_span('graphql.execute_query', attributes: attributes, &block)
+          end
+
+          def execute_query_lazy(query:, &block)
+            tracer.in_span('graphql.execute_query_lazy', &block)
+          end
+
+          def execute_field(field:, query:, ast_node:, arguments:, object:, &block)
+            platform_key = platform_execute_field_key(field)
+            return super unless platform_key
+
+            attributes = {}
+            attributes['graphql.field.parent'] = field.owner&.graphql_name
+            attributes['graphql.field.name'] = field.graphql_name
+            attributes['graphql.field.lazy'] = false
+
+            tracer.in_span(platform_key, attributes: attributes, &block)
+          end
+
+          def execute_field_lazy(field:, query:, ast_node:, arguments:, object:, &block)
+            platform_key = platform_execute_field_key(field)
+            return super unless platform_key
+
+            attributes = {}
+            attributes['graphql.field.parent'] = field.owner&.graphql_name
+            attributes['graphql.field.name'] = field.graphql_name
+            attributes['graphql.field.lazy'] = true
+
+            tracer.in_span(platform_key, attributes: attributes, &block)
+          end
+
+          def authorized(query:, type:, object:, &block)
+            platform_key = @platform_authorized_key_cache[type]
+            return super unless platform_key
+
+            attributes = {}
+            attributes['graphql.type.name'] = type.graphql_name
+            attributes['graphql.lazy'] = false
+
+            tracer.in_span(platform_key, attributes: attributes, &block)
+          end
+
+          def authorized_lazy(query:, type:, object:, &block)
+            platform_key = @platform_authorized_key_cache[type]
+            return super unless platform_key
+
+            attributes = {}
+            attributes['graphql.type.name'] = type.graphql_name
+            attributes['graphql.lazy'] = true
+
+            tracer.in_span(platform_key, attributes: attributes, &block)
+          end
+
+          def resolve_type(query:, type:, object:)
+            platform_key = @platform_resolve_type_key_cache[type]
+
+            attributes = {}
+            attributes['graphql.type.name'] = type.graphql_name
+            attributes['graphql.lazy'] = false
+
+            tracer.in_span(platform_key, attributes: attributes, &block)
+          end
+
+          def resolve_type_lazy(query:, type:, object:)
+            platform_key = @platform_resolve_type_key_cache[type]
+
+            attributes = {}
+            attributes['graphql.type.name'] = type.graphql_name
+            attributes['graphql.lazy'] = true
+
+            tracer.in_span(platform_key, attributes: attributes, &block)
+          end
+
+          private
+
+          def platform_execute_field_key(field:, &block)
+            platform_key = @platform_field_key_cache[field] if trace_field?(field)
+            platform_key if !platform_key.nil? && trace_field
+          end
+
+          def trace_field?(field)
+            return_type = field.type.unwrap
+
+            if return_type.kind.scalar? || return_type.kind.enum?
+              (field.trace.nil? && @trace_scalars) || field.trace
+            else
+              true
+            end
+          end
+
+          def platform_field_key(field)
+            return unless config[:enable_platform_field]
+
+            if config[:legacy_platform_span_names]
+              field.path
+            else
+              'graphql.execute_field'
+            end
+          end
+
+          def platform_authorized_key(type)
+            return unless config[:enable_platform_authorized]
+
+            if config[:legacy_platform_span_names]
+              "#{type.graphql_name}.authorized"
+            else
+              'graphql.authorized'
+            end
+          end
+
+          def platform_resolve_type_key(type)
+            return unless config[:enable_platform_resolve_type]
+
+            if config[:legacy_platform_span_names]
+              "#{type.graphql_name}.resolve_type"
+            else
+              'graphql.resolve_type'
+            end
+          end
+
+          def tracer
+            GraphQL::Instrumentation.instance.tracer
+          end
+
+          def config
+            GraphQL::Instrumentation.instance.config
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/graphql/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module GraphQL
-      VERSION = '0.25.0'
+      VERSION = '0.26.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-graphql
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -148,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -227,16 +227,17 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/graphql.rb
 - lib/opentelemetry/instrumentation/graphql/instrumentation.rb
+- lib/opentelemetry/instrumentation/graphql/tracers/graphql_trace.rb
 - lib/opentelemetry/instrumentation/graphql/tracers/graphql_tracer.rb
 - lib/opentelemetry/instrumentation/graphql/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.25.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.26.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/graphql
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.25.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.26.0
 post_install_message: 
 rdoc_options: []
 require_paths: