ddtrace 0.45.0 → 0.46.0

data/integration/apps/ruby/agent.yaml

@@ -0,0 +1,3 @@
+use_dogstatsd: true
+dogstatsd_port: 8125
+dogstatsd_non_local_traffic: true

data/integration/apps/ruby/app/datadog.rb

@@ -0,0 +1,13 @@
+require 'datadog/demo_env'
+require 'ddtrace'
+
+Datadog.configure do |c|
+  c.diagnostics.debug = true if Datadog::DemoEnv.feature?('debug')
+  c.analytics_enabled = true if Datadog::DemoEnv.feature?('analytics')
+  c.runtime_metrics.enabled = true if Datadog::DemoEnv.feature?('runtime_metrics')
+
+  if Datadog::DemoEnv.feature?('pprof_to_file')
+    # Reconfigure transport to write pprof to file
+    c.profiling.exporter.transport = Datadog::DemoEnv.profiler_file_transport
+  end
+end

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

@@ -0,0 +1,58 @@
+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
+
+if defined?(Ractor)
+  # Ractor version
+  # DEV: Disabled for now because Ractors cannot access ENV.
+  #      This results in a shareable-object violation.
+  #      Enable when we figure out how to make DemoEnv ractor-safe.
+
+  # require 'securerandom'
+  # ractors = []
+
+  # 3.times do |i|
+  #   ractors << Ractor.new do
+  #     ractor_id = SecureRandom.uuid
+  #     generate_fib { |span| span.set_tag('ractor.id', ractor_id) }
+  #   end
+  # end
+
+  # # Wait indefinitely for ractors
+  # loop do
+  #   ractors.collect(&:take)
+  # end
+  
+  # DEV: Use single-threaded version instead for now...
+  generate_fib
+else
+  # Single-threaded version
+  generate_fib
+end

data/integration/apps/ruby/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 'fibonacci'
+            'bundle exec ruby app/fibonacci.rb'
+          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/ruby/bin/setup

@@ -0,0 +1,17 @@
+#!/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')
+end

data/integration/apps/ruby/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/ruby/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/ruby/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-ruby
+      - DD_PROFILING_ENABLED=true
+      # Use these to choose what is run
+      - DD_DEMO_ENV_PROCESS=fibonacci
+      - 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/ruby/Dockerfile-ci
+      args:
+        BASE_IMAGE: ${APP_IMAGE}
+    command: bin/test
+    # volumes:
+    #   - .:/app
+    #   - ../../images/include:/vendor/dd-demo
+    #   - ../../..:/vendor/dd-trace-rb

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

@@ -0,0 +1,63 @@
+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-ruby
+      - DD_PROFILING_ENABLED=true
+      # Use these to choose what is run
+      - DD_DEMO_ENV_PROCESS=fibonacci
+      - 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
+      - ./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/ruby/script/build-images

@@ -0,0 +1,38 @@
+#!/bin/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-ruby .
+else
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.0 -t datadog/dd-apm-demo:rb-2.0-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.1 -t datadog/dd-apm-demo:rb-2.1-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.2 -t datadog/dd-apm-demo:rb-2.2-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.3 -t datadog/dd-apm-demo:rb-2.3-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.4 -t datadog/dd-apm-demo:rb-2.4-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.5 -t datadog/dd-apm-demo:rb-2.5-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.6 -t datadog/dd-apm-demo:rb-2.6-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.7 -t datadog/dd-apm-demo:rb-2.7-ruby .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-3.0 -t datadog/dd-apm-demo:rb-3.0-ruby .
+fi
+echo "== Done building Ruby app images. =="

data/integration/apps/ruby/script/ci

@@ -0,0 +1,50 @@
+#!/bin/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-ruby}
+APP_COMPOSE_FILES="-f docker-compose.ci.yml"
+
+echo "== Running integration tests... =="
+echo " - App: ruby"
+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
+APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES run integration-tester
+
+# Cleanup
+APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES down -t 0 --remove-orphans

data/integration/images/agent/Dockerfile

@@ -0,0 +1,2 @@
+FROM datadog/agent
+COPY agent.yaml /etc/datadog-agent/datadog.yaml

data/integration/images/agent/agent.yaml

@@ -0,0 +1,3 @@
+use_dogstatsd: true
+dogstatsd_port: 8125
+dogstatsd_non_local_traffic: true

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

@@ -0,0 +1,71 @@
+require 'json'
+
+class Analyzer
+  def initialize(filename)
+    @filename = filename
+  end
+
+  def analyze
+    data = []
+    File.open(@filename) do |f|
+        f.each_line do |line|
+          data << (parsed=JSON.parse(line))
+        end
+    end
+
+    data.group_by{ |row| row['generation'] }
+        .sort{|a,b| a[0].to_i <=> b[0].to_i }
+        .each do |k,v|
+          puts "location #{k} objects #{v.count}"
+        end
+  end
+
+  def analyze_objects(gen_range = nil)
+    data = []
+    File.open(@filename) do |f|
+        f.each_line do |line|
+          parsed = JSON.parse(line)
+          if gen_range && gen_range.include?(parsed['generation'].to_i)
+            data << parsed
+          end
+        end
+    end
+
+    data.group_by{ |row| "#{row['file']}:#{row['line']}" }
+        .sort{|a,b| b[1].length <=> a[1].length }
+        .each do |k,v|
+          puts "line #{k} objects #{v.count}"
+        end
+  end
+
+  def analyze_generation(gen)
+    data = []
+    File.open(@filename) do |f|
+        f.each_line do |line|
+          parsed=JSON.parse(line)
+          data << parsed if parsed["generation"] == gen
+        end
+    end
+    data.group_by{|row| "#{row["file"]}:#{row["line"]}"}
+        .sort{|a,b| b[1].count <=> a[1].count}
+        .each do |k,v|
+          puts "#{k} * #{v.count}"
+        end
+  end
+end
+
+if ARGV[1]
+  if ARGV[1] == 'objects'
+    range = nil
+    if ARGV[2]
+      range_end = ARGV[2].to_i
+      range_start = ARGV[3].to_i
+      range = Range.new(range_start, range_end)
+    end
+    Analyzer.new(ARGV[0]).analyze_objects(range)
+  else
+    Analyzer.new(ARGV[0]).analyze_generation(ARGV[1].to_i)
+  end
+else
+  Analyzer.new(ARGV[0]).analyze
+end

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

@@ -0,0 +1,101 @@
+module Datadog
+  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
+
+      yield(args) if block_given?
+
+      args
+    end
+
+    def gem_env_name(gem_name)
+      gem_name.upcase.gsub('-', '_')
+    end
+
+    def local_gem(gem_name)
+      local_env_name = "DD_DEMO_ENV_GEM_LOCAL_#{gem_env_name(gem_name)}"
+
+      return unless ENV.key?(local_env_name)
+
+      { path: ENV[local_env_name] }
+    end
+
+    def git_gem(gem_name)
+      git_env_name = "DD_DEMO_ENV_GEM_GIT_#{gem_env_name(gem_name)}"
+      ref_env_name = "DD_DEMO_ENV_GEM_REF_#{gem_env_name(gem_name)}"
+
+      return unless [git_env_name, ref_env_name].all? { |var| ENV.key?(var) && !ENV[var].empty? }
+
+      { git: ENV[git_env_name], ref: ENV[ref_env_name] }
+    end
+
+    def process
+      ENV['DD_DEMO_ENV_PROCESS']
+    end
+
+    def features
+      (ENV['DD_DEMO_ENV_FEATURES'] || '').split(',')
+    end
+
+    def feature?(feature)
+      features.include?(feature)
+    end
+
+    def print_env(header = 'Datadog test environment')
+      puts "\n==== #{header} ===="
+      puts "Process: #{process}"
+      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)
+        puts "ddtrace version: #{ddtrace.version}"
+        puts "ddtrace path: #{ddtrace.full_gem_path}"
+        if git_spec = git_gem('ddtrace')
+          puts "ddtrace git: #{git_spec[:git]}"
+          puts "ddtrace ref: #{git_spec[:ref]}"
+        end
+      end
+      puts "\n"
+    end
+
+    def profiler_file_transport(dump_path = "/data/profile-pid-#{Process.pid}.pprof")
+      Datadog::Profiling::Transport::IO.default(
+        write: ->(out, data) do
+          result = nil
+          puts "Writing pprof #{dump_path}..."
+          File.open(dump_path, "w") { |f| result = f.write(data) }
+          puts "Pprof #{dump_path} written!"
+          result
+        end
+      )
+    end
+
+    def start_mem_dump!
+      require 'objspace'
+      ObjectSpace.trace_object_allocations_start
+    end
+
+    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|
+        ObjectSpace.dump_all(output: io)
+      end
+    end
+
+    def mem_dump!(dump_path = "/data/mem-pid-#{Process.pid}.dump")
+      start_mem_dump!
+      result = yield
+      finish_mem_dump!
+      result
+    end
+  end
+end