Roda Integration

Appraisals

@@ -117,6 +117,7 @@ if ruby_version?('2.1')
     gem 'redis', '< 4.0'
     gem 'rest-client'
     gem 'resque', '< 2.0'
+    gem 'roda'
     gem 'ruby-kafka', '>= 0.7.10'
     gem 'rspec', '>= 3.0.0'
     gem 'semantic_logger', '~> 4.0'
@@ -295,6 +296,7 @@ elsif ruby_version?('2.2')
     gem 'redis', '< 4.0'
     gem 'rest-client'
     gem 'resque', '< 2.0'
+    gem 'roda'
     gem 'ruby-kafka', '>= 0.7.10'
     gem 'rspec', '>= 3.0.0'
     gem 'semantic_logger', '~> 4.0'
@@ -486,6 +488,7 @@ elsif ruby_version?('2.3')
     gem 'redis', '< 4.0'
     gem 'rest-client'
     gem 'resque'
+    gem 'roda'
     gem 'ruby-kafka', '>= 0.7.10'
     gem 'rspec', '>= 3.0.0'
     gem 'semantic_logger', '~> 4.0'
@@ -611,6 +614,7 @@ elsif ruby_version?('2.4')
     gem 'redis', '< 4.0'
     gem 'rest-client'
     gem 'resque'
+    gem 'roda'
     gem 'ruby-kafka', '>= 0.7.10'
     gem 'rspec', '>= 3.0.0'
     gem 'semantic_logger', '~> 4.0'
@@ -866,6 +870,7 @@ elsif ruby_version?('2.5')
     gem 'redis', '< 4.0'
     gem 'rest-client'
     gem 'resque'
+    gem 'roda'
     gem 'ruby-kafka', '>= 0.7.10'
     gem 'rspec', '>= 3.0.0'
     gem 'semantic_logger', '~> 4.0'
@@ -1097,6 +1102,7 @@ elsif ruby_version?('2.6')
       gem 'redis', '< 4.0'
       gem 'rest-client'
       gem 'resque'
+      gem 'roda'
       gem 'ruby-kafka', '>= 0.7.10'
       gem 'rspec', '>= 3.0.0'
       gem 'semantic_logger', '~> 4.0'
@@ -1308,6 +1314,7 @@ elsif ruby_version?('2.7')
       gem 'redis', '< 4.0'
       gem 'rest-client'
       gem 'resque'
+      gem 'roda'
       gem 'ruby-kafka', '>= 0.7.10'
       gem 'rspec', '>= 3.0.0'
       gem 'sequel'
@@ -1424,6 +1431,7 @@ elsif ruby_version?('3.0') || ruby_version?('3.1')
     gem 'redis', '< 4.0'
     gem 'rest-client'
     gem 'resque'
+    gem 'roda'
     gem 'ruby-kafka', '>= 0.7.10'
     gem 'rspec', '>= 3.0.0'
     gem 'semantic_logger', '~> 4.0'
@@ -1540,6 +1548,7 @@ elsif ruby_version?('3.2')
     gem 'redis', '< 4.0'
     gem 'rest-client'
     gem 'resque'
+    gem 'roda'
     gem 'ruby-kafka', '>= 0.7.10'
     gem 'rspec', '>= 3.0.0'
     gem 'semantic_logger', '~> 4.0'

Rakefile

@@ -152,6 +152,7 @@ namespace :spec do
     :rake,
     :redis,
     :resque,
+    :roda,
     :rest_client,
     :semantic_logger,
     :sequel,
@@ -308,6 +309,7 @@ task :ci do
   declare '✅ 2.1 / ✅ 2.2 / ✅ 2.3 / ✅ 2.4 / ✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ jruby' => 'bundle exec appraisal contrib rake spec:redis'
   declare '✅ 2.1 / ✅ 2.2 / ✅ 2.3 / ✅ 2.4 / ✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ jruby' => 'bundle exec appraisal contrib rake spec:resque'
   declare '✅ 2.1 / ✅ 2.2 / ✅ 2.3 / ✅ 2.4 / ✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ jruby' => 'bundle exec appraisal contrib rake spec:rest_client'
+  declare '✅ 2.1 / ✅ 2.2 / ✅ 2.3 / ✅ 2.4 / ✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ jruby' => 'bundle exec appraisal contrib rake spec:roda'
   declare '✅ 2.1 / ✅ 2.2 / ✅ 2.3 / ✅ 2.4 / ✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ jruby' => 'bundle exec appraisal contrib rake spec:rspec'
   declare '✅ 2.1 / ✅ 2.2 / ✅ 2.3 / ✅ 2.4 / ✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ jruby' => 'bundle exec appraisal contrib rake spec:semantic_logger'
   declare '✅ 2.1 / ✅ 2.2 / ✅ 2.3 / ✅ 2.4 / ✅ 2.5 / ✅ 2.6 / ✅ 2.7 / ✅ 3.0 / ✅ 3.1 / ✅ 3.2 / ✅ jruby' => 'bundle exec appraisal contrib rake spec:sequel'

docs/GettingStarted.md

@@ -73,6 +73,7 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
      - [Redis](#redis)
      - [Resque](#resque)
      - [Rest Client](#rest-client)
+     - [Roda](#roda)
      - [RSpec](#rspec)
      - [Sequel](#sequel)
      - [Shoryuken](#shoryuken)
@@ -510,6 +511,7 @@ For a list of available integrations, and their configuration options, please re
 | Redis                      | `redis`                    | `>= 3.2`                 | `>= 3.2`                  | *[Link](#redis)*                    | *[Link](https://github.com/redis/redis-rb)*                                    |
 | Resque                     | `resque`                   | `>= 1.0`                 | `>= 1.0`                  | *[Link](#resque)*                   | *[Link](https://github.com/resque/resque)*                                     |
 | Rest Client                | `rest-client`              | `>= 1.8`                 | `>= 1.8`                  | *[Link](#rest-client)*              | *[Link](https://github.com/rest-client/rest-client)*                           |
+| Roda                | `roda`              | `>= 2.1`                 | `>= 2.1`                  | *[Link](#roda)*              | *[Link](https://github.com/jeremyevans/roda)*                           |
 | Sequel                     | `sequel`                   | `>= 3.41`                | `>= 3.41`                 | *[Link](#sequel)*                   | *[Link](https://github.com/jeremyevans/sequel)*                                |
 | Shoryuken                  | `shoryuken`                | `>= 3.2`                 | `>= 3.2`                  | *[Link](#shoryuken)*                | *[Link](https://github.com/phstc/shoryuken)*                                   |
 | Sidekiq                    | `sidekiq`                  | `>= 3.5.4`               | `>= 3.5.4`                | *[Link](#sidekiq)*                  | *[Link](https://github.com/mperham/sidekiq)*                                   |
@@ -1818,6 +1820,28 @@ end
 | `service_name` | Service name for `rest_client` instrumentation. | `'rest_client'` |
 | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
 
+### Roda
+
+The Roda integration traces requests.
+
+It can be enabled through `Datadog.configure`:
+
+```ruby
+require 'roda'
+require 'ddtrace'
+
+Datadog.configure do |c|
+  c.tracing.instrument :roda, **options
+end
+```
+
+`options` are the following keyword arguments:
+
+| Key | Description | Default |
+| --- | ----------- | ------- |
+| `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
+| `service_name` | Service name for `roda` instrumentation. | `'roda'` |
+
 ### RSpec
 
 RSpec integration will trace all executions of example groups and examples when using `rspec` test framework.

lib/datadog/tracing/contrib.rb

@@ -69,6 +69,7 @@ module Contrib
 require_relative 'contrib/redis/integration'
 require_relative 'contrib/resque/integration'
 require_relative 'contrib/rest_client/integration'
+require_relative 'contrib/roda/integration'
 require_relative 'contrib/semantic_logger/integration'
 require_relative 'contrib/sequel/integration'
 require_relative 'contrib/shoryuken/integration'

lib/datadog/tracing/contrib/roda/configuration/settings.rb

@@ -0,0 +1,33 @@
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Roda
+        module Configuration
+          # Custom settings for the Roda integration
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+
+            option :analytics_enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :distributed_tracing, default: true
+            option :service_name, default: Ext::SERVICE_NAME
+          end
+        end
+      end
+    end
+  end
+end

lib/datadog/tracing/contrib/roda/ext.rb

@@ -0,0 +1,18 @@
+module Datadog
+  module Tracing
+    module Contrib
+      module Roda
+        # Roda integration constants
+        module Ext
+          APP = 'roda'.freeze
+          ENV_ENABLED = 'DD_TRACE_RODA_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_RODA_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_RODA_ANALYTICS_SAMPLE_RATE'.freeze
+
+          SERVICE_NAME = 'roda'.freeze
+          SPAN_REQUEST = 'roda.request'.freeze
+        end
+      end
+    end
+  end
+end

lib/datadog/tracing/contrib/roda/instrumentation.rb

@@ -0,0 +1,84 @@
+require_relative '../../metadata/ext'
+require_relative 'ext'
+require_relative '../analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Roda
+        # Instrumentation for Roda
+        module Instrumentation
+
+          def _roda_handle_main_route
+            instrument(Ext::SPAN_REQUEST) { super }
+          end
+
+          def call
+            instrument(Ext::SPAN_REQUEST) { super }
+          end
+
+          private
+
+          def instrument(span_name, &block)
+            set_distributed_tracing_context!(request.env)
+
+            Tracing.trace(span_name) do |span|
+              begin
+                request_method = request.request_method.to_s.upcase
+
+                span.service = configuration[:service_name]
+                span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
+
+                # Using the http method as a resource, since the URL/path can trigger
+                # a possibly infinite number of resources.
+                span.resource = request_method
+
+                span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, request.path)
+                span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, request_method)
+
+                # Add analytics tag to the span
+                if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                  Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+                end
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              ensure
+                begin
+                  response = yield
+                rescue => e
+                  # The status code is unknown to Roda and decided by the upstream web runner.
+                  # In this case, spans default to status code 500 rather than a blank status code.
+                  default_error_status = '500'
+                  span.resource = "#{request_method} #{default_error_status}"
+                  span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, default_error_status)
+                  raise
+                end
+              end
+
+              status_code = response[0]
+
+              # Adds status code to the resource name once the resource comes back
+              span.resource = "#{request_method} #{status_code}"
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, status_code)
+              span.status = 1 if status_code.to_s.start_with?('5')
+              response
+            end
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:roda]
+          end
+
+          def set_distributed_tracing_context!(env)
+            if configuration[:distributed_tracing]
+              trace_digest = Tracing::Propagation::HTTP.extract(env)
+              Tracing.continue_trace!(trace_digest)
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/datadog/tracing/contrib/roda/integration.rb

@@ -0,0 +1,38 @@
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Roda
+        # Description of Roda integration
+        class Integration
+          include Contrib::Integration
+
+          register_as :roda
+
+          def self.version
+            Gem.loaded_specs['roda'] && Gem.loaded_specs['roda'].version
+          end
+
+          def self.loaded?
+            !defined?(::Roda).nil?
+          end
+
+          def self.compatible?
+            super && version >= Gem::Version.new('2.0.0')
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

lib/datadog/tracing/contrib/roda/patcher.rb

@@ -0,0 +1,27 @@
+require_relative 'patcher'
+require_relative 'ext'
+require_relative 'instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Roda
+        # Patcher enables patching of 'roda'
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Roda::prepend(Instrumentation)
+          end
+
+        end
+      end
+    end
+  end
+end