opentelemetry-instrumentation-action_view 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c28d3572241854eb29990aa3dd9462faf0bf5d736d639399df7d80cc70e6cfdf
-  data.tar.gz: b6853f4f4dad332b8a1173e82d0e7b3351b9ed4fde3d5f4eda1b1c1644da52bd
+  metadata.gz: 4d3aeb6c0f99654a367f37b01a05f7648cf20ef7cdd9f71b4e285767e991c9bc
+  data.tar.gz: 042d30047de7ae8d7cdf413611511dcbc1aa641e42787031a08d4f960f81f523
 SHA512:
-  metadata.gz: 47c676cc5239ca45eeafd97d1b063620efb62e4230ed5e556798b53a29245cd567eefb5a730874af8caca5ecc289acb94e7c4e4fa62b4dcbb2621aae0ab56eb0
-  data.tar.gz: ac9a11a474b52cd84835a3cc921166e2c92428a5b8cce0958362f49f1fb8c4ce16a5ffe02f0b992233b04db04d00e9efa24d2bcf21d71630da2586cdf1a5816d
+  metadata.gz: 156a893b085d431258c8c6905731955c69153968acded76b9ed513af5630abb5d95e0804f7fcf876219d9a663b807abf7a9d691ad91148fc6329b521e7ddb475
+  data.tar.gz: fcec2ec5c33491b610ff9dae18c707cdabb4bf7c111baea2cd5aa8d3a49f1622e548feba216a205b5c361985d8f7dbe16fd52b5806c1c0c6e25e7b3542b5e47a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-action_view
 
+### v0.8.0 / 2024-12-19
+
+* ADDED: Upgrade ActiveSupport Instrumentation 0.7.0
+
+### v0.7.3 / 2024-08-23
+
+* FIXED: ActionView Support Legacy Formats
+
 ### v0.7.2 / 2024-08-15
 
 * (No Significant Changes)
@@ -20,43 +28,43 @@
 
 ### v0.6.0 / 2023-06-05
 
-* ADDED: Render layout for action view 
-* FIXED: Base config options 
+* ADDED: Render layout for action view
+* FIXED: Base config options
 
 ### v0.5.0 / 2023-04-17
 
-* BREAKING CHANGE: Drop support for EoL Ruby 2.7 
+* BREAKING CHANGE: Drop support for EoL Ruby 2.7
 
-* ADDED: Drop support for EoL Ruby 2.7 
+* ADDED: Drop support for EoL Ruby 2.7
 
 ### v0.4.0 / 2023-02-01
 
-* BREAKING CHANGE: Drop Rails 5 Support 
+* BREAKING CHANGE: Drop Rails 5 Support
 
-* ADDED: Drop Rails 5 Support 
+* ADDED: Drop Rails 5 Support
 
 ### v0.3.1 / 2023-01-14
 
-* DOCS: Fix gem homepage 
-* DOCS: More gem documentation fixes 
+* DOCS: Fix gem homepage
+* DOCS: More gem documentation fixes
 
 ### v0.3.0 / 2022-06-09
 
 * Upgrading Base dependency version
-* FIXED: Broken test file requirements 
+* FIXED: Broken test file requirements
 
 ### v0.2.1 / 2022-05-02
 
-* FIXED: RubyGems Fallback 
+* FIXED: RubyGems Fallback
 
 ### v0.2.0 / 2021-12-01
 
-* ADDED: Move activesupport notification subscriber out of action_view gem 
-* FIXED: Instrumentation of Rails 7 
+* ADDED: Move activesupport notification subscriber out of action_view gem
+* FIXED: Instrumentation of Rails 7
 
 ### v0.1.3 / 2021-10-06
 
-* FIXED: Do not replace fanout 
+* FIXED: Do not replace fanout
 
 ### v0.1.2 / 2021-09-29
 
@@ -64,7 +72,7 @@
 
 ### v0.1.1 / 2021-09-09
 
-* FIXED: Keep Active Support subscriptions intact when patching 
+* FIXED: Keep Active Support subscriptions intact when patching
 
 ### v0.1.0 / 2021-08-12
 

data/lib/opentelemetry/instrumentation/action_view/instrumentation.rb

@@ -7,7 +7,42 @@
 module OpenTelemetry
   module Instrumentation
     module ActionView
-      # The Instrumentation class contains logic to detect and install the ActionView instrumentation
+      # The {OpenTelemetry::Instrumentation::ActionView::Instrumentation} class contains logic to detect and install the ActionView 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
+      #
+      # ### `:disallowed_notification_payload_keys`
+      #
+      # Specifies an array of keys that should be excluded from the notification payload as span attributes.
+      #
+      # ### `:notification_payload_transform`
+      #
+      # - `proc` **default** `nil`
+      #
+      # Specifies custom proc used to extract span attributes form the notification payload.
+      # Use this to rename keys, extract nested values, or perform any other custom logic.
+      #
+      # ### `:legacy_span_names`
+      #
+      # - `boolean`  **default** `false`
+      #
+      # Specifies whether spans names should use the legacy format where the subscription was reverse ordered and white space separated. (Ex. `action_view render_template`)
+      # If set to `true`, the span name will match the name of the notification itself. (Ex. `render_template.action_view`)
+      #
+      # @example An explicit default configuration
+      #   OpenTelemetry::SDK.configure do |c|
+      #     c.use_all({
+      #       'OpenTelemetry::Instrumentation::ActionView' => {
+      #         disallowed_notification_payload_keys: [],
+      #         legacy_span_names: true,
+      #       },
+      #     })
+      #   end
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         MINIMUM_VERSION = Gem::Version.new('6.1.0')
         install do |_config|
@@ -24,6 +59,7 @@ module OpenTelemetry
 
         option :disallowed_notification_payload_keys, default: [],  validate: :array
         option :notification_payload_transform,       default: nil, validate: :callable
+        option :legacy_span_names,                    default: false, validate: :boolean
 
         private
 

data/lib/opentelemetry/instrumentation/action_view/railtie.rb

@@ -19,13 +19,16 @@ module OpenTelemetry
         config.after_initialize do
           ::OpenTelemetry::Instrumentation::ActiveSupport::Instrumentation.instance.install({})
 
+          instance = ::OpenTelemetry::Instrumentation::ActionView::Instrumentation.instance
+          span_name_formatter = instance.config[:legacy_span_names] ? ::OpenTelemetry::Instrumentation::ActiveSupport::LEGACY_NAME_FORMATTER : nil
+
           SUBSCRIPTIONS.each do |subscription_name|
-            config = ActionView::Instrumentation.instance.config
             ::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(
-              ActionView::Instrumentation.instance.tracer,
+              instance.tracer,
               subscription_name,
-              config[:notification_payload_transform],
-              config[:disallowed_notification_payload_keys]
+              instance.config[:notification_payload_transform],
+              instance.config[:disallowed_notification_payload_keys],
+              span_name_formatter: span_name_formatter
             )
           end
         end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionView
-      VERSION = '0.7.2'
+      VERSION = '0.8.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/action_view.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-action_view
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
@@ -156,28 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.65.0
+        version: 1.69.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.65.0
+        version: 1.69.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.19'
+        version: 3.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.19'
+        version: 3.24.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -241,11 +241,11 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.7.2/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.8.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/action_view
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.7.2
-post_install_message: 
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.8.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: ActionView instrumentation for the OpenTelemetry framework
 test_files: []