ddtrace 0.17.3 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da8890d2a4acda28dea666623f0b497fceedea7c
-  data.tar.gz: 4bda7e12410130c575411289d8400ad281099b5d
+  metadata.gz: 6c4e552c5952c4dfa4cd7889db389bf87c06e400
+  data.tar.gz: 635dc26f996a8cf9c424dacf85a3e48ae6ca7517
 SHA512:
-  metadata.gz: f6ef938aedbe689cded02861e70a5a791ddff979c6ae78bc1bfbfb74d095592f17f0125ede4a06f76a2549d18afc9ab43d6fcf9a2ee6da24d4de0b9acdb6e97f
-  data.tar.gz: b41dcf5846930f2edbfd0fd8a5accf52c5d282569a4bc083924d56336d598c246fad8d5d12223ff8417ccec7dfbecaf8bd50dec53f1d4bc4caed9df8a26f7055
+  metadata.gz: 16d01f87e058e4d0d77936c39d9115075dfdcff3cfdc1a2ba74c668c5b27e6d8376d2b5327b18ae0f2d2fe6587254d5328d409b8e7ea0b82430b63d3e7a36cb7
+  data.tar.gz: e5897d2d6756d99465d8bcbbd2169997d6e5f30f791eece446c8b56c112f3f22ef3c5f5d7b38621fde1bd1cdc2d65c3746f147dfba78f8497cdaf803423e616f

data/.env

@@ -1,6 +1,6 @@
+DD_AGENT_HOST=localhost
+DD_TRACE_AGENT_PORT=8126
 TEST_DDAGENT_API_KEY=invalid_key_but_this_is_fine
-TEST_DDAGENT_HOST=localhost
-TEST_DDAGENT_PORT=8126
 TEST_ELASTICSEARCH_HOST=127.0.0.1
 TEST_ELASTICSEARCH_NATIVE_PORT=9300
 TEST_ELASTICSEARCH_REST_PORT=9200

data/Appraisals

@@ -274,6 +274,7 @@ elsif Gem::Version.new('2.1.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel', '~> 4.0', '< 4.37'
+      gem 'shoryuken'
       gem 'sidekiq', '~> 3.5.4'
       gem 'sinatra', '1.4.5'
       gem 'sqlite3'
@@ -413,6 +414,7 @@ elsif Gem::Version.new('2.2.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel'
+      gem 'shoryuken'
       gem 'sidekiq'
       gem 'sinatra'
       gem 'sqlite3'
@@ -551,6 +553,7 @@ elsif Gem::Version.new('2.3.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel'
+      gem 'shoryuken'
       gem 'sidekiq'
       gem 'sinatra'
       gem 'sqlite3'
@@ -583,6 +586,7 @@ elsif Gem::Version.new('2.4.0') <= Gem::Version.new(RUBY_VERSION)
       gem 'rest-client'
       gem 'resque', '< 2.0'
       gem 'sequel'
+      gem 'shoryuken'
       gem 'sidekiq'
       gem 'sinatra'
       gem 'sqlite3'

data/CHANGELOG.md

@@ -4,6 +4,24 @@
 
 ## [Unreleased (beta)]
 
+## [0.18.0] - 2018-12-18
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.18.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.17.3...v0.18.0
+
+### Added
+
+ - Shoryuken integration (#538, #626, #655) (@steveh, @JustSnow)
+ - Sidekiq client integration (#602, #650) (@dirk)
+ - Datadog::Shim for adding instrumentation (#648)
+
+### Changed
+
+ - Use `DD_AGENT_HOST` and `DD_TRACE_AGENT_PORT` env vars if available (#631)
+ - Inject `:connection` into `sql.active_record` event (#640, #649, #656) (@guizmaii)
+ - Return default configuration instead of `nil` on miss (#651)
+
 ## [0.17.3] - 2018-11-29
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.17.3
@@ -576,8 +594,9 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.3.1
 
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 
-[Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.17.3...master
-[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.17.3...0.18-dev
+[Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.18.0...master
+[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.18.0...0.19-dev
+[0.18.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.17.3...v0.18.0
 [0.17.3]: https://github.com/DataDog/dd-trace-rb/compare/v0.17.2...v0.17.3
 [0.17.2]: https://github.com/DataDog/dd-trace-rb/compare/v0.17.1...v0.17.2
 [0.17.1]: https://github.com/DataDog/dd-trace-rb/compare/v0.17.0...v0.17.1

data/Rakefile

@@ -52,11 +52,11 @@ namespace :spec do
   [
     :active_model_serializers,
     :active_record,
-    :delayed_job,
     :active_support,
     :aws,
     :concurrent_ruby,
     :dalli,
+    :delayed_job,
     :elasticsearch,
     :excon,
     :faraday,
@@ -71,11 +71,13 @@ namespace :spec do
     :rake,
     :redis,
     :resque,
+    :rest_client,
     :sequel,
     :sidekiq,
     :sinatra,
     :sucker_punch,
-    :rest_client
+    :rest_client,
+    :shoryuken
   ].each do |contrib|
     RSpec::Core::RakeTask.new(contrib) do |t|
       t.pattern = "spec/ddtrace/contrib/#{contrib}/**/*_spec.rb"
@@ -86,7 +88,7 @@ end
 namespace :test do
   task all: [:main,
              :rails, :railsredis, :railssidekiq, :railsactivejob,
-             :sidekiq, :sinatra, :monkey]
+             :sidekiq, :monkey]
 
   Rake::TestTask.new(:main) do |t|
     t.libs << %w[test lib]
@@ -129,11 +131,8 @@ namespace :test do
   end
 
   [
-    :aws,
     :grape,
-    :rack,
     :sidekiq,
-    :sinatra,
     :sucker_punch
   ].each do |contrib|
     Rake::TestTask.new(contrib) do |t|
@@ -189,15 +188,13 @@ task :ci do
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
-      sh 'bundle exec appraisal contrib-old rake test:aws'
       sh 'bundle exec appraisal contrib-old rake test:monkey'
-      sh 'bundle exec appraisal contrib-old rake test:rack'
-      sh 'bundle exec appraisal contrib-old rake test:sinatra'
       sh 'bundle exec appraisal contrib-old rake test:sucker_punch'
       # Contrib specs
       sh 'bundle exec appraisal contrib-old rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib-old rake spec:active_record'
       sh 'bundle exec appraisal contrib-old rake spec:active_support'
+      sh 'bundle exec appraisal contrib-old rake spec:aws'
       sh 'bundle exec appraisal contrib-old rake spec:concurrent_ruby'
       sh 'bundle exec appraisal contrib-old rake spec:dalli'
       sh 'bundle exec appraisal contrib-old rake spec:delayed_job'
@@ -207,11 +204,13 @@ task :ci do
       sh 'bundle exec appraisal contrib-old rake spec:http'
       sh 'bundle exec appraisal contrib-old rake spec:mongodb'
       sh 'bundle exec appraisal contrib-old rake spec:mysql2'
+      sh 'bundle exec appraisal contrib-old rake spec:rack'
       sh 'bundle exec appraisal contrib-old rake spec:rake'
       sh 'bundle exec appraisal contrib-old rake spec:redis'
       sh 'bundle exec appraisal contrib-old rake spec:resque'
       sh 'bundle exec appraisal contrib-old rake spec:rest_client'
       sh 'bundle exec appraisal contrib-old rake spec:sequel'
+      sh 'bundle exec appraisal contrib-old rake spec:sinatra'
       # Rails minitests
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
       sh 'bundle exec appraisal rails30-postgres rake test:railsdisableenv'
@@ -233,15 +232,14 @@ task :ci do
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
-      sh 'bundle exec appraisal contrib-old rake test:aws'
       sh 'bundle exec appraisal contrib-old rake test:monkey'
-      sh 'bundle exec appraisal contrib-old rake test:rack'
-      sh 'bundle exec appraisal contrib-old rake test:sinatra'
+      sh 'bundle exec appraisal contrib-old rake test:sidekiq'
       sh 'bundle exec appraisal contrib-old rake test:sucker_punch'
       # Contrib specs
       sh 'bundle exec appraisal contrib-old rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib-old rake spec:active_record'
       sh 'bundle exec appraisal contrib-old rake spec:active_support'
+      sh 'bundle exec appraisal contrib-old rake spec:aws'
       sh 'bundle exec appraisal contrib-old rake spec:concurrent_ruby'
       sh 'bundle exec appraisal contrib-old rake spec:dalli'
       sh 'bundle exec appraisal contrib-old rake spec:delayed_job'
@@ -251,13 +249,14 @@ task :ci do
       sh 'bundle exec appraisal contrib-old rake spec:http'
       sh 'bundle exec appraisal contrib-old rake spec:mongodb'
       sh 'bundle exec appraisal contrib-old rake spec:mysql2'
+      sh 'bundle exec appraisal contrib-old rake spec:rack'
       sh 'bundle exec appraisal contrib-old rake spec:rake'
       sh 'bundle exec appraisal contrib-old rake spec:redis'
       sh 'bundle exec appraisal contrib-old rake spec:resque'
       sh 'bundle exec appraisal contrib-old rake spec:rest_client'
       sh 'bundle exec appraisal contrib-old rake spec:sequel'
+      sh 'bundle exec appraisal contrib-old rake spec:sinatra'
       # Rails minitests
-      sh 'bundle exec appraisal contrib-old rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
       sh 'bundle exec appraisal rails30-postgres rake test:railsdisableenv'
       sh 'bundle exec appraisal rails32-mysql2 rake test:rails'
@@ -281,15 +280,14 @@ task :ci do
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
-      sh 'bundle exec appraisal contrib-old rake test:aws'
       sh 'bundle exec appraisal contrib-old rake test:monkey'
-      sh 'bundle exec appraisal contrib-old rake test:rack'
-      sh 'bundle exec appraisal contrib-old rake test:sinatra'
+      sh 'bundle exec appraisal contrib-old rake test:sidekiq'
       sh 'bundle exec appraisal contrib-old rake test:sucker_punch'
       # Contrib specs
       sh 'bundle exec appraisal contrib-old rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib-old rake spec:active_record'
       sh 'bundle exec appraisal contrib-old rake spec:active_support'
+      sh 'bundle exec appraisal contrib-old rake spec:aws'
       sh 'bundle exec appraisal contrib-old rake spec:concurrent_ruby'
       sh 'bundle exec appraisal contrib-old rake spec:dalli'
       sh 'bundle exec appraisal contrib-old rake spec:delayed_job'
@@ -299,13 +297,14 @@ task :ci do
       sh 'bundle exec appraisal contrib-old rake spec:http'
       sh 'bundle exec appraisal contrib-old rake spec:mongodb'
       sh 'bundle exec appraisal contrib-old rake spec:mysql2'
+      sh 'bundle exec appraisal contrib-old rake spec:rack'
       sh 'bundle exec appraisal contrib-old rake spec:rake'
       sh 'bundle exec appraisal contrib-old rake spec:redis'
       sh 'bundle exec appraisal contrib-old rake spec:resque'
       sh 'bundle exec appraisal contrib-old rake spec:rest_client'
       sh 'bundle exec appraisal contrib-old rake spec:sequel'
+      sh 'bundle exec appraisal contrib-old rake spec:sinatra'
       # Rails minitests
-      sh 'bundle exec appraisal contrib-old rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
       sh 'bundle exec appraisal rails30-postgres rake test:railsdisableenv'
       sh 'bundle exec appraisal rails32-mysql2 rake test:rails'
@@ -335,15 +334,14 @@ task :ci do
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
-      sh 'bundle exec appraisal contrib rake test:aws'
       sh 'bundle exec appraisal contrib rake test:grape'
-      sh 'bundle exec appraisal contrib rake test:rack'
-      sh 'bundle exec appraisal contrib rake test:sinatra'
+      sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec appraisal contrib rake test:sucker_punch'
       # Contrib specs
       sh 'bundle exec appraisal contrib rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib rake spec:active_record'
       sh 'bundle exec appraisal contrib rake spec:active_support'
+      sh 'bundle exec appraisal contrib rake spec:aws'
       sh 'bundle exec appraisal contrib rake spec:concurrent_ruby'
       sh 'bundle exec appraisal contrib rake spec:dalli'
       sh 'bundle exec appraisal contrib rake spec:delayed_job'
@@ -356,13 +354,15 @@ task :ci do
       sh 'bundle exec appraisal contrib rake spec:mongodb'
       sh 'bundle exec appraisal contrib rake spec:mysql2'
       sh 'bundle exec appraisal contrib rake spec:racecar'
+      sh 'bundle exec appraisal contrib rake spec:rack'
       sh 'bundle exec appraisal contrib rake spec:rake'
       sh 'bundle exec appraisal contrib rake spec:redis'
       sh 'bundle exec appraisal contrib rake spec:resque'
       sh 'bundle exec appraisal contrib rake spec:rest_client'
       sh 'bundle exec appraisal contrib rake spec:sequel'
+      sh 'bundle exec appraisal contrib rake spec:shoryuken'
+      sh 'bundle exec appraisal contrib rake spec:sinatra'
       # Rails minitests
-      sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
       sh 'bundle exec appraisal rails30-postgres rake test:railsdisableenv'
       sh 'bundle exec appraisal rails32-mysql2 rake test:rails'
@@ -400,15 +400,14 @@ task :ci do
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
-      sh 'bundle exec appraisal contrib rake test:aws'
       sh 'bundle exec appraisal contrib rake test:grape'
-      sh 'bundle exec appraisal contrib rake test:rack'
-      sh 'bundle exec appraisal contrib rake test:sinatra'
+      sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec appraisal contrib rake test:sucker_punch'
       # Contrib specs
       sh 'bundle exec appraisal contrib rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib rake spec:active_record'
       sh 'bundle exec appraisal contrib rake spec:active_support'
+      sh 'bundle exec appraisal contrib rake spec:aws'
       sh 'bundle exec appraisal contrib rake spec:concurrent_ruby'
       sh 'bundle exec appraisal contrib rake spec:dalli'
       sh 'bundle exec appraisal contrib rake spec:delayed_job'
@@ -421,13 +420,15 @@ task :ci do
       sh 'bundle exec appraisal contrib rake spec:mongodb'
       sh 'bundle exec appraisal contrib rake spec:mysql2'
       sh 'bundle exec appraisal contrib rake spec:racecar'
+      sh 'bundle exec appraisal contrib rake spec:rack'
       sh 'bundle exec appraisal contrib rake spec:rake'
       sh 'bundle exec appraisal contrib rake spec:redis'
       sh 'bundle exec appraisal contrib rake spec:resque'
       sh 'bundle exec appraisal contrib rake spec:rest_client'
       sh 'bundle exec appraisal contrib rake spec:sequel'
+      sh 'bundle exec appraisal contrib rake spec:shoryuken'
+      sh 'bundle exec appraisal contrib rake spec:sinatra'
       # Rails minitests
-      sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec appraisal rails30-postgres rake test:rails'
       sh 'bundle exec appraisal rails30-postgres rake test:railsdisableenv'
       sh 'bundle exec appraisal rails32-mysql2 rake test:rails'
@@ -464,15 +465,14 @@ task :ci do
 
     if RUBY_PLATFORM != 'java'
       # Contrib minitests
-      sh 'bundle exec appraisal contrib rake test:aws'
       sh 'bundle exec appraisal contrib rake test:grape'
-      sh 'bundle exec appraisal contrib rake test:rack'
-      sh 'bundle exec appraisal contrib rake test:sinatra'
+      sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec appraisal contrib rake test:sucker_punch'
       # Contrib specs
       sh 'bundle exec appraisal contrib rake spec:active_model_serializers'
       sh 'bundle exec appraisal contrib rake spec:active_record'
       sh 'bundle exec appraisal contrib rake spec:active_support'
+      sh 'bundle exec appraisal contrib rake spec:aws'
       sh 'bundle exec appraisal contrib rake spec:concurrent_ruby'
       sh 'bundle exec appraisal contrib rake spec:dalli'
       sh 'bundle exec appraisal contrib rake spec:delayed_job'
@@ -485,13 +485,15 @@ task :ci do
       sh 'bundle exec appraisal contrib rake spec:mongodb'
       sh 'bundle exec appraisal contrib rake spec:mysql2'
       sh 'bundle exec appraisal contrib rake spec:racecar'
+      sh 'bundle exec appraisal contrib rake spec:rack'
       sh 'bundle exec appraisal contrib rake spec:rake'
       sh 'bundle exec appraisal contrib rake spec:redis'
       sh 'bundle exec appraisal contrib rake spec:resque'
       sh 'bundle exec appraisal contrib rake spec:rest_client'
       sh 'bundle exec appraisal contrib rake spec:sequel'
+      sh 'bundle exec appraisal contrib rake spec:shoryuken'
+      sh 'bundle exec appraisal contrib rake spec:sinatra'
       # Rails minitests
-      sh 'bundle exec appraisal contrib rake test:sidekiq'
       sh 'bundle exec rake benchmark'
     end
   end

data/docker-compose.yml

@@ -16,8 +16,8 @@ services:
     env_file: ./.env
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
       - TEST_DATADOG_INTEGRATION=1
-      - TEST_DDAGENT_HOST=ddagent
       - TEST_ELASTICSEARCH_HOST=elasticsearch
       - TEST_MEMCACHED_HOST=memcached
       - TEST_MONGODB_HOST=mongodb
@@ -46,8 +46,8 @@ services:
     env_file: ./.env
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
       - TEST_DATADOG_INTEGRATION=1
-      - TEST_DDAGENT_HOST=ddagent
       - TEST_ELASTICSEARCH_HOST=elasticsearch
       - TEST_MEMCACHED_HOST=memcached
       - TEST_MONGODB_HOST=mongodb
@@ -76,8 +76,8 @@ services:
     env_file: ./.env
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
       - TEST_DATADOG_INTEGRATION=1
-      - TEST_DDAGENT_HOST=ddagent
       - TEST_ELASTICSEARCH_HOST=elasticsearch
       - TEST_MEMCACHED_HOST=memcached
       - TEST_MONGODB_HOST=mongodb
@@ -106,8 +106,8 @@ services:
     env_file: ./.env
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
       - TEST_DATADOG_INTEGRATION=1
-      - TEST_DDAGENT_HOST=ddagent
       - TEST_ELASTICSEARCH_HOST=elasticsearch
       - TEST_MEMCACHED_HOST=memcached
       - TEST_MONGODB_HOST=mongodb
@@ -136,8 +136,8 @@ services:
     env_file: ./.env
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
       - TEST_DATADOG_INTEGRATION=1
-      - TEST_DDAGENT_HOST=ddagent
       - TEST_ELASTICSEARCH_HOST=elasticsearch
       - TEST_MEMCACHED_HOST=memcached
       - TEST_MONGODB_HOST=mongodb
@@ -166,8 +166,8 @@ services:
     env_file: ./.env
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
+      - DD_AGENT_HOST=ddagent
       - TEST_DATADOG_INTEGRATION=1
-      - TEST_DDAGENT_HOST=ddagent
       - TEST_ELASTICSEARCH_HOST=elasticsearch
       - TEST_MEMCACHED_HOST=memcached
       - TEST_MONGODB_HOST=mongodb
@@ -189,7 +189,7 @@ services:
     expose:
       - "8126"
     ports:
-      - "${TEST_DDAGENT_PORT}:8126"
+      - "${DD_TRACE_AGENT_PORT}:8126"
   elasticsearch:
     # Note: ES 5.0 dies with error:
     # max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]

data/docs/GettingStarted.md

@@ -46,6 +46,7 @@ For descriptions of terminology used in APM, take a look at the [official docume
      - [Redis](#redis)
      - [Rest Client](#rest-client)
      - [Resque](#resque)
+     - [Shoryuken](#shoryuken)
      - [Sequel](#sequel)
      - [Sidekiq](#sidekiq)
      - [Sinatra](#sinatra)
@@ -330,6 +331,7 @@ For a list of available integrations, and their configuration options, please re
 | Resque                   | `resque`                   | `>= 1.0, < 2.0`          | *[Link](#resque)*                   | *[Link](https://github.com/resque/resque)*                                     |
 | Rest Client              | `rest-client`              | `>= 1.8`                 | *[Link](#rest-client)*              | *[Link](https://github.com/rest-client/rest-client)*                           |
 | Sequel                   | `sequel`                   | `>= 3.41`                | *[Link](#sequel)*                   | *[Link](https://github.com/jeremyevans/sequel)*                                |
+| Shoryuken                | `shoryuken`                | `>= 4.0.2`               | *[Link](#shoryuken)*                | *[Link](https://github.com/phstc/shoryuken)*
 | Sidekiq                  | `sidekiq`                  | `>= 3.5.4`               | *[Link](#sidekiq)*                  | *[Link](https://github.com/mperham/sidekiq)*                                   |
 | Sinatra                  | `sinatra`                  | `>= 1.4.5`               | *[Link](#sinatra)*                  | *[Link](https://github.com/sinatra/sinatra)*                                   |
 | Sucker Punch             | `sucker_punch`             | `>= 2.0`                 | *[Link](#sucker-punch)*             | *[Link](https://github.com/brandonhilkert/sucker_punch)*                       |
@@ -1178,9 +1180,30 @@ Datadog.configure(sqlite_database, service_name: 'my-sqlite-db')
 Datadog.configure(postgres_database, service_name: 'my-postgres-db')
 ```
 
+### Shoryuken
+
+The Shoryuken integration is a server-side middleware which will trace job executions.
+
+You can enable it through `Datadog.configure`:
+
+```ruby
+require 'ddtrace'
+
+Datadog.configure do |c|
+  c.use :shoryuken, options
+end
+```
+
+Where `options` is an optional `Hash` that accepts the following parameters:
+
+| Key | Description | Default |
+| --- | ----------- | ------- |
+| `service_name` | Service name used for `shoryuken` instrumentation | `'shoryuken'` |
+| `tracer` | `Datadog::Tracer` used to perform instrumentation. Usually you don't need to set this. | `Datadog.tracer` |
+
 ### Sidekiq
 
-The Sidekiq integration is a server-side middleware which will trace job executions.
+The Sidekiq integration is a client-side & server-side middleware which will trace job queuing and executions respectively.
 
 You can enable it through `Datadog.configure`:
 
@@ -1196,7 +1219,8 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 
 | Key | Description | Default |
 | --- | ----------- | ------- |
-| `service_name` | Service name used for `sidekiq` instrumentation | `'sidekiq'` |
+| `client_service_name` | Service name used for client-side `sidekiq` instrumentation | `'sidekiq-client'` |
+| `service_name` | Service name used for server-side `sidekiq` instrumentation | `'sidekiq'` |
 | `tracer` | `Datadog::Tracer` used to perform instrumentation. Usually you don't need to set this. | `Datadog.tracer` |
 
 ### Sinatra