ddtrace 0.45.0 → 0.47.0

data/integration/apps/rack/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/rack/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/rack/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/rails-five/.dockerignore

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

data/integration/apps/rails-five/.env

@@ -0,0 +1,3 @@
+DD_AGENT_HOST=localhost
+DD_METRIC_AGENT_PORT=8125
+DD_TRACE_AGENT_PORT=8126

data/integration/apps/rails-five/.envrc.sample

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

data/integration/apps/rails-five/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+# Ignore local data
+/data
+*.pprof
+
+# Ignore local variables
+.envrc

data/integration/apps/rails-five/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/rails-five/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/rails-five/Gemfile

@@ -0,0 +1,104 @@
+require 'datadog/demo_env'
+
+source 'https://rubygems.org' do
+  # Framework dependent gems
+  # gem 'rails', '5.2.2'
+
+  google_protobuf_versions = [
+    '~> 3.0',
+    '!= 3.7.0.rc.2',
+    '!= 3.7.0.rc.3',
+    '!= 3.7.0',
+    '!= 3.7.1',
+    '!= 3.8.0.rc.1'
+  ]
+
+  # gem 'rack', '2.1.4' # Ruby 2.2 compatibility
+  gem 'actioncable', '5.2.2'
+  gem 'actionmailer', '5.2.2'
+  gem 'actionpack', '5.2.2'
+  gem 'actionview', '5.2.2'
+  gem 'activejob', '5.2.2'
+  gem 'activemodel', '5.2.2'
+  gem 'activerecord', '5.2.2'
+  gem 'railties', '5.2.2'
+
+  gem 'mysql2'
+  gem 'puma'
+  gem 'unicorn'
+
+  # Choose correct specs for 'ddtrace' demo environment
+  gem 'ddtrace', *Datadog::DemoEnv.gem_spec('ddtrace')
+
+  gem 'dogstatsd-ruby'
+  gem 'ffi'
+  gem 'google-protobuf', *google_protobuf_versions # Ruby 2.2 compatibility
+  # gem 'rbtrace'
+  # gem 'ruby-prof'
+
+  # Fixes conflict with profiling (patch overwrite in Thread)
+  # Upgrade this to latest when this patch is merged & released.
+  # https://github.com/rollbar/rollbar-gem/pull/1018
+  gem 'rollbar', git: 'https://github.com/rollbar/rollbar-gem.git', ref: '310a9d1743bb44031480b49e8e0cef79ddc870c3'
+
+  # Gems which give aide to higher performance
+  gem 'hiredis', '~> 0.6', platform: :ruby
+  gem 'multi_json'
+  gem 'oj', '3.3', platform: :ruby
+
+  gem 'active_model_serializers', '0.9.3'
+  gem 'activerecord-import' # Speeds up mass imports
+  gem 'aws-sdk', '< 2.0'
+  gem 'bcrypt-ruby', platform: :ruby
+  gem 'connection_pool'
+  gem 'devise'
+  gem 'faker', require: false # Make up fake data to put in models for load testing
+  gem 'geoip'
+  gem 'hawk-auth'
+  gem 'httparty'
+  gem 'ipaddress'
+  # gem 'i18n', '1.5.1' # Ruby 2.2 compatibility
+  # gem 'newrelic_rpm', platform: :ruby
+  gem 'rabl', platform: :ruby
+  gem 'rack-cors'
+  gem 'rake'
+  gem 'redis'
+  gem 'resque'
+  # gem 'resque-pool' # Incompatible with Redis 4.0+
+  gem 'resque-scheduler'
+  gem 'tzinfo-data', platforms: [:mingw, :mswin, :jruby]
+  gem 'validates_timeliness', '~> 3.0.8' # Date comparisons
+  gem 'versionist'
+  gem 'warden'
+
+  group :development do
+    gem 'annotate'
+    gem 'awesome_print'
+    gem 'bullet'
+  end
+
+  group :test do
+    gem 'ci_reporter_rspec'
+    gem 'database_cleaner'
+    gem 'factory_girl_rails', '4.5.0'
+    gem 'rspec'
+    gem 'rspec-collection_matchers'
+    gem 'rspec-rails'
+    gem 'shoulda-matchers', '4.0.1'
+    gem 'simplecov', require: false # Will install simplecov-html as a dependency
+    gem 'timecop'
+    gem 'webmock'
+  end
+
+  group :test, :development do
+    # gem 'pry-rails', platform: :ruby
+    # gem 'pry-rescue', platform: :ruby
+    # gem 'pry-stack_explorer', platform: :ruby
+    # gem 'pry-byebug', platform: :ruby
+    gem 'byebug', platform: :ruby
+    gem 'mock_redis', '0.19.0'
+    gem 'parallel_tests'
+
+    gem 'listen'
+  end
+end

data/integration/apps/rails-five/README.md

@@ -0,0 +1,94 @@
+# Rails 5: Demo application for Datadog APM
+
+A generic Rails 5 web 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.
+3. `cp docker-compose.yml.sample docker-compose.yml` and configure if necessary.
+4. `docker-compose run --rm api 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 web server
+
+Run `docker-compose up` to auto-start the webserver. It should bind to `localhost:80`.
+
+Alternatively, you can run it manually with:
+
+```sh
+docker-compose run --rm -p 80:80 api bin/dd-demo <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/dd-demo <process>` where `<process>` is one of the following values:
+
+ - `webrick`: WEBrick web server
+ - `console`: Rails console
+ - `irb`: IRB session
+
+ Alternatively, set `DD_DEMO_ENV_PROCESS` to run a particular process by default when `bin/dd-demo` 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`
+
+##### Routes
+
+```sh
+# Health check
+curl -v localhost/health
+
+# Basic test scenarios
+curl -v localhost/basic/fibonacci
+curl -v -XPOST localhost/basic/everything
+
+# Job test scenarios
+curl -v -XPOST localhost/jobs
+```
+
+### Load tester
+
+Docker configuration automatically creates and runs [Wrk](https://github.com/wg/wrk) load testing containers. By default it runs the `basic/everything` scenario described in the `wrk` image to give a baseload.
+
+You can modify the `loadtester_a` container in `docker-compose.yml` to change the load type or scenario run. Set the container's `command` to any set of arguments `wrk` accepts.
+
+You can also define your own custom scenario by creating a LUA file, mounting it into the container, and passing it as an argument via `command`.
+
+### 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
+./bin/build-images -v <RUBY_VERSION>
+./bin/ci -v <RUBY_VERSION>
+```
+
+Or inside a running container:
+
+```sh
+./bin/rspec
+```

data/integration/apps/rails-five/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/integration/apps/rails-five/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/integration/apps/rails-five/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/integration/apps/rails-five/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/integration/apps/rails-five/app/controllers/basic_controller.rb

@@ -0,0 +1,36 @@
+require "#{Rails.root}/app/jobs/test_job"
+
+class BasicController < ApplicationController
+  # Reads & writes from cache, reads from DB, and queues a Resque job.
+  #
+  # Example trace:
+  #
+  # ----------------------- Rack -----------------------------
+  #    -------------- ActionController --------------------
+  #      --- ActiveSupport -- ActiveRecord -- Resque ---
+  #        ----- Redis ----                 -- Redis --
+  #
+  def default
+    # Read from the database
+    records = Test.where(version: 0)
+
+    # Queue job
+    Resque.enqueue(Jobs::Test, job_id: request.request_id, records: records.map(&:to_json))
+
+    # Return response
+    render json: { job_id: request.request_id }
+  end
+
+  # Runs a recursive implementation of fibonacci.
+  # Provides a basic load on CPU, stack frames, response time.
+  def fibonacci
+    fib(rand(25..35))
+    head :ok
+  end
+
+  private
+
+  def fib(n)
+    n <= 1 ? n : fib(n-1) + fib(n-2)
+  end
+end

data/integration/apps/rails-five/app/controllers/health_controller.rb

@@ -0,0 +1,9 @@
+class HealthController < ApplicationController
+  #
+  # Check if web application is responsive
+  # Return 204 No Content to signal healthy state.
+  #
+  def check
+    head :no_content
+  end
+end

data/integration/apps/rails-five/app/controllers/jobs_controller.rb

@@ -0,0 +1,12 @@
+require "#{Rails.root}/app/jobs/test_job"
+
+class JobsController < ApplicationController
+  def create
+    # Queue job
+    job_id = SecureRandom.uuid
+    Resque.enqueue(Jobs::Test, job_id: job_id)
+
+    # Return response
+    render json: { job_id: job_id }
+  end
+end

data/integration/apps/rails-five/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/integration/apps/rails-five/app/jobs/test_job.rb

@@ -0,0 +1,12 @@
+require 'ddtrace/contrib/resque/resque_job'
+
+module Jobs
+  class Test
+    extend Datadog::Contrib::Resque::ResqueJob
+    @queue = :default
+
+    def self.perform(params)
+      Logger.new(STDOUT).debug("Working: #{params[:job_id]}")
+    end
+  end
+end