opentelemetry-instrumentation-http 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b26732c1377859a8826f9ab1dfd0979bf15b7b19a2eefd13814713e4fdb0da4
-  data.tar.gz: 50b5a3d8cc28a8b6b15ef0a034188151682fba452955dd6a9250d935f6d4002f
+  metadata.gz: 7520e68ea064b0f26bd7b375c3570cc3bce18d049afc55fa3ceb01595bda8393
+  data.tar.gz: 7d7a46cdbeb076c0aace30742d8800754c2badfb379b36602f83a6d3a262b145
 SHA512:
-  metadata.gz: c5640a46cd6533b483f7a57250266d713dd56e65b7d013f2ebbff75ad7ecb1d7d7ed35d3dbeda4378b29c6d706603a51f5e087c09c1c8cd9f74f588667f2bd69
-  data.tar.gz: e2009128b0b3429fb866ee14ae7aa7fc23e9feca29f1f65f77d54dbe769bdb5f14b8be125a9388bdf97373aea8838a83f3f26ed48e289732ac5f60fc8107ec31
+  metadata.gz: 15b98fc0bb58a37e67d04bc8d8984c4a39ec1fb71f3df5d8a74d572bf5fa41ccffafdbd291b2362a1273c7358a5fa1cfa5da29cfb8c074a19d39b48b5a13f565
+  data.tar.gz: 4b8f049396a292cb47cdd276a7d1dfae09ea90c6031029d4aebbadcc0d697662b25fa7045af9994f2babd3d8b32c52602a2a284520ccc0979f74a47a4454e93b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-http
 
+### v0.23.0 / 2023-05-15
+
+* ADDED: Add span_preprocessor hook 
+
 ### v0.22.0 / 2023-04-17
 
 * BREAKING CHANGE: Drop support for EoL Ruby 2.7 

data/README.md

@@ -30,6 +30,18 @@ OpenTelemetry::SDK.configure do |c|
 end
 ```
 
+## Enriching http span names
+
+We surface a hook to easily rename your span.
+
+The lambda accepts as arguments (request_method, request_path) and returns a string that is set as the span name.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Rack', { span_name_formatter: ->(request_method, request_path) { "HTTP #{request_method} #{request_path}" }
+end
+```
+
 ## Examples
 
 Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/http/example/trace_demonstration.rb)

data/lib/opentelemetry/instrumentation/http/instrumentation.rb

@@ -18,6 +18,8 @@ module OpenTelemetry
           !(defined?(::HTTP::Client).nil? || defined?(::HTTP::Connection).nil?)
         end
 
+        option :span_name_formatter, default: nil, validate: :callable
+
         def patch
           ::HTTP::Client.prepend(Patches::Client)
           ::HTTP::Connection.prepend(Patches::Connection)

data/lib/opentelemetry/instrumentation/http/patches/client.rb

@@ -13,6 +13,7 @@ module OpenTelemetry
           def perform(req, options)
             uri = req.uri
             request_method = req.verb.to_s.upcase
+            span_name = create_request_span_name(request_method, uri.path)
 
             attributes = {
               'http.method' => request_method,
@@ -23,7 +24,7 @@ module OpenTelemetry
               'net.peer.port' => uri.port
             }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
 
-            tracer.in_span("HTTP #{request_method}", attributes: attributes, kind: :client) do |span|
+            tracer.in_span(span_name, attributes: attributes, kind: :client) do |span|
               OpenTelemetry.propagation.inject(req.headers)
               super.tap do |response|
                 annotate_span_with_response!(span, response)
@@ -33,6 +34,10 @@ module OpenTelemetry
 
           private
 
+          def config
+            OpenTelemetry::Instrumentation::HTTP::Instrumentation.instance.config
+          end
+
           def annotate_span_with_response!(span, response)
             return unless response&.status
 
@@ -41,6 +46,17 @@ module OpenTelemetry
             span.status = OpenTelemetry::Trace::Status.error unless (100..399).include?(status_code.to_i)
           end
 
+          def create_request_span_name(request_method, request_path)
+            if (implementation = config[:span_name_formatter])
+              updated_span_name = implementation.call(request_method, request_path)
+              updated_span_name.is_a?(String) ? updated_span_name : "HTTP #{request_method}"
+            else
+              "HTTP #{request_method}"
+            end
+          rescue StandardError
+            "HTTP #{request_method}"
+          end
+
           def tracer
             HTTP::Instrumentation.instance.tracer
           end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module HTTP
-      VERSION = '0.22.0'
+      VERSION = '0.23.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-http
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -242,10 +242,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.22.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.23.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/http
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.22.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.23.0
 post_install_message: 
 rdoc_options: []
 require_paths: