Merge pull request #2765 from DataDog/zarir/service-name-integrations…

…-part-two Change default `service_name` values Part 2
DataDog · May 4, 2023 · 8c6384d · 8c6384d
2 parents 354f7c7 + 86f9593
commit 8c6384d
Show file tree

Hide file tree

Showing 43 changed files with 307 additions and 29 deletions.
diff --git a/lib/datadog/tracing/contrib/active_support/configuration/settings.rb b/lib/datadog/tracing/contrib/active_support/configuration/settings.rb
@@ -26,7 +26,15 @@ class Settings < Contrib::Configuration::Settings
               o.lazy
             end
 
-            option :cache_service, default: Ext::SERVICE_CACHE
+            option :cache_service do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  '',
+                  Ext::SERVICE_CACHE
+                )
+              end
+              o.lazy
+            end
           end
         end
       end

diff --git a/lib/datadog/tracing/contrib/httpclient/configuration/settings.rb b/lib/datadog/tracing/contrib/httpclient/configuration/settings.rb
@@ -29,7 +29,12 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
 

diff --git a/lib/datadog/tracing/contrib/httpclient/instrumentation.rb b/lib/datadog/tracing/contrib/httpclient/instrumentation.rb
@@ -63,8 +63,11 @@ def annotate_span_with_request!(span, req, req_options)
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, uri.host)
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, uri.port)
 
-              # Tag as an external peer service
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                # Tag as an external peer service
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              end
+
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, uri.host)
 
               set_analytics_sample_rate(span, req_options)

diff --git a/lib/datadog/tracing/contrib/httprb/configuration/settings.rb b/lib/datadog/tracing/contrib/httprb/configuration/settings.rb
@@ -29,7 +29,12 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
 

diff --git a/lib/datadog/tracing/contrib/httprb/instrumentation.rb b/lib/datadog/tracing/contrib/httprb/instrumentation.rb
@@ -73,8 +73,10 @@ def annotate_span_with_request!(span, req, req_options)
                 logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing uri")
               end
 
-              # Tag as an external peer service
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                # Tag as an external peer service
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              end
 
               set_analytics_sample_rate(span, req_options)
             end

diff --git a/lib/datadog/tracing/contrib/mongodb/configuration/settings.rb b/lib/datadog/tracing/contrib/mongodb/configuration/settings.rb
@@ -31,7 +31,12 @@ class Settings < Contrib::Configuration::Settings
             option :quantize, default: DEFAULT_QUANTIZE
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
           end

diff --git a/lib/datadog/tracing/contrib/mongodb/subscribers.rb b/lib/datadog/tracing/contrib/mongodb/subscribers.rb
@@ -36,8 +36,11 @@ def started(event)
             span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
             span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
 
-            # Tag as an external peer service
-            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+            if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+            end
+
             span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, event.address.host)
 
             # Set analytics sample rate

diff --git a/lib/datadog/tracing/contrib/mysql2/configuration/settings.rb b/lib/datadog/tracing/contrib/mysql2/configuration/settings.rb
@@ -29,7 +29,12 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
 

diff --git a/lib/datadog/tracing/contrib/mysql2/instrumentation.rb b/lib/datadog/tracing/contrib/mysql2/instrumentation.rb
@@ -32,8 +32,11 @@ def query(sql, options = {})
                 span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
                 span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
 
-                # Tag as an external peer service
-                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, service)
+                if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                  # Tag as an external peer service
+                  span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+                end
+
                 span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, query_options[:host])
 
                 # Set analytics sample rate

diff --git a/lib/datadog/tracing/contrib/pg/configuration/settings.rb b/lib/datadog/tracing/contrib/pg/configuration/settings.rb
@@ -29,7 +29,12 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
 

diff --git a/lib/datadog/tracing/contrib/pg/instrumentation.rb b/lib/datadog/tracing/contrib/pg/instrumentation.rb
@@ -126,8 +126,11 @@ def annotate_span_with_query!(span, service)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
               span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
 
-              # Tag as an external peer service
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, service)
+              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                # Tag as an external peer service
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              end
+
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
 
               span.set_tag(Contrib::Ext::DB::TAG_INSTANCE, db)

diff --git a/lib/datadog/tracing/contrib/presto/configuration/settings.rb b/lib/datadog/tracing/contrib/presto/configuration/settings.rb
@@ -27,7 +27,12 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
           end

diff --git a/lib/datadog/tracing/contrib/presto/instrumentation.rb b/lib/datadog/tracing/contrib/presto/instrumentation.rb
@@ -104,8 +104,10 @@ def decorate!(span, operation)
                 set_nilable_tag!(span, :http_proxy, Ext::TAG_PROXY)
                 set_nilable_tag!(span, :model_version, Ext::TAG_MODEL_VERSION)
 
-                # Tag as an external peer service
-                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+                if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                  # Tag as an external peer service
+                  span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+                end
 
                 # Set analytics sample rate
                 if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])

diff --git a/lib/datadog/tracing/contrib/racecar/configuration/settings.rb b/lib/datadog/tracing/contrib/racecar/configuration/settings.rb
@@ -26,7 +26,15 @@ class Settings < Contrib::Configuration::Settings
               o.lazy
             end
 
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  '',
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+              o.lazy
+            end
           end
         end
       end

diff --git a/lib/datadog/tracing/contrib/racecar/event.rb b/lib/datadog/tracing/contrib/racecar/event.rb
@@ -41,7 +41,9 @@ def process(span, event, _id, payload)
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
 
               # Tag as an external peer service
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              end
 
               # Set analytics sample rate
               if Contrib::Analytics.enabled?(configuration[:analytics_enabled])

diff --git a/lib/datadog/tracing/contrib/rack/middlewares.rb b/lib/datadog/tracing/contrib/rack/middlewares.rb
@@ -261,7 +261,9 @@ def trace_http_server(span_name, start_time:)
             )
 
             # Set peer service (so its not believed to belong to this app)
-            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, configuration[:web_service_name])
+            if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, configuration[:web_service_name])
+            end
 
             span
           end

diff --git a/lib/datadog/tracing/contrib/redis/configuration/settings.rb b/lib/datadog/tracing/contrib/redis/configuration/settings.rb
@@ -32,7 +32,12 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
           end

diff --git a/lib/datadog/tracing/contrib/redis/tags.rb b/lib/datadog/tracing/contrib/redis/tags.rb
@@ -17,7 +17,10 @@ def set_common_tags(client, span, show_command_args)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
 
               # Tag as an external peer service
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              end
+
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, client.host)
 
               span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)

diff --git a/lib/datadog/tracing/contrib/rest_client/configuration/settings.rb b/lib/datadog/tracing/contrib/rest_client/configuration/settings.rb
@@ -29,7 +29,12 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true
 
             option :service_name do |o|
-              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
               o.lazy
             end
 

diff --git a/lib/datadog/tracing/contrib/rest_client/request_patch.rb b/lib/datadog/tracing/contrib/rest_client/request_patch.rb
@@ -40,7 +40,10 @@ def datadog_tag_request(uri, span)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
 
               # Tag as an external peer service
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              end
+
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, uri.host)
 
               # Set analytics sample rate

diff --git a/lib/datadog/tracing/contrib/sequel/database.rb b/lib/datadog/tracing/contrib/sequel/database.rb
@@ -23,7 +23,10 @@ def run(sql, options = ::Sequel::OPTS)
               Tracing.trace(Ext::SPAN_QUERY) do |span|
                 span.service =  Datadog.configuration_for(self, :service_name) \
                                 || Datadog.configuration.tracing[:sequel][:service_name] \
-                                || adapter_name
+                                || Contrib::SpanAttributeSchema.fetch_service_name(
+                                  '',
+                                  adapter_name
+                                )
                 span.resource = opts[:query]
                 span.span_type = Tracing::Metadata::Ext::SQL::TYPE
                 Utils.set_common_tags(span, self)

diff --git a/lib/datadog/tracing/contrib/sequel/dataset.rb b/lib/datadog/tracing/contrib/sequel/dataset.rb
@@ -42,7 +42,10 @@ def trace_execute(super_method, sql, options, &block)
               Tracing.trace(Ext::SPAN_QUERY) do |span|
                 span.service =  Datadog.configuration_for(db, :service_name) \
                                 || Datadog.configuration.tracing[:sequel][:service_name] \
-                                || adapter_name
+                                || Contrib::SpanAttributeSchema.fetch_service_name(
+                                  '',
+                                  adapter_name
+                                )
                 span.resource = opts[:query]
                 span.span_type = Tracing::Metadata::Ext::SQL::TYPE
                 Utils.set_common_tags(span, db)

diff --git a/lib/datadog/tracing/contrib/sequel/utils.rb b/lib/datadog/tracing/contrib/sequel/utils.rb
@@ -53,7 +53,10 @@ def set_common_tags(span, db)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
 
               # Tag as an external peer service
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              end
+
               # TODO: Extract host for Sequel with JDBC. The easiest way seem to be through
               # TODO: the database URI. Unfortunately, JDBC URIs do not work with `URI.parse`.
               # host, _port = extract_host_port_from_uri(db.uri)

diff --git a/spec/datadog/tracing/contrib/active_support/configuration/settings_spec.rb b/spec/datadog/tracing/contrib/active_support/configuration/settings_spec.rb
@@ -0,0 +1,32 @@
+require 'datadog/tracing/contrib/active_support/configuration/settings'
+require 'datadog/tracing/contrib/service_name_settings_examples'
+
+RSpec.describe Datadog::Tracing::Contrib::ActiveSupport::Configuration::Settings do
+  describe 'Option `cache_service`' do
+    context 'when with cache_service' do # default to include base
+      it do
+        expect(described_class.new(cache_service: 'test-service').cache_service).to eq('test-service')
+      end
+    end
+
+    context 'when without service_name v0' do # default to include base
+      it do
+        with_modified_env DD_TRACE_SPAN_ATTRIBUTE_SCHEMA: 'v0' do
+          expect(described_class.new.cache_service).to eq('active_support-cache')
+        end
+      end
+    end
+
+    context 'when without service_name v1' do # default to include base
+      it do
+        with_modified_env DD_TRACE_SPAN_ATTRIBUTE_SCHEMA: 'v1' do
+          expect(described_class.new.cache_service).to eq('rspec')
+        end
+      end
+    end
+  end
+
+  def with_modified_env(options = {}, &block)
+    ClimateControl.modify(options, &block)
+  end
+end
diff --git a/spec/datadog/tracing/contrib/httpclient/configuration/settings_spec.rb b/spec/datadog/tracing/contrib/httpclient/configuration/settings_spec.rb
@@ -0,0 +1,6 @@
+require 'datadog/tracing/contrib/httpclient/configuration/settings'
+require 'datadog/tracing/contrib/service_name_settings_examples'
+
+RSpec.describe Datadog::Tracing::Contrib::Httpclient::Configuration::Settings do
+  it_behaves_like 'service name setting', 'httpclient'
+end
diff --git a/spec/datadog/tracing/contrib/httpclient/instrumentation_spec.rb b/spec/datadog/tracing/contrib/httpclient/instrumentation_spec.rb
@@ -13,6 +13,7 @@
 require 'datadog/tracing/contrib/integration_examples'
 require 'datadog/tracing/contrib/support/spec_helper'
 require 'datadog/tracing/contrib/environment_service_name_examples'
+require 'datadog/tracing/contrib/span_attribute_schema_examples'
 require 'datadog/tracing/contrib/http_examples'
 require 'spec/support/thread_helpers'
 
@@ -138,6 +139,7 @@
           end
 
           it_behaves_like 'environment service name', 'DD_TRACE_HTTPCLIENT_SERVICE_NAME'
+          it_behaves_like 'schema version span'
 
           it_behaves_like 'analytics for integration' do
             let(:analytics_enabled_var) { Datadog::Tracing::Contrib::Httpclient::Ext::ENV_ANALYTICS_ENABLED }
@@ -168,6 +170,7 @@
           end
 
           it_behaves_like 'environment service name', 'DD_TRACE_HTTPCLIENT_SERVICE_NAME'
+          it_behaves_like 'schema version span'
         end
 
         context 'response has not found status' do
@@ -193,6 +196,7 @@
           end
 
           it_behaves_like 'environment service name', 'DD_TRACE_HTTPCLIENT_SERVICE_NAME'
+          it_behaves_like 'schema version span'
         end
 
         context 'distributed tracing default' do

diff --git a/spec/datadog/tracing/contrib/httprb/configuration/settings_spec.rb b/spec/datadog/tracing/contrib/httprb/configuration/settings_spec.rb
@@ -0,0 +1,6 @@
+require 'datadog/tracing/contrib/httprb/configuration/settings'
+require 'datadog/tracing/contrib/service_name_settings_examples'
+
+RSpec.describe Datadog::Tracing::Contrib::Httprb::Configuration::Settings do
+  it_behaves_like 'service name setting', 'httprb'
+end