opentelemetry-instrumentation-graphql 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6933e85196eaf2f0f93f7c8d86e7713c0d56fecb2035eded886357c7c2d9579b
-  data.tar.gz: f6d5f32f7c34453c7effc96a97451c75ccefe259b3d1ff2ea89616fd09353902
+  metadata.gz: 5015100d46cc0f99c590360df33781cc842d904c34bac8bb03775bcb92034211
+  data.tar.gz: 16dae74e81ea06bc994c0f974a963be0daed52a209b4db2dc6c2388f6e8f88be
 SHA512:
-  metadata.gz: 6e680d4a2f2e8d8b5c0dc9b011dd38fbb289b4c5c82af79b19ed5a4a415367fd8df8be013cfee0e69cca4d5b53a7066c2aeaa9063ef8b29798d58bb43792cf05
-  data.tar.gz: 925f99580cdf0eeaa21a5f9613df6d7a6722ae774a6284b7b31e93915829da959857741a8104d1573a649691af839e80bc8276bd3352e631830ce7a03007f810
+  metadata.gz: 4afdb500fe0423832111b88a75554bb271ba5c478a4dbd7786c054e8110b69cb2f0903f1198a0fc90cf76c9d5b51a5a2bb24054ce0d54069b51a61f299acaa52
+  data.tar.gz: bdd7284be3c68c61791735fe2ab695dccc74a926a4bc2d91ca322330cb96716056093cf7b27f3037df45cfac7660bf8e19f6e94aec5e2c65cc7eef48550ef939

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-graphql
 
+### v0.22.0 / 2023-01-27
+
+* ADDED: Normalize GraphQL span names for easier aggregation analysis 
+
 ### v0.21.1 / 2023-01-14
 
 * DOCS: Fix gem homepage 

data/README.md

@@ -40,7 +40,12 @@ OpenTelemetry::SDK.configure do |c|
     # enable_platform_authorized maps to the authorized and authorized_lazy keys
     enable_platform_authorized: false,
     # enable_platform_resolve_type maps to the resolve_type and resolve_type_lazy keys
-    enable_platform_resolve_type: false
+    enable_platform_resolve_type: false,
+
+    # Controls if platform tracing (field/authorized/resolve_type)
+    # should use the legacy span names (e.g. "MyType.myField") or the
+    # new normalized span names (e.g. "graphql.execute_field").
+    legacy_platform_span_names: false
   }
 end
 ```

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

@@ -35,6 +35,11 @@ module OpenTelemetry
         # The enable_platform_resolve_type key expects a boolean value,
         # and enables the tracing of "resolve_type" and "resolve_type_lazy".
         #
+        # The legacy_platform_span_names key expects a boolean value,
+        # and controls if platform tracing (field/authorized/resolve_type)
+        # should use the legacy span names (e.g. "MyType.myField") or the
+        # new normalized span names (e.g. "graphql.execute_field").
+        #
         # The schemas key expects an array of Schemas, and is used to specify
         # which schemas are to be instrumented. If this value is not supplied
         # the default behaviour is to instrument all schemas.
@@ -42,6 +47,7 @@ module OpenTelemetry
         option :enable_platform_field,        default: false, validate: :boolean
         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
 
         private
 

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

@@ -45,19 +45,31 @@ module OpenTelemetry
           def platform_field_key(type, field)
             return unless config[:enable_platform_field]
 
-            "#{type.graphql_name}.#{field.graphql_name}"
+            if config[:legacy_platform_span_names]
+              "#{type.graphql_name}.#{field.graphql_name}"
+            else
+              'graphql.execute_field'
+            end
           end
 
           def platform_authorized_key(type)
             return unless config[:enable_platform_authorized]
 
-            "#{type.graphql_name}.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]
 
-            "#{type.graphql_name}.resolve_type"
+            if config[:legacy_platform_span_names]
+              "#{type.graphql_name}.resolve_type"
+            else
+              'graphql.resolve_type'
+            end
           end
 
           private
@@ -70,9 +82,19 @@ module OpenTelemetry
             GraphQL::Instrumentation.instance.config
           end
 
-          def attributes_for(key, data)
+          def attributes_for(key, data) # rubocop:disable Metrics/CyclomaticComplexity
             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_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

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module GraphQL
-      VERSION = '0.21.1'
+      VERSION = '0.22.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-graphql
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -233,10 +233,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.21.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.22.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.21.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-graphql/0.22.0
 post_install_message: 
 rdoc_options: []
 require_paths: