Add Karafka integration

Matrixfile

@@ -111,6 +111,11 @@
   'kafka' => {
     'activesupport' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby'
   },
+  'karafka' => {
+    'karafka-latest' => '❌ 2.5 / ❌ 2.6 / ❌ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
+    # karafka 2.0.41 contains broken dependency of karafka-core 2.2.4, which depends on Ruby (>= 2.6.0)
+    'karafka-min'    => '❌ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby',
+  },
   'lograge' => {
     'activesupport' => '✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ 3.3 / ✅ 3.4 / ✅ jruby'
   },

Rakefile

@@ -243,6 +243,7 @@ namespace :spec do
     :httpclient,
     :httprb,
     :kafka,
+    :karafka,
     :lograge,
     :mongodb,
     :mysql2,

appraisal/jruby-9.3.rb

@@ -178,6 +178,10 @@
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
 
+appraise 'karafka-min' do
+  gem 'karafka', '= 2.0.41'
+end
+
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.0.0'
   gem 'delayed_job'

appraisal/jruby-9.4.rb

@@ -81,6 +81,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
+build_coverage_matrix('karafka', min: '2.0.41')
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.1.0'

appraisal/ruby-2.6.rb

@@ -177,6 +177,10 @@
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
 
+appraise 'karafka-min' do
+  gem 'karafka', '= 2.0.41'
+end
+
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.0.0'
   gem 'delayed_job'

appraisal/ruby-2.7.rb

@@ -177,6 +177,10 @@
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
 
+appraise 'karafka-min' do
+  gem 'karafka', '= 2.0.41'
+end
+
 appraise 'relational_db' do
   gem 'activerecord', '~> 6.1.0'
   gem 'delayed_job'
@@ -203,7 +207,6 @@
 appraise 'contrib' do
   gem 'concurrent-ruby'
   gem 'grpc'
-
   gem 'rack-test' # Dev dependencies for testing rack-based code
   gem 'rake', '>= 12.3'
   gem 'resque'

appraisal/ruby-3.0.rb

@@ -97,6 +97,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
+build_coverage_matrix('karafka', min: '2.0.41')
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'
@@ -125,7 +126,6 @@
 appraise 'contrib' do
   gem 'concurrent-ruby'
   gem 'grpc', '>= 1.38.0', platform: :ruby # Minimum version with Ruby 3.0 support
-
   gem 'rack-test' # Dev dependencies for testing rack-based code
   gem 'rake', '>= 12.3'
   gem 'resque'

appraisal/ruby-3.1.rb

@@ -97,6 +97,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
+build_coverage_matrix('karafka', min: '2.0.41')
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'
@@ -125,7 +126,6 @@
 appraise 'contrib' do
   gem 'concurrent-ruby'
   gem 'grpc', '>= 1.38.0', platform: :ruby # Minimum version with Ruby 3.0 support
-
   gem 'rack-test' # Dev dependencies for testing rack-based code
   gem 'rake', '>= 12.3'
   gem 'resque'

appraisal/ruby-3.2.rb

@@ -97,6 +97,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
+build_coverage_matrix('karafka', min: '2.0.41')
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'
@@ -125,7 +126,6 @@
 appraise 'contrib' do
   gem 'concurrent-ruby'
   gem 'grpc', '>= 1.38.0', platform: :ruby # Minimum version with Ruby 3.0 support
-
   gem 'rack-test' # Dev dependencies for testing rack-based code
   gem 'rake', '>= 12.3'
   gem 'resque'

appraisal/ruby-3.3.rb

@@ -97,6 +97,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
+build_coverage_matrix('karafka', min: '2.0.41')
 
 appraise 'relational_db' do
   gem 'activerecord', '~> 7'
@@ -125,7 +126,6 @@
 appraise 'contrib' do
   gem 'concurrent-ruby'
   gem 'grpc', '>= 1.38.0', platform: :ruby # Minimum version with Ruby 3.0 support
-
   gem 'rack-test' # Dev dependencies for testing rack-based code
   gem 'rake', '>= 12.3'
   gem 'resque'

appraisal/ruby-3.4.rb

@@ -97,6 +97,7 @@
 build_coverage_matrix('rest-client')
 build_coverage_matrix('mongo', min: '2.1.0')
 build_coverage_matrix('dalli', [2])
+build_coverage_matrix('karafka', min: '2.0.41')
 
 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.
@@ -133,7 +134,6 @@
   gem 'concurrent-ruby'
   # Temporarily disable for Ruby 3.4: No binaries causing build time takes more than 10 minutes
   # gem 'grpc', '>= 1.38.0', platform: :ruby
-
   gem 'rack-test' # Dev dependencies for testing rack-based code
   gem 'rake', '>= 12.3'
   gem 'resque'

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)                                |
+| Karafka                    | `karafka`                  | `>= 2.0.41`                                 | `>= 2.0.41`                                 | [Link][55]       | [Link](https://karafka.io/) |
 | 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/automatic_instrumentation/dd_libraries/ruby/#karafka

docs/GettingStarted.md

@@ -1114,6 +1114,27 @@ end
 | --------- | ------------------------------- | ------ | -------------------------------------------- | ------- |
 | `enabled` | `DD_TRACE_KAFKA_ENABLED` | `Bool` | Whether the integration should create spans. | `true` |
 
+### Karafka
+
+The karafka integration provides tracing of the `karafka` gem.
+You can enable it through `Datadog.configure`:
+
+```ruby
+require 'karafka'
+require 'datadog'
+
+Datadog.configure do |c|
+  c.tracing.instrument :karafka, **options
+end
+
+```
+`options` are the following keyword arguments:
+
+| Key                   | Env Var                  | Type   | Description                                         | Default |
+| --------------------- | ------------------------ | ------ | --------------------------------------------------- | ------- |
+| `enabled`             | `DD_TRACE_KARAFKA_ENABLED` | `Bool` | Specifies whether the integration should create spans.        | `true`  |
+| `distributed_tracing` |                          | `Bool` | Enables [distributed tracing](#distributed-tracing). | `false` |
+
 ### 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: