From 927e61e2af81568872878341d4eed5cc0e65e04d Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Tue, 16 Jan 2024 11:41:26 +0100 Subject: [PATCH 1/4] Remove method call on SpanOperation --- lib/graphql/tracing/data_dog_trace.rb | 12 ++++-------- lib/graphql/tracing/data_dog_tracing.rb | 3 +-- spec/support/datadog.rb | 1 - 3 files changed, 5 insertions(+), 11 deletions(-) diff --git a/lib/graphql/tracing/data_dog_trace.rb b/lib/graphql/tracing/data_dog_trace.rb index 5475a8ad0f..30d13466c0 100644 --- a/lib/graphql/tracing/data_dog_trace.rb +++ b/lib/graphql/tracing/data_dog_trace.rb @@ -34,8 +34,7 @@ def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0 }.each do |trace_method, trace_key| module_eval <<-RUBY, __FILE__, __LINE__ def #{trace_method}(**data) - @tracer.trace("#{trace_key}", service: @service_name) do |span| - span.span_type = 'custom' + @tracer.trace("#{trace_key}", service: @service_name, type: 'custom') do |span| 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, '#{trace_method}') @@ -89,8 +88,7 @@ def execute_field_span(span_key, query, field, ast_node, arguments, object) nil end if platform_key && trace_field - @tracer.trace(platform_key, service: @service_name) do |span| - span.span_type = 'custom' + @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span| 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, span_key) @@ -125,8 +123,7 @@ def authorized(query:, type:, object:) def authorized_span(span_key, object, type, query) platform_key = @platform_key_cache[DataDogTrace].platform_authorized_key_cache[type] - @tracer.trace(platform_key, service: @service_name) do |span| - span.span_type = 'custom' + @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span| 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, span_key) @@ -158,8 +155,7 @@ def resolve_type_lazy(object:, type:, query:) def resolve_type_span(span_key, object, type, query) platform_key = @platform_key_cache[DataDogTrace].platform_resolve_type_key_cache[type] - @tracer.trace(platform_key, service: @service_name) do |span| - span.span_type = 'custom' + @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span| 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, span_key) diff --git a/lib/graphql/tracing/data_dog_tracing.rb b/lib/graphql/tracing/data_dog_tracing.rb index 8e38c79cf1..d295161733 100644 --- a/lib/graphql/tracing/data_dog_tracing.rb +++ b/lib/graphql/tracing/data_dog_tracing.rb @@ -15,8 +15,7 @@ class DataDogTracing < PlatformTracing } def platform_trace(platform_key, key, data) - tracer.trace(platform_key, service: service_name) do |span| - span.span_type = 'custom' + tracer.trace(platform_key, service: service_name, type: 'custom') do |span| 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) diff --git a/spec/support/datadog.rb b/spec/support/datadog.rb index e978bef5a0..b2497bfa60 100644 --- a/spec/support/datadog.rb +++ b/spec/support/datadog.rb @@ -41,7 +41,6 @@ def resource=(resource_name) SPAN_RESOURCE_NAMES << resource_name end - def span_type=(*args)end def set_tag(key, value) SPAN_TAGS << [key, value] end From ec31a600aae040aeca0fd9764fb911d7fd35b7a1 Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Tue, 23 Jan 2024 11:48:35 +0100 Subject: [PATCH 2/4] Remove constant reference, fallback service name and simply analytic logic --- lib/graphql/tracing/data_dog_trace.rb | 42 ++++++++++--------------- lib/graphql/tracing/data_dog_tracing.rb | 26 ++++----------- spec/support/datadog.rb | 20 ------------ 3 files changed, 22 insertions(+), 66 deletions(-) diff --git a/lib/graphql/tracing/data_dog_trace.rb b/lib/graphql/tracing/data_dog_trace.rb index 30d13466c0..93c36722ce 100644 --- a/lib/graphql/tracing/data_dog_trace.rb +++ b/lib/graphql/tracing/data_dog_trace.rb @@ -5,18 +5,15 @@ module Tracing module DataDogTrace # @param analytics_enabled [Boolean] Deprecated # @param analytics_sample_rate [Float] Deprecated - def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: "ruby-graphql", **rest) + def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: nil, **rest) if tracer.nil? tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer end @tracer = tracer - analytics_available = defined?(Datadog::Contrib::Analytics) \ - && Datadog::Contrib::Analytics.respond_to?(:enabled?) \ - && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate) - - @analytics_enabled = analytics_available && Datadog::Contrib::Analytics.enabled?(analytics_enabled) + @analytics_enabled = analytics_enabled @analytics_sample_rate = analytics_sample_rate + @service_name = service @has_prepare_span = respond_to?(:prepare_span) super @@ -35,10 +32,8 @@ def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0 module_eval <<-RUBY, __FILE__, __LINE__ def #{trace_method}(**data) @tracer.trace("#{trace_key}", service: @service_name, type: 'custom') do |span| - 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, '#{trace_method}') - end + span.set_tag('component', 'graphql') + span.set_tag('operation', '#{trace_method}') #{ if trace_method == 'execute_multiplex' @@ -53,10 +48,8 @@ def #{trace_method}(**data) 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 + # [Deprecated] will be removed in the future + span.set_metric('_dd1.sr.eausr', @analytics_sample_rate) if @analytics_enabled RUBY elsif trace_method == 'execute_query' <<-RUBY @@ -89,10 +82,9 @@ def execute_field_span(span_key, query, field, ast_node, arguments, object) end if platform_key && trace_field @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span| - 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, span_key) - end + span.set_tag('component', 'graphql') + span.set_tag('operation', span_key) + if @has_prepare_span prepare_span_data = { query: query, field: field, ast_node: ast_node, arguments: arguments, object: object } prepare_span(span_key, prepare_span_data, span) @@ -124,10 +116,9 @@ def authorized(query:, type:, object:) def authorized_span(span_key, object, type, query) platform_key = @platform_key_cache[DataDogTrace].platform_authorized_key_cache[type] @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span| - 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, span_key) - end + span.set_tag('component', 'graphql') + span.set_tag('operation', span_key) + if @has_prepare_span prepare_span(span_key, {object: object, type: type, query: query}, span) end @@ -156,10 +147,9 @@ def resolve_type_lazy(object:, type:, query:) def resolve_type_span(span_key, object, type, query) platform_key = @platform_key_cache[DataDogTrace].platform_resolve_type_key_cache[type] @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span| - 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, span_key) - end + span.set_tag('component', 'graphql') + span.set_tag('operation', span_key) + if @has_prepare_span prepare_span(span_key, {object: object, type: type, query: query}, span) end diff --git a/lib/graphql/tracing/data_dog_tracing.rb b/lib/graphql/tracing/data_dog_tracing.rb index d295161733..035531c650 100644 --- a/lib/graphql/tracing/data_dog_tracing.rb +++ b/lib/graphql/tracing/data_dog_tracing.rb @@ -15,11 +15,9 @@ class DataDogTracing < PlatformTracing } def platform_trace(platform_key, key, data) - tracer.trace(platform_key, service: service_name, type: 'custom') do |span| - 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 + tracer.trace(platform_key, service: options[:service], type: 'custom') do |span| + span.set_tag('component', 'graphql') + span.set_tag('operation', key) if key == 'execute_multiplex' operations = data[:multiplex].queries.map(&:selected_operation_name).join(', ') @@ -32,10 +30,8 @@ def platform_trace(platform_key, key, data) 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 + # [Deprecated] will be removed in the future + span.set_metric('_dd1.sr.eausr', analytics_sample_rate) if analytics_enabled? end if key == 'execute_query' @@ -50,10 +46,6 @@ def platform_trace(platform_key, key, data) end end - def service_name - options.fetch(:service, 'ruby-graphql') - end - # Implement this method in a subclass to apply custom tags to datadog spans # @param key [String] The event being traced # @param data [Hash] The runtime data for this event (@see GraphQL::Tracing for keys for each event) @@ -67,15 +59,9 @@ def tracer options.fetch(:tracer, default_tracer) end - def analytics_available? - defined?(Datadog::Contrib::Analytics) \ - && Datadog::Contrib::Analytics.respond_to?(:enabled?) \ - && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate) - end - def analytics_enabled? # [Deprecated] options[:analytics_enabled] will be removed in the future - analytics_available? && Datadog::Contrib::Analytics.enabled?(options.fetch(:analytics_enabled, false)) + options.fetch(:analytics_enabled, false) end def analytics_sample_rate diff --git a/spec/support/datadog.rb b/spec/support/datadog.rb index b2497bfa60..87c8327f41 100644 --- a/spec/support/datadog.rb +++ b/spec/support/datadog.rb @@ -17,19 +17,6 @@ def self.clear_all SPAN_TAGS.clear end - - module Contrib - module Analytics - def self.set_sample_rate(rate) - rate - end - - def self.enabled?(_bool) - nil - end - end - end - class DummyTracer def trace(platform_key, *args) yield DummySpan.new @@ -50,12 +37,5 @@ module Tracing def self.trace(platform_key, *args) yield DummySpan.new end - - module Metadata - module Ext - TAG_COMPONENT = 'component' - TAG_OPERATION = 'operation' - end - end end end From 791256c63ac914396cb8ebf7ce367a749e972633 Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Tue, 23 Jan 2024 12:23:28 +0100 Subject: [PATCH 3/4] Update docuement --- guides/queries/tracing.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/guides/queries/tracing.md b/guides/queries/tracing.md index 023fc5b267..8d34573e0c 100644 --- a/guides/queries/tracing.md +++ b/guides/queries/tracing.md @@ -156,8 +156,7 @@ You may provide `options` as a `Hash` with the following values: | Key | Description | Default | | --- | ----------- | ------- | -| `service` | Service name used for `graphql` instrumentation | `'ruby-graphql'` | -| `tracer` | `Datadog::Tracer` used to perform instrumentation. Usually you don't need to set this. | `Datadog.tracer` | +| `tracer` | Tracer used to perform instrumentation. Usually you don't need to set this. | `Datadog::Tracing` | For more details about Datadog's tracing API, check out the [Ruby documentation](https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md) or the [APM documentation](https://docs.datadoghq.com/tracing/) for more product information. From 72e51d3cbd17529440205bfb4a56889c2aa3d6dc Mon Sep 17 00:00:00 2001 From: Tony Hsu Date: Tue, 23 Jan 2024 12:43:23 +0100 Subject: [PATCH 4/4] Deprecate tracer option --- guides/queries/tracing.md | 8 +------- lib/graphql/tracing/data_dog_trace.rb | 1 + lib/graphql/tracing/data_dog_tracing.rb | 1 + 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/guides/queries/tracing.md b/guides/queries/tracing.md index 8d34573e0c..2b1a239228 100644 --- a/guides/queries/tracing.md +++ b/guides/queries/tracing.md @@ -148,16 +148,10 @@ To add [Datadog](https://www.datadoghq.com) instrumentation: ```ruby class MySchema < GraphQL::Schema - use(GraphQL::Tracing::DataDogTracing, options) + use(GraphQL::Tracing::DataDogTracing) end ``` -You may provide `options` as a `Hash` with the following values: - -| Key | Description | Default | -| --- | ----------- | ------- | -| `tracer` | Tracer used to perform instrumentation. Usually you don't need to set this. | `Datadog::Tracing` | - For more details about Datadog's tracing API, check out the [Ruby documentation](https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md) or the [APM documentation](https://docs.datadoghq.com/tracing/) for more product information. ## Prometheus diff --git a/lib/graphql/tracing/data_dog_trace.rb b/lib/graphql/tracing/data_dog_trace.rb index 93c36722ce..33c08850a3 100644 --- a/lib/graphql/tracing/data_dog_trace.rb +++ b/lib/graphql/tracing/data_dog_trace.rb @@ -3,6 +3,7 @@ module GraphQL module Tracing module DataDogTrace + # @param tracer [#trace] Deprecated # @param analytics_enabled [Boolean] Deprecated # @param analytics_sample_rate [Float] Deprecated def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: nil, **rest) diff --git a/lib/graphql/tracing/data_dog_tracing.rb b/lib/graphql/tracing/data_dog_tracing.rb index 035531c650..ef3d2fc975 100644 --- a/lib/graphql/tracing/data_dog_tracing.rb +++ b/lib/graphql/tracing/data_dog_tracing.rb @@ -56,6 +56,7 @@ def prepare_span(key, data, span) def tracer default_tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer + # [Deprecated] options[:tracer] will be removed in the future options.fetch(:tracer, default_tracer) end