ddtrace 0.45.0 → 0.47.0

data/integration/apps/rails-five/public/robots.txt

@@ -0,0 +1 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/integration/apps/rails-five/script/build-images

@@ -0,0 +1,35 @@
+#!/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 Rails 5 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-rails-five .
+else
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.3 -t datadog/dd-apm-demo:rb-2.3-rails-five .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.4 -t datadog/dd-apm-demo:rb-2.4-rails-five .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.5 -t datadog/dd-apm-demo:rb-2.5-rails-five .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.6 -t datadog/dd-apm-demo:rb-2.6-rails-five .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-2.7 -t datadog/dd-apm-demo:rb-2.7-rails-five .
+  docker build --build-arg BASE_IMAGE=datadog/dd-apm-demo:rb-3.0 -t datadog/dd-apm-demo:rb-3.0-rails-five .
+fi
+echo "== Done building Rails 5 images. =="

data/integration/apps/rails-five/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-rails-five}
+APP_COMPOSE_FILES="-f docker-compose.ci.yml"
+
+echo "== Running integration tests... =="
+echo " - App: rails-five"
+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/apps/rails-five/spec/integration/basic_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+RSpec.describe 'Basic scenarios' do
+  include_context 'integration test'
+
+  context 'default' do
+    subject { get('basic/default') }
+    it { is_expected.to be_a_kind_of(Net::HTTPOK) }
+  end
+end

data/integration/apps/rails-five/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'byebug'
+require 'support/integration_helper'
+
+RSpec.configure do |config|
+  config.include IntegrationHelper
+
+  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
+end

data/integration/apps/rails-five/spec/support/integration_helper.rb

@@ -0,0 +1,22 @@
+require 'net/http'
+
+module IntegrationHelper
+  shared_context 'integration test' do
+    before do
+      skip 'Integration tests not enabled.' unless ENV['TEST_INTEGRATION']
+    end
+
+    def hostname
+      ENV['TEST_HOSTNAME']
+    end
+
+    def port
+      ENV['TEST_PORT']
+    end
+
+    def get(path)
+      uri = URI("http://#{hostname}:#{port}/#{path}")
+      Net::HTTP.get_response(uri)
+    end
+  end
+end

data/integration/apps/ruby/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

data/integration/apps/ruby/.envrc.sample

@@ -0,0 +1 @@
+export DD_API_KEY=<Your Datadog API key here>

data/integration/apps/ruby/.gitignore

@@ -0,0 +1,2 @@
+.envrc
+.byebug_history

data/integration/apps/ruby/Dockerfile

@@ -0,0 +1,25 @@
+# Select base image
+ARG BASE_IMAGE
+FROM ${BASE_IMAGE}
+
+# Setup directory
+RUN mkdir /app
+WORKDIR /app
+
+# Setup specific version of ddtrace, if specified.
+ARG ddtrace_git
+ENV DD_DEMO_ENV_GEM_GIT_DDTRACE ${ddtrace_git}
+
+ARG ddtrace_ref
+ENV DD_DEMO_ENV_GEM_REF_DDTRACE ${ddtrace_ref}
+
+# Install dependencies
+COPY Gemfile /app/Gemfile
+RUN bundle install
+
+# Add files
+COPY . /app
+
+# Set entrypoint
+ENTRYPOINT ["/bin/bash", "-c"]
+CMD ["bin/setup && bin/run"]

data/integration/apps/ruby/Dockerfile-ci

@@ -0,0 +1,11 @@
+# Select base image
+ARG BASE_IMAGE
+FROM ${BASE_IMAGE}
+
+# Add gem
+COPY . /vendor/dd-trace-rb
+
+# Install dependencies
+# Setup specific version of ddtrace, if specified.
+ENV DD_DEMO_ENV_GEM_LOCAL_DDTRACE /vendor/dd-trace-rb
+RUN bundle install

data/integration/apps/ruby/Gemfile

@@ -0,0 +1,11 @@
+require 'datadog/demo_env'
+
+source 'https://rubygems.org' do
+  gem 'ffi'
+  gem 'google-protobuf'
+
+  # Choose correct specs for 'ddtrace' demo environment
+  gem 'ddtrace', *Datadog::DemoEnv.gem_spec('ddtrace')
+
+  gem 'byebug'
+end

data/integration/apps/ruby/README.md

@@ -0,0 +1,70 @@
+# Ruby: Demo application for Datadog APM
+
+A generic Ruby application with some common use scenarios.
+
+For generating Datadog APM traces and profiles.
+
+## Installation
+
+Install [direnv](https://github.com/direnv/direnv) for applying local settings.
+
+1. `cp .envrc.sample .envrc` and add your Datadog API key.
+2. `direnv allow` to load the env var.
+4. `docker-compose run --rm app bin/setup`
+
+## Running the application
+
+### To monitor performance of Docker containers with Datadog
+
+```sh
+docker run --rm --name dd-agent  -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e API_KEY=$DD_API_KEY datadog/docker-dd-agent:latest
+```
+
+### Starting the application
+
+Run `docker-compose up` to auto-start the application.
+
+Alternatively, you can run it manually with:
+
+```sh
+docker-compose run --rm app bin/run <process>
+```
+
+The `<process>` argument is optional, and will default to `DD_DEMO_ENV_PROCESS` if not provided. See [Processes](#processes) for more details.
+
+##### Processes
+
+Within the container, run `bin/run <process>` where `<process>` is one of the following values:
+
+ - `fibonacci`: Fibonacci number generator
+ - `irb`: IRB session
+
+ Alternatively, set `DD_DEMO_ENV_PROCESS` to run a particular process by default when `bin/run` is run.
+
+##### Features
+
+Set `DD_DEMO_ENV_PROCESS` 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.)
+ - `debug`: Enable diagnostic debug mode
+ - `analytics`: Enable trace analytics
+ - `runtime_metrics`: Enable runtime metrics
+ - `pprof_to_file`: Dump profiling pprof to file instead of agent.
+
+e.g. `DD_DEMO_ENV_PROCESS=tracing,profiling`
+
+### Running integration tests
+
+You can run integration tests using the following and substituting for the Ruby major and minor version (e.g. `2.7`)
+
+```sh
+./script/build-images -v <RUBY_VERSION>
+./script/ci -v <RUBY_VERSION>
+```
+
+Or inside a running container:
+
+```sh
+./bin/test
+```

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