ddtrace 0.33.1 → 0.34.0

data/docker-compose.yml

@@ -10,6 +10,7 @@ services:
       - mongodb
       - mysql
       - postgres
+      - presto
       - redis
     env_file: ./.env
     environment:
@@ -21,6 +22,7 @@ services:
       - TEST_MONGODB_HOST=mongodb
       - TEST_MYSQL_HOST=mysql
       - TEST_POSTGRES_HOST=postgres
+      - TEST_PRESTO_HOST=presto
       - TEST_REDIS_HOST=redis
     stdin_open: true
     tty: true
@@ -38,6 +40,7 @@ services:
       - mongodb
       - mysql
       - postgres
+      - presto
       - redis
     env_file: ./.env
     environment:
@@ -49,6 +52,8 @@ services:
       - TEST_MONGODB_HOST=mongodb
       - TEST_MYSQL_HOST=mysql
       - TEST_POSTGRES_HOST=postgres
+      - TEST_PRESTO_HOST=presto
+      - TEST_PRESTO_PORT=8080
       - TEST_REDIS_HOST=redis
     stdin_open: true
     tty: true
@@ -66,6 +71,7 @@ services:
       - mongodb
       - mysql
       - postgres
+      - presto
       - redis
     env_file: ./.env
     environment:
@@ -77,6 +83,8 @@ services:
       - TEST_MONGODB_HOST=mongodb
       - TEST_MYSQL_HOST=mysql
       - TEST_POSTGRES_HOST=postgres
+      - TEST_PRESTO_HOST=presto
+      - TEST_PRESTO_PORT=8080
       - TEST_REDIS_HOST=redis
     stdin_open: true
     tty: true
@@ -94,6 +102,7 @@ services:
       - mongodb
       - mysql
       - postgres
+      - presto
       - redis
     env_file: ./.env
     environment:
@@ -105,6 +114,8 @@ services:
       - TEST_MONGODB_HOST=mongodb
       - TEST_MYSQL_HOST=mysql
       - TEST_POSTGRES_HOST=postgres
+      - TEST_PRESTO_HOST=presto
+      - TEST_PRESTO_PORT=8080
       - TEST_REDIS_HOST=redis
     stdin_open: true
     tty: true
@@ -122,6 +133,7 @@ services:
       - mongodb
       - mysql
       - postgres
+      - presto
       - redis
     env_file: ./.env
     environment:
@@ -133,6 +145,8 @@ services:
       - TEST_MONGODB_HOST=mongodb
       - TEST_MYSQL_HOST=mysql
       - TEST_POSTGRES_HOST=postgres
+      - TEST_PRESTO_HOST=presto
+      - TEST_PRESTO_PORT=8080
       - TEST_REDIS_HOST=redis
     stdin_open: true
     tty: true
@@ -181,6 +195,7 @@ services:
       - mongodb
       - mysql
       - postgres
+      - presto
       - redis
     env_file: ./.env
     environment:
@@ -192,6 +207,8 @@ services:
       - TEST_MONGODB_HOST=mongodb
       - TEST_MYSQL_HOST=mysql
       - TEST_POSTGRES_HOST=postgres
+      - TEST_PRESTO_HOST=presto
+      - TEST_PRESTO_PORT=8080
       - TEST_REDIS_HOST=redis
     stdin_open: true
     tty: true
@@ -209,6 +226,7 @@ services:
       - mongodb
       - mysql
       - postgres
+      - presto
       - redis
     env_file: ./.env
     environment:
@@ -220,6 +238,8 @@ services:
       - TEST_MONGODB_HOST=mongodb
       - TEST_MYSQL_HOST=mysql
       - TEST_POSTGRES_HOST=postgres
+      - TEST_PRESTO_HOST=presto
+      - TEST_PRESTO_PORT=8080
       - TEST_REDIS_HOST=redis
     stdin_open: true
     tty: true

data/docs/GettingStarted.md

@@ -674,6 +674,12 @@ require 'ddtrace'
 
 Datadog.configure do |c|
   c.use :ethon, options
+
+  # optionally, specify a different service name for hostnames matching a regex
+  c.use :ethon, describes: /user-[^.]+\.example\.com/ do |ethon|
+    ethon.service_name = 'user.example.com'
+    ethon.split_by_domain = false # Only necessary if split_by_domain is true by default
+  end
 end
 ```
 
@@ -684,6 +690,7 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `analytics_enabled` | Enable analytics for spans produced by this integration. `true` for on, `nil` to defer to global setting, `false` for off. | `false` |
 | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
 | `service_name` | Service name for `ethon` instrumentation. | `'ethon'` |
+| `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
 | `tracer` | `Datadog::Tracer` used to perform instrumentation. Usually you don't need to set this. | `Datadog.tracer` |
 
 ### Excon
@@ -697,6 +704,12 @@ require 'ddtrace'
 # Configure default Excon tracing behavior
 Datadog.configure do |c|
   c.use :excon, options
+
+  # optionally, specify a different service name for hostnames matching a regex
+  c.use :excon, describes: /user-[^.]+\.example\.com/ do |excon|
+    excon.service_name = 'user.example.com'
+    excon.split_by_domain = false # Only necessary if split_by_domain is true by default
+  end
 end
 
 connection = Excon.new('https://example.com')
@@ -750,6 +763,12 @@ require 'ddtrace'
 # Configure default Faraday tracing behavior
 Datadog.configure do |c|
   c.use :faraday, options
+
+  # optionally, specify a different service name for hostnames matching a regex
+  c.use :faraday, describes: /user-[^.]+\.example\.com/ do |faraday|
+    faraday.service_name = 'user.example.com'
+    faraday.split_by_domain = false # Only necessary if split_by_domain is true by default
+  end
 end
 
 # Configure Faraday tracing behavior for single connection
@@ -991,6 +1010,12 @@ require 'ddtrace'
 
 Datadog.configure do |c|
   c.use :http, options
+
+  # optionally, specify a different service name for hostnames matching a regex
+  c.use :http, describes: /user-[^.]+\.example\.com/ do |http|
+    http.service_name = 'user.example.com'
+    http.split_by_domain = false # Only necessary if split_by_domain is true by default
+  end
 end
 
 Net::HTTP.start('127.0.0.1', 8080) do |http|
@@ -1008,6 +1033,7 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `analytics_enabled` | Enable analytics for spans produced by this integration. `true` for on, `nil` to defer to global setting, `false` for off. | `false` |
 | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
 | `service_name` | Service name used for `http` instrumentation | `'net/http'` |
+| `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
 | `tracer` | `Datadog::Tracer` used to perform instrumentation. Usually you don't need to set this. | `Datadog.tracer` |
 
 If you wish to configure each connection object individually, you may use the `Datadog.configure` as it follows:
@@ -1565,11 +1591,21 @@ Datadog::Logger.log.info { "this is typically called by tracing code" }
 
 By default, the trace agent (not this library, but the program running in the background collecting data from various clients) uses the tags set in the agent config file, see our [environments tutorial](https://app.datadoghq.com/apm/docs/tutorials/environments) for details.
 
-These values can be overridden at the tracer level:
+You can configure the application to automatically tag your traces and metrics, using the following environment variables:
+
+ - `DD_ENV`: Your application environment (e.g. `production`, `staging`, etc.)
+ - `DD_VERSION`: Your application version (e.g. `2.5`, `202003181415`, `1.3-alpha`, etc.)
+ - `DD_TAGS`: Custom tags in value pairs separated by `,` (e.g. `layer:api,team:intake`)
+    - If `DD_ENV` or `DD_VERSION`, it will override any `env` or `version` tag defined in `DD_TAGS`.
+
+These values can also be overridden at the tracer level:
 
 ```ruby
 Datadog.configure do |c|
-  c.tracer tags: { 'env' => 'prod' }
+  c.service = 'billing-api'
+  c.env = 'test'
+  c.tags = { 'team' => 'qa' }
+  c.version = '1.3-alpha'
 end
 ```
 
@@ -1863,6 +1899,8 @@ Datadog.tracer.trace('correlation.example') do
   correlation = Datadog.tracer.active_correlation
   correlation.trace_id # => 5963550561812073440
   correlation.span_id # => 2232727802607726424
+  correlation.env # => 'production' (derived from DD_ENV)
+  correlation.version # => '2.5.17' (derived from DD_VERSION)
 end
 
 # When a trace isn't active...
@@ -1871,6 +1909,8 @@ correlation = Datadog.tracer.active_correlation
 correlation = Datadog.tracer.active_correlation
 correlation.trace_id # => 0
 correlation.span_id # => 0
+correlation.trace_id # => nil
+correlation.span_id # => nil
 ```
 
 #### For logging in Rails applications using Lograge (recommended)
@@ -1887,7 +1927,9 @@ config.lograge.custom_options = lambda do |event|
     :dd => {
       # To preserve precision during JSON serialization, use strings for large numbers
       :trace_id => correlation.trace_id.to_s,
-      :span_id => correlation.span_id.to_s
+      :span_id => correlation.span_id.to_s,
+      :env => correlation.env.to_s,
+      :version => correlation.version.to_s
     },
     :ddsource => ["ruby"],
     :params => event.payload[:params].reject { |k| %w(controller action).include? k }
@@ -1906,11 +1948,15 @@ Rails.application.configure do
   config.log_tags = [proc { Datadog.tracer.active_correlation.to_s }]
 end
 
+# Given:
+# DD_ENV = 'production' (The name of the environment your application is running in.)
+# DD_VERSION = '2.5.17' (The version of your application.)
+
 # Web requests will produce:
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Started GET "/articles" for 172.22.0.1 at 2019-01-16 18:50:57 +0000
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Processing by ArticlesController#index as */*
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206]   Article Load (0.5ms)  SELECT "articles".* FROM "articles"
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Completed 200 OK in 7ms (Views: 5.5ms | ActiveRecord: 0.5ms)
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206 dd.env=production dd.version=2.5.17] Started GET "/articles" for 172.22.0.1 at 2019-01-16 18:50:57 +0000
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206 dd.env=production dd.version=2.5.17] Processing by ArticlesController#index as */*
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206 dd.env=production dd.version=2.5.17]   Article Load (0.5ms)  SELECT "articles".* FROM "articles"
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206 dd.env=production dd.version=2.5.17] Completed 200 OK in 7ms (Views: 5.5ms | ActiveRecord: 0.5ms)
 ```
 
 #### For logging in Ruby applications
@@ -1921,8 +1967,12 @@ To properly correlate with Datadog logging, be sure the following is present in
 
  - `dd.trace_id=<TRACE_ID>`: Where `<TRACE_ID>` is equal to `Datadog.tracer.active_correlation.trace_id` or `0` if no trace is active during logging.
  - `dd.span_id=<SPAN_ID>`: Where `<SPAN_ID>` is equal to `Datadog.tracer.active_correlation.span_id` or `0` if no trace is active during logging.
+ - `dd.env=<ENV>`: Where `<ENV>` is equal to `Datadog.tracer.active_correlation.env` or empty string (no quotes) if no environment name is configured.
+ - `dd.version=<SPAN_ID>`: Where `<SPAN_ID>` is equal to `Datadog.tracer.active_correlation.version` or empty string (no quotes) if no application version is configured.
+
+By default, `Datadog::Correlation::Identifier#to_s` will return `dd.trace_id=<TRACE_ID> dd.span_id=<SPAN_ID> dd.env=<ENV> dd.version=<VERSION>`.
 
-By default, `Datadog::Correlation::Identifier#to_s` will return `dd.trace_id=<TRACE_ID> dd.span_id=<SPAN_ID>`.
+If a trace is not active and the application environment & version is not configured, it will return `dd.trace_id=0 dd.span_id=0 dd.env= dd.version=`.
 
 An example of this in practice:
 
@@ -1930,6 +1980,9 @@ An example of this in practice:
 require 'ddtrace'
 require 'logger'
 
+ENV['DD_ENV'] = 'production'
+ENV['DD_VERSION'] = '2.5.17'
+
 logger = Logger.new(STDOUT)
 logger.progname = 'my_app'
 logger.formatter  = proc do |severity, datetime, progname, msg|
@@ -1938,11 +1991,11 @@ end
 
 # When no trace is active
 logger.warn('This is an untraced operation.')
-# [2019-01-16 18:38:41 +0000][my_app][WARN][dd.trace_id=0 dd.span_id=0] This is an untraced operation.
+# [2019-01-16 18:38:41 +0000][my_app][WARN][dd.trace_id=0 dd.span_id=0 dd.env=production dd.version=2.5.17] This is an untraced operation.
 
 # When a trace is active
 Datadog.tracer.trace('my.operation') { logger.warn('This is a traced operation.') }
-# [2019-01-16 18:38:41 +0000][my_app][WARN][dd.trace_id=8545847825299552251 dd.span_id=3711755234730770098] This is a traced operation.
+# [2019-01-16 18:38:41 +0000][my_app][WARN][dd.trace_id=8545847825299552251 dd.span_id=3711755234730770098 dd.env=production dd.version=2.5.17] This is a traced operation.
 ```
 
 ### Configuring the transport layer

data/lib/ddtrace.rb

@@ -27,6 +27,10 @@ module Datadog
   require 'ddtrace/contrib/extensions'
   extend Contrib::Extensions
 
+  # Load and extend OpenTelemetry compatibility by default
+  require 'ddtrace/opentelemetry/extensions'
+  extend OpenTelemetry::Extensions
+
   # Add shutdown hook:
   # Ensures the tracer has an opportunity to flush traces
   # and cleanup before terminating the process.

data/lib/ddtrace/analytics.rb

@@ -8,6 +8,13 @@ module Datadog
         return if span.nil? || !sample_rate.is_a?(Numeric)
         span.set_metric(Datadog::Ext::Analytics::TAG_SAMPLE_RATE, sample_rate)
       end
+
+      def set_measured(span, value = true)
+        return if span.nil?
+        # rubocop:disable Style/MultipleComparison
+        value = value == true || value == 1 ? 1 : 0
+        span.set_metric(Datadog::Ext::Analytics::TAG_MEASURED, value)
+      end
     end
 
     # Extension for Datadog::Span

data/lib/ddtrace/configuration/base.rb

@@ -7,6 +7,7 @@ module Datadog
     module Base
       def self.included(base)
         base.send(:extend, Datadog::Environment::Helpers)
+        base.send(:include, Datadog::Environment::Helpers)
         base.send(:include, Options)
 
         base.send(:extend, ClassMethods)
@@ -23,7 +24,7 @@ module Datadog
           settings_class = new_settings_class(&block)
 
           option(name) do |o|
-            o.default -> { settings_class.new }
+            o.default { settings_class.new }
             o.lazy
             o.resetter do |value|
               value.reset! if value.respond_to?(:reset!)

data/lib/ddtrace/configuration/option.rb

@@ -26,7 +26,7 @@ module Datadog
         elsif definition.delegate_to
           context_eval(&definition.delegate_to)
         else
-          set(definition.default_value)
+          set(default_value)
         end
       end
 
@@ -42,6 +42,14 @@ module Datadog
                  end
       end
 
+      def default_value
+        if definition.lazy
+          context_eval(&definition.default)
+        else
+          definition.default
+        end
+      end
+
       private
 
       def context_exec(*args, &block)

data/lib/ddtrace/configuration/option_definition.rb

@@ -27,10 +27,6 @@ module Datadog
         @setter = meta[:setter] || block || IDENTITY
       end
 
-      def default_value
-        lazy ? @default.call : @default
-      end
-
       # Creates a new Option, bound to the context provided.
       def build(context)
         Option.new(self, context)

data/lib/ddtrace/configuration/settings.rb

@@ -19,18 +19,21 @@ module Datadog
       # Configuration options
       #
       option :analytics_enabled do |o|
+        # TODO: Raise deprecation warning
         o.default { env_to_bool(Ext::Analytics::ENV_TRACE_ANALYTICS_ENABLED, nil) }
         o.lazy
       end
 
-      option :report_hostname do |o|
-        o.default { env_to_bool(Ext::NET::ENV_REPORT_HOSTNAME, false) }
-        o.lazy
-      end
+      settings :diagnostics do
+        option :health_metrics do |o|
+          o.default do
+            Datadog::Diagnostics::Health::Metrics.new(
+              enabled: env_to_bool(Datadog::Ext::Diagnostics::Health::Metrics::ENV_ENABLED, false)
+            )
+          end
 
-      option :runtime_metrics_enabled do |o|
-        o.default { env_to_bool(Ext::Runtime::Metrics::ENV_ENABLED, false) }
-        o.lazy
+          o.lazy
+        end
       end
 
       settings :distributed_tracing do
@@ -57,6 +60,31 @@ module Datadog
         end
       end
 
+      option :env do |o|
+        o.default { ENV.fetch(Ext::Environment::ENV_ENVIRONMENT, nil) }
+        o.lazy
+      end
+
+      option :report_hostname do |o|
+        o.default { env_to_bool(Ext::NET::ENV_REPORT_HOSTNAME, false) }
+        o.lazy
+      end
+
+      # Backwards compatibility for configuring runtime metrics e.g. `c.runtime_metrics enabled: true`
+      def runtime_metrics(options = nil)
+        runtime_metrics = get_option(:tracer).writer.runtime_metrics
+        return runtime_metrics if options.nil?
+
+        # TODO: Raise deprecation warning
+        runtime_metrics.configure(options)
+      end
+
+      option :runtime_metrics_enabled do |o|
+        # TODO: Raise deprecation warning
+        o.default { env_to_bool(Ext::Runtime::Metrics::ENV_ENABLED, false) }
+        o.lazy
+      end
+
       settings :sampling do
         option :default_rate do |o|
           o.default { env_to_float(Ext::Sampling::ENV_SAMPLE_RATE, nil) }
@@ -69,16 +97,29 @@ module Datadog
         end
       end
 
-      settings :diagnostics do
-        option :health_metrics do |o|
-          o.default do
-            Datadog::Diagnostics::Health::Metrics.new(
-              enabled: env_to_bool(Datadog::Ext::Diagnostics::Health::Metrics::ENV_ENABLED, false)
-            )
+      option :service do |o|
+        o.default { ENV.fetch(Ext::Environment::ENV_SERVICE, nil) }
+        o.lazy
+      end
+
+      option :tags do |o|
+        o.default do
+          tags = {}
+
+          # Parse tags from environment
+          env_to_list(Ext::Environment::ENV_TAGS).each do |tag|
+            pair = tag.split(':')
+            tags[pair.first] = pair.last if pair.length == 2
           end
 
-          o.lazy
+          # Override tags if defined
+          tags[Ext::Environment::TAG_ENV] = env unless env.nil?
+          tags[Ext::Environment::TAG_VERSION] = version unless version.nil?
+
+          tags
         end
+
+        o.lazy
       end
 
       option :tracer do |o|
@@ -99,20 +140,34 @@ module Datadog
           tracer.tap do |t|
             unless options.nil?
               t.configure(options)
-              Datadog::Logger.log = options[:log] if options[:log]
-              t.set_tags(options[:tags]) if options[:tags]
-              t.set_tags(env: options[:env]) if options[:env]
-              Datadog::Logger.debug_logging = options.fetch(:debug, false)
+
+              if options[:log]
+                # TODO: Raise deprecation warning
+                Datadog::Logger.log = options[:log]
+              end
+
+              if options[:tags]
+                # TODO: Raise deprecation warning
+                t.set_tags(options[:tags])
+              end
+
+              if options[:env]
+                # TODO: Raise deprecation warning
+                t.set_tags(env: options[:env])
+              end
+
+              if options.key?(:debug)
+                # TODO: Raise deprecation warning
+                Datadog::Logger.debug_logging = options[:debug]
+              end
             end
           end
         end
       end
 
-      def runtime_metrics(options = nil)
-        runtime_metrics = get_option(:tracer).writer.runtime_metrics
-        return runtime_metrics if options.nil?
-
-        runtime_metrics.configure(options)
+      option :version do |o|
+        o.default { ENV.fetch(Ext::Environment::ENV_VERSION, nil) }
+        o.lazy
       end
     end
   end