Add support for the kicks gem

Matrixfile

@@ -168,7 +168,9 @@
     'contrib' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby'
   },
   'sneakers' => {
-    'contrib' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby'
+    'kicks-latest' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
+    'kicks-min' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
+    'sneakers-min' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
   },
   'stripe' => {
     'stripe-latest' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',

appraisal/generate.rb

@@ -49,12 +49,15 @@
 
 # Builds a matrix of versions to test for a given integration
 
-# `range`: the range of versions to test
-# `gem`  : optional, gem name to test (gem name can be different from the integration name)
-# `min`  : optional, minimum version to test
-# `meta` : optional, additional metadata (development dependencies, etc.) for the group
-def build_coverage_matrix(integration, range, gem: nil, min: nil, meta: {})
-  gem ||= integration
+# @param [String] integration the name of the integration to test
+# @param [Range, Integer] range the range of major versions to test, or a single major version to test
+# @param [String] gem optional, gem name to test (gem name can be different from the integration name)
+# @param [String] min optional, minimum version to test
+# @param [Boolean] latest optional, whether to test the latest version
+# @param [Hash] meta optional, additional metadata (development dependencies, etc.) for the group
+def build_coverage_matrix(integration, range, gem: integration, min: nil, latest: true, meta: {})
+  # Allow single version to be passed easily
+  range = range..range if range.is_a?(Integer)
 
   if min
     appraise "#{integration}-min" do
@@ -70,12 +73,14 @@ def build_coverage_matrix(integration, range, gem: nil, min: nil, meta: {})
     end
   end
 
-  appraise "#{integration}-latest" do
-    # The latest group declares dependencies without version constraints,
-    # still requires being updated to pick up the next major version and
-    # committing the changes to lockfiles.
-    gem gem
-    meta.each { |k, v| v ? gem(k, v) : gem(k) }
+  if latest
+    appraise "#{integration}-latest" do
+      # The latest group declares dependencies without version constraints,
+      # still requires being updated to pick up the next major version and
+      # committing the changes to lockfiles.
+      gem gem
+      meta.each { |k, v| v ? gem(k, v) : gem(k) }
+    end
   end
 end
 

appraisal/jruby-9.2.rb

@@ -202,6 +202,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 5'

appraisal/jruby-9.3.rb

@@ -175,6 +175,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.0.0'

appraisal/jruby-9.4.rb

@@ -79,6 +79,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.1.0'

appraisal/ruby-2.5.rb

@@ -221,6 +221,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 5'

appraisal/ruby-2.6.rb

@@ -174,6 +174,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.0.0'

appraisal/ruby-2.7.rb

@@ -174,6 +174,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.1.0'

appraisal/ruby-3.0.rb

@@ -95,6 +95,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'

appraisal/ruby-3.1.rb

@@ -95,6 +95,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'

appraisal/ruby-3.2.rb

@@ -95,6 +95,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'

appraisal/ruby-3.3.rb

@@ -95,6 +95,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'
@@ -131,7 +133,6 @@
   gem 'roda', '>= 2.0.0'
   gem 'semantic_logger', '~> 4.0'
   gem 'sidekiq', '~> 7'
-  gem 'sneakers', '>= 2.12.0'
   gem 'sucker_punch'
   gem 'que', '>= 1.0.0'
 end

appraisal/ruby-3.4.rb

@@ -95,6 +95,8 @@
 build_coverage_matrix('stripe', 7..12, min: '5.15.0')
 build_coverage_matrix('opensearch', 2..3, gem: 'opensearch-ruby')
 build_coverage_matrix('elasticsearch', 7..8)
+build_coverage_matrix('kicks', [], min: '3.0.0')
+build_coverage_matrix('sneakers', [], min: '2.12.0', latest: false) # Sneakers is not receiving updates anymore and 2.12.0 is the last version
 
 appraise 'relational_db' do
   # ActiveRecord locked because tests are failing with 7.1, which was attempted as a part of Ruby 3.4 testing in CI.

docs/Compatibility.md

@@ -91,6 +91,7 @@ For a list of available integrations, and their configuration options, refer to
 | httpclient                 | `httpclient`               | `>= 2.2`                                    | `>= 2.2`                                    | [Link][23]       | [Link](https://github.com/nahi/httpclient)                                   |
 | httpx                      | `httpx`                    | `>= 0.11`                                   | `>= 0.11`                                   | [Link][24]       | [Link](https://gitlab.com/honeyryderchuck/httpx)                             |
 | Kafka                      | `ruby-kafka`               | `>= 0.7.10`                                 | `>= 0.7.10`                                 | [Link][25]       | [Link](https://github.com/zendesk/ruby-kafka)                                |
+| Kicks | `kicks` | `>= 3.0.0` | `>= 3.0.0` | [Link][55] | [Link](https://github.com/ruby-amqp/kicks) |
 | Makara (via Active Record) | `makara`                   | `>= 0.3.5`                                  | `>= 0.3.5`                                  | [Link][8]        | [Link](https://github.com/instacart/makara)                                  |
 | MongoDB                    | `mongo`                    | `>= 2.1`                                    | `>= 2.1`                                    | [Link][26]       | [Link](https://github.com/mongodb/mongo-ruby-driver)                         |
 | MySQL2                     | `mysql2`                   | `>= 0.3.21`                                 | *gem not available*                         | [Link][27]       | [Link](https://github.com/brianmario/mysql2)                                 |
@@ -269,3 +270,5 @@ new release of 1.21.0 (or 1.20.1). Those bugfixes will not be backported as patc
 [53]: https://docs.datadoghq.com/agent/basic_agent_usage/?tab=agentv6v7
 
 [54]: https://docs.datadoghq.com/agent/basic_agent_usage/?tab=agentv5
+
+[55]: https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby#kicks

docs/GettingStarted.md

@@ -1112,6 +1112,32 @@ end
 | --------- | ------------------------------- | ------ | -------------------------------------------- | ------- |
 | `enabled` | `DD_TRACE_KAFKA_ENABLED` | `Bool` | Whether the integration should create spans. | `true` |
 
+### Kicks
+
+The Kicks integration is a server-side middleware which will trace job executions.
+
+<div class="alert alert-warning">
+Kicks is a continuation of Sneakers and both cannot be active at the same time, as they share their Ruby class namespace. Configurations to the Sneakers integration will be safely merged with any Kicks configuration.
+</div>
+
+You can enable it through `Datadog.configure`:
+
+```ruby
+require 'datadog'
+
+Datadog.configure do |c|
+  c.tracing.instrument :kicks, **options
+end
+```
+
+`options` are the following keyword arguments:
+
+| Key        | Env Var | Type   | Description                                                                                                                                                                 | Default                                                           |
+| ---------- | - | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `enabled`  | `DD_TRACE_SNEAKERS_ENABLED` | `Bool` | Whether the integration should create spans.                                                                      | `true`                                                            |
+| `tag_body` | | `Bool` | Enable tagging of job message. `true` for on, `false` for off.                                                                                                              | `false`                                                           |
+| `on_error` | | `Proc` | Custom error handler invoked when a job raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { \|span, error\| span.set_error(error) unless span.nil? }` |
+
 ### MongoDB
 
 The integration traces any `Command` that is sent from the [MongoDB Ruby Driver](https://github.com/mongodb/mongo-ruby-driver) to a MongoDB cluster. By extension, Object Document Mappers (ODM) such as Mongoid are automatically instrumented if they use the official Ruby driver. To activate the integration, simply:
@@ -1935,6 +1961,10 @@ end
 
 The Sneakers integration is a server-side middleware which will trace job executions.
 
+<div class="alert alert-warning">
+Kicks is a continuation of Sneakers and both cannot be active at the same time, as they share their Ruby class namespace. Configurations to the Sneakers integration will be safely merged with any Kicks configuration.
+</div>
+
 You can enable it through `Datadog.configure`:
 
 ```ruby