squash: tests and more docs

Author: arielvalentin

instrumentation/action_pack/README.md

@@ -46,7 +46,7 @@ See the table below for details of what [Rails Framework Hook Events](https://gu
 
 This instrumentation generally uses [HTTP server semantic conventions](https://opentelemetry.io/docs/specs/semconv/http/http-spans/) to update the existing Rack span.
 
-For Rails 7.1+, the span name is updated to match the HTTP method and route that was matched for the request using [`ActionDispath::Request#route_uri_pattern`](https://api.rubyonrails.org/classes/ActionDispatch/Request.html#method-i-route_uri_pattern), e.g.: `GET /users/(:id)`
+For Rails 7.1+, the span name is updated to match the HTTP method and route that was matched for the request using [`ActionDispath::Request#route_uri_pattern`](https://api.rubyonrails.org/classes/ActionDispatch/Request.html#method-i-route_uri_pattern), e.g.: `GET /users/:id`
 
 For older versions of Rails the span name is updated to match the HTTP method, controller, and action name that was the tartget of the request, e.g.: `GET /example/index`
 

instrumentation/action_pack/lib/opentelemetry/instrumentation/action_pack/instrumentation.rb

@@ -20,7 +20,7 @@ module ActionPack
       #
       # Specifies how the span names are set. Can be one of:
       #
-      # - `:semconv` **(default)** - The span name will use HTTP semantic conventions '{method http.route}', for example `GET /users/(:id)`
+      # - `:semconv` **(default)** - The span name will use HTTP semantic conventions '{method http.route}', for example `GET /users/:id`
       # - `:class` - The span name will appear as '<ActionController class name>#<action>',
       #   for example `UsersController#show`.
       #

instrumentation/action_pack/test/opentelemetry/instrumentation/action_pack/handlers/action_controller_test.rb

@@ -142,18 +142,36 @@
   describe 'span naming' do
     describe 'when using the default span_naming configuration' do
       describe 'successful requests' do
-        it 'uses the http method controller and action name' do
-          skip "Rails #{Rails.gem_version} uses ActionDispatch::Request#route_uri_pattern" if Rails.gem_version >= Gem::Version.new('7.1')
-          get '/ok'
+        describe 'Rails Version < 7.1' do
+          it 'uses the http method controller and action name' do
+            skip "Rails #{Rails.gem_version} uses ActionDispatch::Request#route_uri_pattern" if Rails.gem_version >= Gem::Version.new('7.1')
+            get '/ok'
+
+            _(span.name).must_equal 'GET /example/ok'
+          end
+
+          it 'excludes route params' do
+            skip "Rails #{Rails.gem_version} uses ActionDispatch::Request#route_uri_pattern" if Rails.gem_version >= Gem::Version.new('7.1')
+            get '/items/1234'
 
-          _(span.name).must_equal 'GET /example/ok'
+            _(span.name).must_equal 'GET /example/item'
+          end
         end
 
-        it 'uses the Rails route' do
-          skip "Rails #{Rails.gem_version} does not define ActionDispatch::Request#route_uri_pattern" if Rails.gem_version < Gem::Version.new('7.1')
-          get '/ok'
+        describe 'Rails Version >= 7.1' do
+          it 'uses the Rails route' do
+            skip "Rails #{Rails.gem_version} does not define ActionDispatch::Request#route_uri_pattern" if Rails.gem_version < Gem::Version.new('7.1')
+            get '/ok'
+
+            _(span.name).must_equal 'GET /ok'
+          end
+
+          it 'includes route params' do
+            skip "Rails #{Rails.gem_version} does not define ActionDispatch::Request#route_uri_pattern" if Rails.gem_version < Gem::Version.new('7.1')
+            get '/items/1234'
 
-          _(span.name).must_equal 'GET /ok'
+            _(span.name).must_equal 'GET /items/:id'
+          end
         end
       end