ddtrace 0.45.0 → 0.46.0

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

data/integration/apps/rails-five/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/integration/apps/rails-five/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/integration/apps/rails-five/app/models/test.rb

@@ -0,0 +1,2 @@
+class Test < ApplicationRecord
+end

data/integration/apps/rails-five/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/integration/apps/rails-five/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/integration/apps/rails-five/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/integration/apps/rails-five/bin/rails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('spring', __dir__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/integration/apps/rails-five/bin/rake

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('spring', __dir__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/integration/apps/rails-five/bin/run

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

data/integration/apps/rails-five/bin/setup

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'uri'
+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')
+
+  puts "\n== Preparing database =="
+  database_uri = URI(ENV['DATABASE_URL'])
+  system! 'until wget mysql:3306 > /dev/null 2>&1; do : sleep 1; done'
+  system! 'bin/rails db:create'
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+end

data/integration/apps/rails-five/bin/spring

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# This file loads Spring without using Bundler, in order to be fast.
+# It gets overwritten when you run the `spring binstub` command.
+
+unless defined?(Spring)
+  require 'rubygems'
+  require 'bundler'
+
+  lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read)
+  spring = lockfile.specs.detect { |spec| spec.name == 'spring' }
+  if spring
+    Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
+    gem 'spring', spring.version
+    require 'spring/binstub'
+  end
+end

data/integration/apps/rails-five/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
+  if ENV['TEST_INTEGRATION']
+    puts "\n== Wait for healthy HTTP server... =="
+    system!('bash /vendor/dd-demo/http-health-check')
+  end
+
+  puts "\n== Run test suite =="
+  system!('rspec')
+end

data/integration/apps/rails-five/bin/update

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/integration/apps/rails-five/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/integration/apps/rails-five/config/application.rb

@@ -0,0 +1,97 @@
+require_relative 'boot'
+
+# require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+class TraceMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    Datadog.tracer.trace('web.request', service: 'acme', resource: env['REQUEST_PATH']) do |span|
+      Datadog.runtime_metrics.associate_with_span(span)
+      @app.call(env)
+    end
+  end
+end
+
+class ShortCircuitMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    return [200, {}, []]
+  end
+end
+
+class ErrorMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    @app.call(env)
+    raise
+  end
+end
+
+class CustomError < StandardError
+  def message
+    'Custom error message!'
+  end
+end
+
+class CacheMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    request_id = env['action_dispatch.request_id']
+
+    # NOTE: Disabled for now, suspected to cause memory growth.
+    # Fetch from cache
+    # Rails.cache.fetch(request_id) { request_id }
+
+    @app.call(env)
+  end
+end
+
+module Acme
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+    # config.middleware.use TraceMiddleware
+    # config.middleware.use ShortCircuitMiddleware
+    # config.middleware.use ErrorMiddleware
+    config.middleware.use CacheMiddleware
+
+    # Only loads a smaller set of middleware suitable for API only apps.
+    # Middleware like session, flash, cookies can be added back manually.
+    # Skip views, helpers and assets when generating a new resource.
+    config.api_only = true
+
+    config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'] }
+    config.action_controller.perform_caching = true
+  end
+end