ddtrace 0.48.0 → 0.51.1

data/integration/apps/rspec/app/fibonacci.rb

@@ -0,0 +1,30 @@
+require_relative 'datadog'
+
+def fib(n)
+  n <= 1 ? n : fib(n-1) + fib(n-2)
+end
+
+def trace(*options, &block)
+  raise ArgumentError('Must provide trace block') unless block_given?
+
+  if Datadog::DemoEnv.feature?('tracing')
+    Datadog.tracer.trace(*options, &block)
+  else
+    yield
+  end
+end
+
+def generate_fib
+  loop do
+    n = rand(25..35)
+
+    trace('compute.fibonacci') do |span|
+      result = fib(n)
+      span.set_metric('operation.fibonacci.n', n)
+      span.set_metric('operation.fibonacci.result', result)
+      yield(span) if block_given?
+    end
+
+    sleep(0.1)
+  end
+end

data/integration/apps/rspec/bin/run

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# Start application process
+puts "\n== Starting application process =="
+
+profiling = Datadog::DemoEnv.feature?('profiling') ? 'DD_PROFILING_ENABLED=true ddtracerb exec ' : ''
+process = (ARGV[0] || Datadog::DemoEnv.process)
+command = case process
+          when 'rspec'
+            'bundle exec rspec'
+          when 'irb'
+            "bundle exec #{profiling}irb"
+          when nil, ''
+            abort("\n== ERROR: Must specify a application process! ==")
+          else
+            abort("\n== ERROR: Unknown application process '#{process}' ==")
+          end
+
+puts "Run: #{command}"
+Kernel.exec(command)

data/integration/apps/rspec/bin/setup

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  puts "Run: #{args.join(' ')}"
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  puts "\n== Installing dependencies =="
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Create an non-trivial git repository, to augment test payload information.
+  system! 'git init'
+  system! 'GIT_AUTHOR_NAME="Test Author" GIT_AUTHOR_EMAIL=author@local.test ' \
+          'GIT_COMMITTER_NAME="Test Committer" GIT_COMMITTER_EMAIL=committer@local.test ' \
+          'git commit --allow-empty -m "Test message"'
+end

data/integration/apps/rspec/bin/test

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  puts "Run: #{args.join(' ')}"
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  puts "\n== Performing setup =="
+  system!('./bin/setup')
+
+  puts "\n== Run test suite =="
+  # DEV: There are no RSpec tests right now.
+  #      Re-enable this when we have something worth testing.
+  # system!('rspec')
+end

data/integration/apps/rspec/docker-compose.ci.yml

@@ -0,0 +1,51 @@
+version: '3.4'
+services:
+  app:
+    # Build at dd-trace-rb level to copy in current code
+    # and use it as the `ddtrace` gem.
+    build:
+      context: ../../..
+      dockerfile: integration/apps/rspec/Dockerfile-ci
+      args:
+        BASE_IMAGE: ${APP_IMAGE}
+    depends_on:
+      - ddagent
+    environment:
+      - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
+      - DD_METRIC_AGENT_PORT=8125
+      - DD_TRACE_AGENT_PORT=8126
+      - DD_HEALTH_METRICS_ENABLED=true
+      - DD_SERVICE=acme-rspec
+      - DD_PROFILING_ENABLED=true
+      # Use these to choose what is run
+      - DD_DEMO_ENV_PROCESS=rspec
+      - DD_DEMO_ENV_FEATURES=tracing
+    stdin_open: true
+    tty: true
+  ddagent:
+    image: datadog/dd-apm-demo:agent
+    environment:
+      - DD_APM_ENABLED=true
+      - DD_PROCESS_AGENT_ENABLED=false
+      - DD_BIND_HOST=0.0.0.0
+      - DD_API_KEY=invalid_api_key
+      - LOG_LEVEL=DEBUG
+      - DD_LOGS_STDOUT=yes
+      - DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true
+    expose:
+      - "8125/udp"
+      - "8126"
+  # Build at dd-trace-rb level to copy in current code
+  # and use it as the `ddtrace` gem.
+  integration-tester:
+    build:
+      context: ../../..
+      dockerfile: integration/apps/rspec/Dockerfile-ci
+      args:
+        BASE_IMAGE: ${APP_IMAGE}
+    command: bin/test
+    # volumes:
+    #   - .:/app
+    #   - ../../images/include:/vendor/dd-demo
+    #   - ../../..:/vendor/dd-trace-rb

data/integration/apps/rspec/docker-compose.yml

@@ -0,0 +1,64 @@
+version: '3.4'
+services:
+  app:
+    build:
+      context: .
+      args:
+        BASE_IMAGE: datadog/dd-apm-demo:rb-3.0
+    depends_on:
+      - ddagent
+    environment:
+      - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
+      - DD_METRIC_AGENT_PORT=8125
+      - DD_TRACE_AGENT_PORT=8126
+      - DD_HEALTH_METRICS_ENABLED=true
+      - DD_SERVICE=acme-rspec
+      - DD_PROFILING_ENABLED=true
+      # Use these to choose what is run
+      - DD_DEMO_ENV_PROCESS=rspec
+      - DD_DEMO_ENV_FEATURES=tracing
+      # Use this for a local version of ddtrace
+      - DD_DEMO_ENV_GEM_LOCAL_DDTRACE=/vendor/dd-trace-rb
+      # Use these for a specific revision of ddtrace
+      # - DD_DEMO_ENV_GEM_GIT_DDTRACE=https://github.com/DataDog/dd-trace-rb.git
+      # - DD_DEMO_ENV_GEM_REF_DDTRACE=f233336994315bfa04dac581387a8152bab8b85a
+    stdin_open: true
+    tty: true
+    volumes:
+      - .:/app
+      - /app/.git
+      - ./data/app:/data/app
+      - bundle:/usr/local/bundle
+      - ../../images/include:/vendor/dd-demo
+      - ../../..:/vendor/dd-trace-rb
+  ddagent:
+    image: datadog/dd-apm-demo:agent
+    environment:
+      - DD_APM_ENABLED=true
+      - DD_PROCESS_AGENT_ENABLED=false
+      - DD_BIND_HOST=0.0.0.0
+      - DD_API_KEY
+      - LOG_LEVEL=DEBUG
+      - DD_LOGS_STDOUT=yes
+      - DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true
+    expose:
+      - "8125/udp"
+      - "8126"
+    volumes:
+      - ../../images/agent/agent.yaml:/etc/datadog-agent/datadog.yaml
+      # For monitoring performance of containers (e.g. CPU, Memory, etc...)
+      # - type: bind
+      #   source: ../../images/agent/agent.yaml
+      #   target: /etc/datadog-agent/datadog.yaml
+      # - type: bind
+      #   source: /var/run/docker.sock
+      #   target: /var/run/docker.sock:ro
+      # - type: bind
+      #   source: /proc/
+      #   target: /host/proc/:ro
+      # - type: bind
+      #   source: /sys/fs/cgroup/
+      #   target: /host/sys/fs/cgroup:ro
+volumes:
+  bundle:

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

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+APP_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+APP_DIR=${APP_SCRIPT_DIR%/script}
+cd $APP_DIR
+
+while getopts ":v:" opt; do
+  case $opt in
+    v)
+      APP_RUBY_VERSION=$OPTARG
+      ;;
+    \?)
+      echo "Invalid option: -$OPTARG" >&2
+      exit 1
+      ;;
+    :)
+      echo "Option -$OPTARG requires an argument." >&2
+      exit 1
+      ;;
+  esac
+done
+
+echo "== Building Ruby app images... =="
+if [ -v APP_RUBY_VERSION ]; then
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-$APP_RUBY_VERSION -t datadog/dd-apm-demo:rb-$APP_RUBY_VERSION-rspec .
+else
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.1 -t datadog/dd-apm-demo:rb-2.1-rspec .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.2 -t datadog/dd-apm-demo:rb-2.2-rspec .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.3 -t datadog/dd-apm-demo:rb-2.3-rspec .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.4 -t datadog/dd-apm-demo:rb-2.4-rspec .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.5 -t datadog/dd-apm-demo:rb-2.5-rspec .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.6 -t datadog/dd-apm-demo:rb-2.6-rspec .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.7 -t datadog/dd-apm-demo:rb-2.7-rspec .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-3.0 -t datadog/dd-apm-demo:rb-3.0-rspec .
+fi
+echo "== Done building Ruby app images. =="

data/integration/apps/rspec/script/ci

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+APP_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+APP_DIR=${APP_SCRIPT_DIR%/script}
+cd $APP_DIR
+
+# Parse options
+while getopts "v:" opt; do
+  case $opt in
+    v)
+      APP_RUBY_VERSION=$OPTARG
+      ;;
+    \?)
+      echo "Invalid option: -$OPTARG" >&2
+      exit 1
+      ;;
+    :)
+      echo "Option -$OPTARG requires an argument." >&2
+      exit 1
+      ;;
+  esac
+done
+
+# Validate options
+if [ -z ${APP_RUBY_VERSION+x} ]; then
+  echo "You must specify a Ruby version with -v. (e.g. 2.7)" >&2
+  exit 1
+fi
+
+# Set configuration
+APP_BASE_IMAGE=${APP_BASE_IMAGE:-datadog/dd-apm-demo:rb-$APP_RUBY_VERSION}
+APP_IMAGE=${APP_IMAGE:-$APP_BASE_IMAGE-rspec}
+APP_COMPOSE_FILES="-f docker-compose.ci.yml"
+
+echo "== Running integration tests... =="
+echo " - App: rspec"
+echo " - Ruby version: $APP_RUBY_VERSION"
+echo " - Base image: $APP_BASE_IMAGE"
+echo " - App image: $APP_IMAGE"
+echo ""
+
+# Pull/build any missing images
+APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES build
+
+# Run the test suite
+# NOTE: Normally we run "integration-tester" but in this case, the app is the test suite.
+#       Just run the app instead.
+#       It's expected to produce test failures and raise an exit code. Ignore this.
+APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES run app || true
+
+# Cleanup
+APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES down -t 0 --remove-orphans

data/integration/apps/rspec/spec/fibonacci_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../app/fibonacci'
+
+# Test some library functions
+RSpec.describe '#fib' do
+  subject(:call_fib) { fib(n) }
+  let(:n) { rand(25..35) }
+
+  it { is_expected.to be_a_kind_of(Integer) }
+
+  context 'given a smaller and larger number' do
+    let(:smaller_fib) { fib(n) }
+    let(:larger_fib) { fib(n+1) }
+
+    it { expect(larger_fib).to be > smaller_fib }
+  end
+end

data/integration/apps/rspec/spec/rspec_spec.rb

@@ -0,0 +1,58 @@
+# Test some RSpec behavior
+# NOTE: This file is expected to always produce some test errors!
+#       So that we can 
+RSpec.describe 'RSpec behavior' do
+  shared_examples_for 'correct behavior' do
+    it 'passes' do
+      expect(1).to be < 2
+    end
+  end
+  
+  shared_examples_for 'incorrect behavior' do
+    it 'fails' do
+      expect(2).to be < 1
+    end
+  end
+
+  it 'passes correct assertions' do
+    expect(1).to be < 2
+  end
+
+  it 'fails incorrect assertions' do
+    expect(2).to be < 1
+  end
+
+  it_behaves_like 'correct behavior'
+  it_behaves_like 'incorrect behavior'
+
+  context 'context' do
+    it_behaves_like 'correct behavior'
+    it_behaves_like 'incorrect behavior'
+  end
+
+  context 'in a' do
+    context 'deeply' do
+      context 'nested' do
+        context 'context' do
+          it 'passes correct assertions' do
+            expect(1).to be < 2
+          end
+
+          it 'fails incorrect assertions' do
+            expect(2).to be < 1
+          end
+        end
+      end
+    end
+  end
+
+  context 'when calling traced code' do
+    it 'wraps the RSpec instrumentation around the traced code' do
+      Datadog.tracer.trace('code_under_test') do |span|
+        time_to_run = rand
+        sleep(rand)
+        span.set_tag('run_time', time_to_run)
+      end
+    end
+  end
+end

data/integration/apps/rspec/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'datadog/ci'
+
+# Enable CI tracing
+Datadog.configure do |c|
+  c.ci_mode.enabled = true
+  c.use :rspec
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

data/integration/apps/ruby/README.md

@@ -43,7 +43,7 @@ Within the container, run `bin/run <process>` where `<process>` is one of the fo
 
 ##### Features
 
-Set `DD_DEMO_ENV_PROCESS` to a comma-delimited list of any of the following values to activate the feature:
+Set `DD_DEMO_ENV_FEATURES` to a comma-delimited list of any of the following values to activate the feature:
 
  - `tracing`: Tracing instrumentation
  - `profiling`: Profiling (NOTE: Must also set `DD_PROFILING_ENABLED` to match.)
@@ -52,7 +52,7 @@ Set `DD_DEMO_ENV_PROCESS` to a comma-delimited list of any of the following valu
  - `runtime_metrics`: Enable runtime metrics
  - `pprof_to_file`: Dump profiling pprof to file instead of agent.
 
-e.g. `DD_DEMO_ENV_PROCESS=tracing,profiling`
+e.g. `DD_DEMO_ENV_FEATURES=tracing,profiling`
 
 ### Running integration tests
 

data/integration/apps/ruby/script/ci

@@ -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