ddtrace 0.46.0 → 0.51.0

data/integration/apps/ruby/script/build-images

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 
 APP_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"

data/integration/apps/ruby/script/ci

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 
 APP_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
@@ -44,7 +44,8 @@ echo ""
 APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES build
 
 # Run the test suite
-APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES run integration-tester
+APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES run integration-tester || \
+  APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES logs # Print container logs on `run` failure
 
 # Cleanup
 APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES down -t 0 --remove-orphans

data/integration/images/include/datadog/demo_env.rb

@@ -1,15 +1,16 @@
 module Datadog
+  # Helpers to read the application environment
   module DemoEnv
     module_function
 
     def gem_spec(gem_name, defaults = {})
-      args =  if local_gem(gem_name)
-                [local_gem(gem_name)]
-              elsif git_gem(gem_name)
-                [git_gem(gem_name)]
-              else
-                []
-              end
+      args = if local_gem(gem_name)
+               [local_gem(gem_name)]
+             elsif git_gem(gem_name)
+               [git_gem(gem_name)]
+             else
+               []
+             end
 
       yield(args) if block_given?
 
@@ -17,7 +18,7 @@ module Datadog
     end
 
     def gem_env_name(gem_name)
-      gem_name.upcase.gsub('-', '_')
+      gem_name.upcase.tr('-', '_')
     end
 
     def local_gem(gem_name)
@@ -55,11 +56,11 @@ module Datadog
       puts "Features: #{features}"
       puts "Rails env: #{ENV['RAILS_ENV']}" if ENV['RAILS_ENV']
       puts "PID: #{Process.pid}"
-      if ddtrace = Gem.loaded_specs['ddtrace']
-        puts "Runtime ID: #{Datadog::Runtime::Identity.id}" if defined?(Datadog::Runtime::Identity)
+      if (ddtrace = Gem.loaded_specs['ddtrace'])
+        puts "Runtime ID: #{Datadog::Core::Environment::Identity.id}" if defined?(Datadog::Core::Environment::Identity)
         puts "ddtrace version: #{ddtrace.version}"
         puts "ddtrace path: #{ddtrace.full_gem_path}"
-        if git_spec = git_gem('ddtrace')
+        if (git_spec = git_gem('ddtrace'))
           puts "ddtrace git: #{git_spec[:git]}"
           puts "ddtrace ref: #{git_spec[:ref]}"
         end
@@ -69,10 +70,10 @@ module Datadog
 
     def profiler_file_transport(dump_path = "/data/profile-pid-#{Process.pid}.pprof")
       Datadog::Profiling::Transport::IO.default(
-        write: ->(out, data) do
+        write: lambda do |_out, data|
           result = nil
           puts "Writing pprof #{dump_path}..."
-          File.open(dump_path, "w") { |f| result = f.write(data) }
+          File.open(dump_path, 'w') { |f| result = f.write(data) }
           puts "Pprof #{dump_path} written!"
           result
         end
@@ -86,7 +87,7 @@ module Datadog
 
     def finish_mem_dump!(dump_path = "/data/mem-pid-#{Process.pid}.dump")
       File.delete(dump_path) if File.exist?(dump_path)
-      File.open(dump_path, "w") do |io|
+      File.open(dump_path, 'w') do |io|
         ObjectSpace.dump_all(output: io)
       end
     end

data/integration/images/include/http-health-check

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 
 # If health check URL provided, wait till it passes.

data/integration/images/wrk/scripts/entrypoint.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 bash /vendor/dd-demo/http-health-check
 
 # Start the load test

data/integration/script/build-images

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 
 INTEGRATION_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"

data/lib/datadog/ci.rb

@@ -0,0 +1,16 @@
+require 'ddtrace'
+
+module Datadog
+  # Namespace for Datadog CI instrumentation:
+  # e.g. rspec, cucumber, etc...
+  module CI
+  end
+end
+
+# Integrations
+require 'datadog/ci/contrib/cucumber/integration'
+require 'datadog/ci/contrib/rspec/integration'
+
+# Extensions
+require 'datadog/ci/extensions'
+Datadog::CI::Extensions.activate!

data/lib/datadog/ci/configuration/components.rb

@@ -0,0 +1,30 @@
+require 'datadog/ci/context_flush'
+
+module Datadog
+  module CI
+    module Configuration
+      # Adds CI behavior to Datadog trace components
+      module Components
+        def initialize(settings)
+          # Activate CI mode if enabled
+          activate_ci_mode!(settings) if settings.ci_mode.enabled
+
+          # Initialize normally
+          super
+        end
+
+        def activate_ci_mode!(settings)
+          # Activate underlying tracing test mode
+          settings.test_mode.enabled = true
+
+          # Choose user defined ContextFlush or default to CI ContextFlush
+          settings.test_mode.context_flush = settings.ci_mode.context_flush \
+                                             || Datadog::CI::ContextFlush::Finished.new
+
+          # Pass through any other options
+          settings.test_mode.writer_options = settings.ci_mode.writer_options
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/configuration/settings.rb

@@ -0,0 +1,36 @@
+require 'datadog/ci/ext/settings'
+
+module Datadog
+  module CI
+    module Configuration
+      # Adds CI behavior to Datadog trace settings
+      module Settings
+        def self.extended(base)
+          base = base.singleton_class unless base.is_a?(Class)
+          add_settings!(base)
+        end
+
+        def self.add_settings!(base)
+          base.class_eval do
+            settings :ci_mode do
+              option :enabled do |o|
+                o.default { env_to_bool(Datadog::CI::Ext::Settings::ENV_MODE_ENABLED, false) }
+                o.lazy
+              end
+
+              option :context_flush do |o|
+                o.default { nil }
+                o.lazy
+              end
+
+              option :writer_options do |o|
+                o.default { {} }
+                o.lazy
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/context_flush.rb

@@ -0,0 +1,28 @@
+require 'ddtrace/context_flush'
+
+module Datadog
+  module CI
+    module ContextFlush
+      # Common behavior for CI flushing
+      module Tagging
+        # Decorate a trace with CI tags
+        def get_trace(context)
+          context.get do |trace|
+            # Origin tag is required on every span
+            trace.each { |span| context.attach_origin(span) } if trace
+          end
+        end
+      end
+
+      # Consumes only completed traces (where all spans have finished)
+      class Finished < Datadog::ContextFlush::Finished
+        prepend Tagging
+      end
+
+      # Performs partial trace flushing to avoid large traces residing in memory for too long
+      class Partial < Datadog::ContextFlush::Partial
+        prepend Tagging
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/cucumber/configuration/settings.rb

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'datadog/ci/contrib/cucumber/ext'
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        module Configuration
+          # Custom settings for the Cucumber integration
+          class Settings < Datadog::Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+
+            option :service_name do |o|
+              o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
+              o.lazy
+            end
+
+            option :operation_name do |o|
+              o.default { ENV.key?(Ext::ENV_OPERATION_NAME) ? ENV[Ext::ENV_OPERATION_NAME] : Ext::OPERATION_NAME }
+              o.lazy
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/cucumber/ext.rb

@@ -0,0 +1,19 @@
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Cucumber integration constants
+        module Ext
+          APP = 'cucumber'.freeze
+          ENV_ENABLED = 'DD_TRACE_CUCUMBER_ENABLED'.freeze
+          ENV_OPERATION_NAME = 'DD_TRACE_CUCUMBER_OPERATION_NAME'.freeze
+          FRAMEWORK = 'cucumber'.freeze
+          OPERATION_NAME = 'cucumber.test'.freeze
+          SERVICE_NAME = 'cucumber'.freeze
+          STEP_SPAN_TYPE = 'step'.freeze
+          TEST_TYPE = 'test'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/cucumber/formatter.rb

@@ -0,0 +1,97 @@
+require 'datadog/ci/test'
+require 'datadog/ci/ext/app_types'
+require 'datadog/ci/ext/environment'
+require 'datadog/ci/ext/test'
+require 'datadog/ci/contrib/cucumber/ext'
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Defines collection of instrumented Cucumber events
+        class Formatter
+          attr_reader :config, :current_feature_span, :current_step_span
+          private :config
+          private :current_feature_span, :current_step_span
+
+          def initialize(config)
+            @config = config
+
+            bind_events(config)
+          end
+
+          def bind_events(config)
+            config.on_event :test_case_started, &method(:on_test_case_started)
+            config.on_event :test_case_finished, &method(:on_test_case_finished)
+            config.on_event :test_step_started, &method(:on_test_step_started)
+            config.on_event :test_step_finished, &method(:on_test_step_finished)
+          end
+
+          def on_test_case_started(event)
+            @current_feature_span = CI::Test.trace(
+              tracer,
+              configuration[:operation_name],
+              {
+                span_options: {
+                  app: Ext::APP,
+                  resource: event.test_case.name,
+                  service: configuration[:service_name]
+                },
+                framework: Ext::FRAMEWORK,
+                test_name: event.test_case.name,
+                test_suite: event.test_case.location.file,
+                test_type: Ext::TEST_TYPE
+              }
+            )
+          end
+
+          def on_test_case_finished(event)
+            return if @current_feature_span.nil?
+
+            if event.result.skipped?
+              CI::Test.skipped!(@current_feature_span)
+            elsif event.result.ok?
+              CI::Test.passed!(@current_feature_span)
+            elsif event.result.failed?
+              CI::Test.failed!(@current_feature_span)
+            end
+
+            @current_feature_span.finish
+          end
+
+          def on_test_step_started(event)
+            trace_options = {
+              resource: event.test_step.to_s,
+              span_type: Ext::STEP_SPAN_TYPE
+            }
+            @current_step_span = tracer.trace(Ext::STEP_SPAN_TYPE, trace_options)
+          end
+
+          def on_test_step_finished(event)
+            return if @current_step_span.nil?
+
+            if event.result.skipped?
+              CI::Test.skipped!(@current_step_span, event.result.exception)
+            elsif event.result.ok?
+              CI::Test.passed!(@current_step_span)
+            elsif event.result.failed?
+              CI::Test.failed!(@current_step_span, event.result.exception)
+            end
+
+            @current_step_span.finish
+          end
+
+          private
+
+          def configuration
+            Datadog.configuration[:cucumber]
+          end
+
+          def tracer
+            configuration[:tracer]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/cucumber/instrumentation.rb

@@ -0,0 +1,26 @@
+require 'datadog/ci/contrib/cucumber/formatter'
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Instrumentation for Cucumber
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Instance methods for configuration
+          module InstanceMethods
+            attr_reader :datadog_formatter
+
+            def formatters
+              @datadog_formatter ||= Datadog::CI::Contrib::Cucumber::Formatter.new(@configuration)
+              [@datadog_formatter] + super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/cucumber/integration.rb

@@ -0,0 +1,47 @@
+require 'ddtrace/contrib/integration'
+
+require 'datadog/ci/contrib/cucumber/configuration/settings'
+require 'datadog/ci/contrib/cucumber/patcher'
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Description of Cucumber integration
+        class Integration
+          include Datadog::Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('3.0.0')
+
+          register_as :cucumber, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['cucumber'] \
+              && Gem.loaded_specs['cucumber'].version
+          end
+
+          def self.loaded?
+            !defined?(::Cucumber).nil? && !defined?(::Cucumber::Runtime).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          # test environments should not auto instrument test libraries
+          def auto_instrument?
+            false
+          end
+
+          def default_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end