Merge branch 'main' into 1173-2

Author: arielvalentin

.github/actions/test_gem/action.yml

@@ -95,6 +95,7 @@ runs:
       run: |
         # 💎 Install dependencies and generate appraisals 💎
         bundle install --quiet --jobs=3 --retry=4
+        bundle exec appraisal clean
         bundle exec appraisal generate
       working-directory: "${{ steps.setup.outputs.gem_dir }}"
 

.gitignore

@@ -12,6 +12,7 @@
 
 # Appraisals
 instrumentation/**/gemfiles
+instrumentation/**/tmp/**/*
 
 # Sqlite file for tests
 instrumentation/active_record/db
@@ -26,3 +27,4 @@ instrumentation/active_record/db
 .ruby-version
 
 tags
+!**/*/.gitkeep

Gemfile

@@ -7,5 +7,5 @@
 source 'https://rubygems.org'
 
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 1.67.0'
+gem 'rubocop', '~> 1.68.0'
 gem 'rubocop-performance', '~> 1.21.0'

helpers/mysql/opentelemetry-helpers-mysql.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 1.67.0'
+  spec.add_development_dependency 'rubocop', '~> 1.68.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.22.0'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
   spec.add_development_dependency 'yard', '~> 0.9'

helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 1.67.0'
+  spec.add_development_dependency 'rubocop', '~> 1.68.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.22.0'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yard-doctest', '~> 0.1.6'

instrumentation/action_mailer/Appraisals

@@ -4,20 +4,20 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-appraise 'rails-6.1' do
-  gem 'rails', '~> 6.1.0'
-end
-
-appraise 'rails-7.0' do
-  gem 'rails', '~> 7.0.0'
-end
-
-appraise 'rails-7.1' do
-  gem 'rails', '~> 7.1.0'
+%w[6.1.0 7.0.0 7.1.0].each do |version|
+  appraise "action_mailer-#{version}" do
+    gem 'rails', "~> #{version}"
+  end
 end
 
 if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.1.0')
-  appraise 'rails-7.2' do
-    gem 'rails', '~> 7.2.0'
+  %w[7.2.0].each do |version|
+    appraise "action_mailer-#{version}" do
+      gem 'rails', "~> #{version}"
+    end
+  end
+
+  appraise 'action_mailer-latest' do
+    gem 'rails'
   end
 end

instrumentation/action_mailer/opentelemetry-instrumentation-action_mailer.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'opentelemetry-sdk', '~> 1.1'
   spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 1.67.0'
+  spec.add_development_dependency 'rubocop', '~> 1.68.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.22.0'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'webmock', '~> 3.24.0'

instrumentation/action_pack/Appraisals

@@ -4,20 +4,20 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-appraise 'rails-6.1' do
-  gem 'rails', '~> 6.1.0'
-end
-
-appraise 'rails-7.0' do
-  gem 'rails', '~> 7.0.0'
-end
-
-appraise 'rails-7.1' do
-  gem 'rails', '~> 7.1.0'
+%w[6.1.0 7.0.0 7.1.0].each do |version|
+  appraise "rails-#{version}" do
+    gem 'rails', "~> #{version}"
+  end
 end
 
 if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.1.0')
-  appraise 'rails-7.2' do
-    gem 'rails', '~> 7.2.0'
+  %w[7.2.0].each do |version|
+    appraise "rails-#{version}" do
+      gem 'rails', "~> #{version}"
+    end
+  end
+
+  appraise 'rails-latest' do
+    gem 'rails'
   end
 end

instrumentation/action_pack/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-action_pack
 
+### v0.10.0 / 2024-11-19
+
+* ADDED: Use Semconv Naming For ActionPack
+
 ### v0.9.0 / 2024-01-09
 
 * BREAKING CHANGE: Use ActiveSupport instead of patches #703 

instrumentation/action_pack/README.md

@@ -42,6 +42,25 @@ See the table below for details of what [Rails Framework Hook Events](https://gu
 | - | - | - | - |
 | `process_action.action_controller` | :white_check_mark: | :x: | It modifies the existing Rack span |
 
+## Semantic Conventions
+
+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 [`ActionDispatch::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 target of the request, e.g.: `GET /example/index`
+
+> ![NOTE]: Users may override the `span_naming` option to default to Legacy Span Naming Behavior that uses the controller's class name and action in Ruby documentation syntax, e.g. `ExampleController#index`.
+
+This instrumentation does not emit any custom attributes.
+
+| Attribute Name | Type | Notes |
+| - | - | - |
+| `code.namespace` | String | `ActionController` class name |
+| `code.function` | String | `ActionController` action name e.g. `index`, `show`, `edit`, etc... |
+| `http.route` | String | (Rails 7.1+) the route that was matched for the request |
+| `http.target` | String | The `request.filtered_path` |
+
 ### Error Handling for Action Controller
 
 If an error is triggered by Action Controller (such as a 500 internal server error), Action Pack will typically employ the default `ActionDispatch::PublicExceptions.new(Rails.public_path)` as the `exceptions_app`, as detailed in the [documentation](https://guides.rubyonrails.org/configuring.html#config-exceptions-app).