opentelemetry-instrumentation-sinatra 0.23.5 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d057f9632745f34d440f2974afc6a5972fbdddf84e78399444cf701f1ccab8
-  data.tar.gz: 2890bdb60380ef2bc77f8464fd6c7c483491527d0d15398aa53db7184ed62d9a
+  metadata.gz: a78599c829d2be9627e4fc53e0b862987080ae7af515024391d22d97293dd485
+  data.tar.gz: 7c2da7aebc1a33187902afd199aefe4cbee83866d866021ceec4deb86c078101
 SHA512:
-  metadata.gz: 8faf33107b76e7efc4e8b6cbfab31b2425d08847e48b8f5c773977ceb9357f7ab9b07eab53df4c9db626c07fc7335f297673bd506104ac4b7d78aa5326ca050b
-  data.tar.gz: 60ffc9095d477828fe5f7ec76817d969a0905de37222380ee253ca12dedac7cd7a7f516bcb7af077384aafcbefa310f24dcdbe32360afaabbb0d0f663aae4c80
+  metadata.gz: 99d40a9dd38024c716f61d989710c71aa1d55227d506af465dee03a2e7fa52c41104e5aa5acee851eaf99e76a8af7c7eb78dd28d1921e0c2f20370de4b03ffa7
+  data.tar.gz: d69cbedefa3bbd4ebcf4726f406113d7e2bd1ad04b5bd8a59bf24314903e101dc7aa207f9c2738970323e6310eb2ecd37ee74da076b86e795f2082c07465486f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-sinatra
 
+### v0.24.1 / 2024-07-23
+
+* DOCS: Add cspell to CI
+
+### v0.24.0 / 2024-07-02
+
+* ADDED: Make Rack install optional for sinatra
+
 ### v0.23.5 / 2024-06-18
 
 * FIXED: Relax otel common gem constraints
@@ -86,7 +94,7 @@
 
 ### v0.18.0 / 2021-05-21
 
-* ADDED: Updated API depedency for 1.0.0.rc1
+* ADDED: Updated API dependency for 1.0.0.rc1
 * BREAKING CHANGE: Remove optional parent_context from in_span
 
 * FIXED: Remove optional parent_context from in_span
@@ -146,7 +154,7 @@
 ### v0.7.0 / 2020-10-07
 
 * FIXED: Default to sinatra.route for span name
-* DOCS: Standardize toplevel docs structure and readme
+* DOCS: Standardize top-level docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 

data/lib/opentelemetry/instrumentation/sinatra/extensions/tracer_extension.rb

@@ -13,23 +13,25 @@ module OpenTelemetry
         # Sinatra extension that installs TracerMiddleware and provides
         # tracing for template rendering
         module TracerExtension
-          # Sinatra hook after extension is registered
-          def self.registered(app)
-            # Create tracing `render` method
-            ::Sinatra::Base.module_eval do
-              def render(_engine, data, *)
-                template_name = data.is_a?(Symbol) ? data : :literal
+          # Contants patches for `render` method
+          module RenderPatches
+            def render(_engine, data, *)
+              template_name = data.is_a?(Symbol) ? data : :literal
 
-                Sinatra::Instrumentation.instance.tracer.in_span(
-                  'sinatra.render_template',
-                  attributes: { 'sinatra.template_name' => template_name.to_s }
-                ) do
-                  super
-                end
+              Sinatra::Instrumentation.instance.tracer.in_span(
+                'sinatra.render_template',
+                attributes: { 'sinatra.template_name' => template_name.to_s }
+              ) do
+                super
               end
             end
-            app.use(*OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.middleware_args)
-            app.use(Middlewares::TracerMiddleware)
+          end
+
+          # Sinatra hook after extension is registered
+          def self.registered(app)
+            # Create tracing `render` method
+            ::Sinatra::Base.prepend(RenderPatches)
+            Sinatra::Instrumentation.instance.install_middleware(app)
           end
         end
       end

data/lib/opentelemetry/instrumentation/sinatra/instrumentation.rb

@@ -9,18 +9,51 @@ require_relative 'extensions/tracer_extension'
 module OpenTelemetry
   module Instrumentation
     module Sinatra
-      # The Instrumentation class contains logic to detect and install the Sinatra
-      # instrumentation
+      # The {OpenTelemetry::Instrumentation::Sinatra::Instrumentation} class contains logic to detect and install the Sinatra instrumentation
+      #
+      # Installation and configuration of this instrumentation is done within the
+      # {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry/SDK#configure-instance_method OpenTelemetry::SDK#configure}
+      # block, calling {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use use()}
+      # or {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use_all use_all()}.
+      #
+      # ## Configuration keys and options
+      #
+      # ### `:install_rack`
+      #
+      # Default is `true`. Specifies whether or not to install the Rack instrumentation as part of installing the Sinatra instrumentation.
+      # This is useful in cases where you have multiple Rack applications but want to manually specify where to insert the tracing middleware.
+      #
+      # @example Manually install Rack instrumentation.
+      #   OpenTelemetry::SDK.configure do |c|
+      #     c.use_all({
+      #       'OpenTelemetry::Instrumentation::Rack' => { },
+      #       'OpenTelemetry::Instrumentation::Sinatra' => {
+      #         install_rack: false
+      #       },
+      #     })
+      #   end
+      #
       class Instrumentation < OpenTelemetry::Instrumentation::Base
-        install do |_|
-          OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.install({})
+        install do |config|
+          OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.install({}) if config[:install_rack]
+
+          unless OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.installed?
+            OpenTelemetry.logger.warn('Rack instrumentation is required for Sinatra but not installed. Please see the docs for more details: https://opentelemetry.io/docs/languages/ruby/libraries/')
+          end
 
           ::Sinatra::Base.register Extensions::TracerExtension
         end
 
+        option :install_rack, default: true, validate: :boolean
+
         present do
           defined?(::Sinatra)
         end
+
+        def install_middleware(app)
+          app.use(*OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.middleware_args) if config[:install_rack]
+          app.use(Middlewares::TracerMiddleware)
+        end
       end
     end
   end

data/lib/opentelemetry/instrumentation/sinatra/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sinatra
-      VERSION = '0.23.5'
+      VERSION = '0.24.1'
     end
   end
 end

data/lib/opentelemetry/instrumentation/sinatra.rb

@@ -9,7 +9,7 @@ require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation
-    # Contains the OpenTelemetry instrumentation for the Sinatra gem
+    # (see OpenTelemetry::Instrumentation::Sinatra::Instrumentation)
     module Sinatra
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.23.5
+  version: 0.24.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.0
+        version: 1.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.0
+        version: 1.65.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -228,10 +228,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sinatra/0.23.5/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sinatra/0.24.1/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/sinatra
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sinatra/0.23.5
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sinatra/0.24.1
 post_install_message: 
 rdoc_options: []
 require_paths: