opentelemetry-instrumentation-graphql 0.26.8 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c36e26e0ccdc84604de671dc5bd2d6dcd7fd06bbaa9c0159e7d30513813bfdd
-  data.tar.gz: 051b5110592eddb5495868aab95469a88813476c413cc345bd9cb1ae75e22c3d
+  metadata.gz: cf9a17d56d662feb78eacc36f2f23dc43d4a01244993b638b87f2c1ce1edc5da
+  data.tar.gz: 899d075eb41a2d13c0da8d9e6b3ccc08c0b568b476a0be89262e04baa85c31bf
 SHA512:
-  metadata.gz: 5df687d48d5b7062b6c3b3377aa367b14d12550ae82192e06c93cc9cfe1c0c052fe5172d00939ca57a0e17a578e11c84d41ee2d5c54ef2e118e31a1421b7bbc9
-  data.tar.gz: e2f39bfb71a33bdb69c588bacae73c57680e014e4a0e0a435f2031518674bfb2802bfdb8cefba8fb7c22349ca113916349696f518b05dfbc802888e41fc2fc4d
+  metadata.gz: 0217566ff1adebe65c331b91ca473989c47ffa43fc027d029fd125eb51388d739e2b283b43eadc80771cb81665c868418a7b06adb8f2be8ee80243259f733d88
+  data.tar.gz: ea52c6fd2b8b9bc378038046a25b92e1dbc11386764e88482439ba974a7fd1f5b6f2e42850b11b270c4ce69410e4a49419dc042328dc9b9c8bc7981c35e91db5

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History: opentelemetry-instrumentation-graphql
 
+### v0.28.0 / 2024-02-16
+
+* BREAKING CHANGE: GraphQL Legacy Tracer perf improvements [#867](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/867).
+
+* ADDED: GraphQL Legacy Tracer perf improvements [#867](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/867).
+
+### v0.27.0 / 2023-11-28
+
+* CHANGED: Performance optimization cache attribute hashes [#723](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/723)
+
 ### v0.26.8 / 2023-11-23
 
 * CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)

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

@@ -16,8 +16,46 @@ module OpenTelemetry
           def initialize(trace_scalars: false, **_options)
             @trace_scalars = trace_scalars
             @_otel_field_key_cache = Hash.new { |h, k| h[k] = _otel_field_key(k) }
+            @_otel_field_key_cache.compare_by_identity
             @_otel_authorized_key_cache = Hash.new { |h, k| h[k] = _otel_authorized_key(k) }
+            @_otel_authorized_key_cache.compare_by_identity
             @_otel_resolve_type_key_cache = Hash.new { |h, k| h[k] = _otel_resolve_type_key(k) }
+            @_otel_resolve_type_key_cache.compare_by_identity
+
+            @_otel_type_attrs_cache = Hash.new do |h, type|
+              h[type] = {
+                'graphql.type.name' => type.graphql_name,
+                'graphql.lazy' => false
+              }.freeze
+            end
+            @_otel_type_attrs_cache.compare_by_identity
+
+            @_otel_lazy_type_attrs_cache = Hash.new do |h, type|
+              h[type] = {
+                'graphql.type.name' => type.graphql_name,
+                'graphql.lazy' => true
+              }.freeze
+            end
+            @_otel_lazy_type_attrs_cache.compare_by_identity
+
+            @_otel_field_attrs_cache = Hash.new do |h, field|
+              h[field] = {
+                'graphql.field.parent' => field.owner&.graphql_name,
+                'graphql.field.name' => field.graphql_name,
+                'graphql.lazy' => false
+              }.freeze
+            end
+            @_otel_field_attrs_cache.compare_by_identity
+
+            @_otel_lazy_field_attrs_cache = Hash.new do |h, field|
+              h[field] = {
+                'graphql.field.parent' => field.owner&.graphql_name,
+                'graphql.field.name' => field.graphql_name,
+                'graphql.lazy' => true
+              }.freeze
+            end
+            @_otel_lazy_field_attrs_cache.compare_by_identity
+
             super
           end
 
@@ -73,26 +111,18 @@ module OpenTelemetry
 
           def execute_field(field:, query:, ast_node:, arguments:, object:, &block)
             platform_key = _otel_execute_field_key(field: field)
-            return super unless platform_key
+            return super(field: field, query: query, ast_node: ast_node, object: object, arguments: arguments, &block) unless platform_key
 
-            attributes = {
-              'graphql.field.parent' => field.owner&.graphql_name,
-              'graphql.field.name' => field.graphql_name,
-              'graphql.lazy' => false
-            }
+            attributes = @_otel_field_attrs_cache[field]
 
             tracer.in_span(platform_key, attributes: attributes, &block)
           end
 
           def execute_field_lazy(field:, query:, ast_node:, arguments:, object:, &block)
             platform_key = _otel_execute_field_key(field: field)
-            return super unless platform_key
+            return super(field: field, query: query, ast_node: ast_node, object: object, arguments: arguments, &block) unless platform_key
 
-            attributes = {
-              'graphql.field.parent' => field.owner&.graphql_name,
-              'graphql.field.name' => field.graphql_name,
-              'graphql.lazy' => true
-            }
+            attributes = @_otel_lazy_field_attrs_cache[field]
 
             tracer.in_span(platform_key, attributes: attributes, &block)
           end
@@ -101,10 +131,7 @@ module OpenTelemetry
             platform_key = @_otel_authorized_key_cache[type]
             return super unless platform_key
 
-            attributes = {
-              'graphql.type.name' => type.graphql_name,
-              'graphql.lazy' => false
-            }
+            attributes = @_otel_type_attrs_cache[type]
 
             tracer.in_span(platform_key, attributes: attributes, &block)
           end
@@ -113,33 +140,19 @@ module OpenTelemetry
             platform_key = @_otel_authorized_key_cache[type]
             return super unless platform_key
 
-            attributes = {
-              'graphql.type.name' => type.graphql_name,
-              'graphql.lazy' => true
-            }
-
+            attributes = @_otel_lazy_type_attrs_cache[type]
             tracer.in_span(platform_key, attributes: attributes, &block)
           end
 
           def resolve_type(query:, type:, object:, &block)
             platform_key = @_otel_resolve_type_key_cache[type]
-
-            attributes = {
-              'graphql.type.name' => type.graphql_name,
-              'graphql.lazy' => false
-            }
-
+            attributes = @_otel_type_attrs_cache[type]
             tracer.in_span(platform_key, attributes: attributes, &block)
           end
 
           def resolve_type_lazy(query:, type:, object:, &block)
             platform_key = @_otel_resolve_type_key_cache[type]
-
-            attributes = {
-              'graphql.type.name' => type.graphql_name,
-              'graphql.lazy' => true
-            }
-
+            attributes = @_otel_lazy_type_attrs_cache[type]
             tracer.in_span(platform_key, attributes: attributes, &block)
           end
 

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

@@ -13,6 +13,8 @@ module OpenTelemetry
         # GraphQLTracer contains the OpenTelemetry tracer implementation compatible with
         # the GraphQL tracer API
         class GraphQLTracer < ::GraphQL::Tracing::PlatformTracing
+          DEFAULT_HASH = {}.freeze
+
           self.platform_keys = {
             'lex' => 'graphql.lex',
             'parse' => 'graphql.parse',
@@ -86,24 +88,60 @@ module OpenTelemetry
           end
 
           def attributes_for(key, data)
-            attributes = {}
             case key
-            when 'execute_field', 'execute_field_lazy'
-              attributes['graphql.field.parent'] = data[:owner]&.graphql_name # owner is the concrete type, not interface
-              attributes['graphql.field.name'] = data[:field]&.graphql_name
-              attributes['graphql.lazy'] = key == 'execute_field_lazy'
-            when 'authorized', 'authorized_lazy'
-              attributes['graphql.type.name'] = data[:type]&.graphql_name
-              attributes['graphql.lazy'] = key == 'authorized_lazy'
-            when 'resolve_type', 'resolve_type_lazy'
-              attributes['graphql.type.name'] = data[:type]&.graphql_name
-              attributes['graphql.lazy'] = key == 'resolve_type_lazy'
+            when 'execute_field'
+              field_attr_cache = data[:query].context.namespace(:otel_attrs)[:execute_field_attrs] ||= attr_cache do |field|
+                attrs = {}
+                attrs['graphql.field.parent'] = field.owner.graphql_name if field.owner.graphql_name
+                attrs['graphql.field.name'] = field.graphql_name if field.graphql_name
+                attrs['graphql.lazy'] = false
+                attrs.freeze
+              end
+              field_attr_cache[data[:field]]
+            when 'execute_field_lazy'
+              lazy_field_attr_cache = data[:query].context.namespace(:otel_attrs)[:execute_field_lazy_attrs] ||= attr_cache do |field|
+                attrs = {}
+                attrs['graphql.field.parent'] = field.owner.graphql_name if field.owner.graphql_name
+                attrs['graphql.field.name'] = field.graphql_name if field.graphql_name
+                attrs['graphql.lazy'] = true
+                attrs.freeze
+              end
+              lazy_field_attr_cache[data[:field]]
+            when 'authorized', 'resolve_type'
+              type_attrs_cache = data[:context].namespace(:otel_attrs)[:type_attrs] ||= attr_cache do |type|
+                attrs = {}
+                attrs['graphql.type.name'] = type.graphql_name if type.graphql_name
+                attrs['graphql.lazy'] = false
+                attrs.freeze
+              end
+              type_attrs_cache[data[:type]]
+            when 'authorized_lazy', 'resolve_type_lazy'
+              type_lazy_attrs_cache = data[:context].namespace(:otel_attrs)[:type_lazy_attrs] ||= attr_cache do |type|
+                attrs = {}
+                attrs['graphql.type.name'] = type.graphql_name if type.graphql_name
+                attrs['graphql.lazy'] = true
+                attrs.freeze
+              end
+              type_lazy_attrs_cache[data[:type]]
             when 'execute_query'
-              attributes['graphql.operation.name'] = data[:query].selected_operation_name if data[:query].selected_operation_name
-              attributes['graphql.operation.type'] = data[:query].selected_operation.operation_type
-              attributes['graphql.document'] = data[:query].query_string
+              attrs = {}
+              attrs['graphql.document'] = data[:query].query_string if data[:query].query_string
+              # rubocop:disable Style/SafeNavigation - using safe navigation creates more objects, we want to avoid this
+              attrs['graphql.operation.type'] = data[:query].selected_operation.operation_type if data[:query].selected_operation && data[:query].selected_operation.operation_type
+              # rubocop:enable Style/SafeNavigation
+              attrs['graphql.operation.name'] = data[:query].selected_operation_name || 'anonymous'
+              attrs.freeze
+            else
+              DEFAULT_HASH
+            end
+          end
+
+          def attr_cache
+            cache_h = Hash.new do |h, k|
+              h[k] = yield(k)
             end
-            attributes
+            cache_h.compare_by_identity
+            cache_h
           end
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module GraphQL
-      VERSION = '0.26.8'
+      VERSION = '0.28.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-graphql
 version: !ruby/object:Gem::Version
-  version: 0.26.8
+  version: 0.28.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -148,28 +148,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.60.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.60.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.1
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.1
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -234,10 +234,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.26.8/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.28.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.26.8
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.28.0
 post_install_message: 
 rdoc_options: []
 require_paths: