opentelemetry-instrumentation-action_mailer 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3ef9c8a18527a671299d41be95a48d7f833336f9aa8287d1997cd1ffeb2731
-  data.tar.gz: ea5c33c527501de18ccc1d60664d160caffa778da961bfbf0be1a6aebd9014f6
+  metadata.gz: 4527d53916f5a801016ad1fc3ba838f295999d842beb8cd34f55ef19aa3c8fd6
+  data.tar.gz: 107e82bd30819e1d7c4806ddbd18389e3239c81fd29254c44ed80ba429eeb9d8
 SHA512:
-  metadata.gz: 649c4d315736660cf0f79d1fa68496f93f1056be6c7c0c51a3f8968d05145935bbb40b3b95d9142da51add1e79d1291c428f1860f53d53828d77182a46990898
-  data.tar.gz: 68da2cd0d4ae9e9003d483f87e3d9629d8a4222cd98f89047c07d72ec2d62dad70c75915d359a6d1f0568310d149d2e439a3b5d1d031055f25a64a5614fce331
+  metadata.gz: f5aaa610dd35ac258f2637e45f200f3d918bc780b954678a86c693b9f496f887dbe9bfe48ab922fb6c6f6330e81909e892c23aaffaba3077ed2e6f2be81c61e1
+  data.tar.gz: f1896f1e118f7050d4cbe92aec92d1f2ea467d4b2b7bb54943b8b40311e19247974f986808371e2569db9b8900742ea96d91a710af301fa57e31f29742363a11

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-action_mailer
 
+### v0.3.0 / 2024-12-19
+
+* ADDED: Upgrade ActiveSupport Instrumentation 0.7.0
+
+### v0.2.0 / 2024-10-22
+
+* ADDED: Subscribe to process.action_mailer notifications
+
 ### v0.1.0 / 2024-05-13
 
 Initial release.

data/README.md

@@ -21,7 +21,7 @@ To use the instrumentation, call `use` with the name of the instrumentation:
 
 ```ruby
 OpenTelemetry::SDK.configure do |c|
-  # Use only the ActionMailer instrumentation 
+  # Use only the ActionMailer instrumentation
   c.use 'OpenTelemetry::Instrumentation::ActionMailer'
   # Use the ActionMailer instrumentation along with the rest of the Rails-related instrumentation
   c.use 'OpenTelemetry::Instrumentation::Rails'
@@ -44,12 +44,13 @@ See the table below for details of what [Rails Framework Hook Events](https://gu
 
 | Event Name | Creates Span? | Notes |
 | - | - | - |
-| `deliver.action_mailer` | :white_check_mark: | Creates an span with kind `internal` and email content and status|
-| `process.action_mailer` | :x: | Lack of useful info so ignored |
+| `deliver.action_mailer` | :white_check_mark: | Creates a span with kind `internal` and email content and status |
+| `process.action_mailer` | :white_check_mark: | Creates a span with kind `internal` that will include email rendering spans |
 
 ### Options
 
 ActionMailer instrumentation doesn't expose email addresses by default, but if email addresses are needed, simply use `:email_address` option:
+
 ```ruby
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::ActionMailer', { email_address: :include }
@@ -57,6 +58,7 @@ end
 ```
 
 If only want to hide certain attributes from the notifications payload for email address:
+
 ```ruby
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::ActionMailer', { email_address: :include, disallowed_notification_payload_keys: ['email.to.address'] }
@@ -65,9 +67,9 @@ end
 
 ## Semantic Conventions
 
-Internal spans are named using the name of the `ActiveSupport` event that was provided (e.g. `action_mailer deliver`).
+Internal spans are named using the name of the `ActiveSupport` event that was provided (e.g. `deliver.action_mailer`).
 
-The following attributes from the notification payload for the `deliver.action_mailer` event are attached to `action_mailer deliver` spans:
+### Attributes attached to the `deliver.action_mailer` event payload
 
 | Attribute Name | Type | Notes |
 | - | - | - |
@@ -77,17 +79,25 @@ The following attributes from the notification payload for the `deliver.action_m
 | `email.to.address` | Array | Receiver for mail (omit by default, include when `email_address` set to `:include`) |
 | `email.from.address` | Array | Sender for mail (omit by default, include when `email_address` set to `:include`) |
 | `email.cc.address` | Array | mail CC (omit by default, include when `email_address` set to `:include`) |
-| `email.bcc.address` | Array | mail BCC (omit by default, include when `email_address` set to `:include`)  |
+| `email.bcc.address` | Array | mail BCC (omit by default, include when `email_address` set to `:include`) |
+
+### Attributes attached to the `process.action_mailer` event payload
+
+| Attribute Name | Type | Notes |
+| - | - | - |
+| `mailer` | String | Mailer class that is used to render the mail |
+| `action` | String | Method from the mailer class called to render the mail |
+| `args` | Array | Arguments passed to the method to render the email |
+
 ## Examples
 
 Example usage can be seen in the `./example/trace_request_demonstration.ru` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_mailer/example/trace_request_demonstration.ru)
 
-
 ## How can I get involved?
 
 The `opentelemetry-instrumentation-action_mailer` gem source is [on GitHub][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -99,4 +109,5 @@ The `opentelemetry-instrumentation-action_mailer` gem is distributed under the A
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/instrumentation/action_mailer/instrumentation.rb

@@ -7,7 +7,53 @@
 module OpenTelemetry
   module Instrumentation
     module ActionMailer
-      # The Instrumentation class contains logic to detect and install the ActionMailer instrumentation
+      # The {OpenTelemetry::Instrumentation::ActionMailer::Instrumentation} class contains logic to detect and install the ActionMailer 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 `deliver.action_mailer` notification payload as span attributes.
+      #
+      # ### `:disallowed_process_payload_keys`
+      #
+      # Specifies an array of keys that should be excluded from the `process.action_mailer` notification payload as span attributes.
+      #
+      # ### `:notification_payload_transform`
+      #
+      # - `proc` **default** `nil`
+      #
+      # Specifies custom proc used to extract span attributes form the `deliver.action_mailer` notification payload. Use this to rename keys, extract nested values, or perform any other custom logic.
+      #
+      # ### `:process_payload_transform`
+      #
+      # - `proc` **default** `nil`
+      #
+      # Specifies custom proc used to extract span attributes form the `process.action_mailer` notification payload. Use this to rename keys, extract nested values, or perform any other custom logic.
+      #
+      # ### `:email_address`
+      #
+      # - `symbol` **default** `:omit`
+      #
+      # Specifies whether to include email addresses in the notification payload. Valid values are `:omit` and `:include`.
+      #
+      # @example An explicit default configuration
+      #   OpenTelemetry::SDK.configure do |c|
+      #     c.use_all({
+      #       'OpenTelemetry::Instrumentation::ActionMailer' => {
+      #         disallowed_notification_payload_keys: [],
+      #         disallowed_process_payload_keys: [],
+      #         notification_payload_transform: nil,
+      #         process_payload_transform: nil,
+      #         email_address: :omit,
+      #       },
+      #     })
+      #   end
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         MINIMUM_VERSION = Gem::Version.new('6.1.0')
         EMAIL_ATTRIBUTE = %w[email.to.address email.from.address email.cc.address email.bcc.address].freeze
@@ -27,7 +73,9 @@ module OpenTelemetry
         end
 
         option :disallowed_notification_payload_keys, default: [], validate: :array
+        option :disallowed_process_payload_keys,      default: [], validate: :array
         option :notification_payload_transform,       default: nil, validate: :callable
+        option :process_payload_transform,            default: nil, validate: :callable
         option :email_address,                        default: :omit, validate: %I[omit include]
 
         private

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

@@ -7,24 +7,39 @@
 module OpenTelemetry
   module Instrumentation
     module ActionMailer
-      SUBSCRIPTIONS = %w[
-        deliver.action_mailer
-      ].freeze
+      DELIVER_SUBSCRIPTION = 'deliver.action_mailer'
+      PROCESS_SUBSCRIPTION = 'process.action_mailer'
 
       # This Railtie sets up subscriptions to relevant ActionMailer notifications
       class Railtie < ::Rails::Railtie
         config.after_initialize do
           ::OpenTelemetry::Instrumentation::ActiveSupport::Instrumentation.instance.install({})
+          subscribe_to_deliver
+          subscribe_to_process
+        end
 
-          SUBSCRIPTIONS.each do |subscription_name|
-            config = ActionMailer::Instrumentation.instance.config
+        class << self
+          def subscribe_to_deliver
             ::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(
               ActionMailer::Instrumentation.instance.tracer,
-              subscription_name,
+              DELIVER_SUBSCRIPTION,
               config[:notification_payload_transform],
               config[:disallowed_notification_payload_keys]
             )
           end
+
+          def subscribe_to_process
+            ::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(
+              ActionMailer::Instrumentation.instance.tracer,
+              PROCESS_SUBSCRIPTION,
+              config[:process_payload_transform],
+              config[:disallowed_process_payload_keys]
+            )
+          end
+
+          def config
+            ActionMailer::Instrumentation.instance.config
+          end
         end
       end
     end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionMailer
-      VERSION = '0.1.0'
+      VERSION = '0.3.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-action_mailer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 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
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.1
+        version: 1.69.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.1
+        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
@@ -184,14 +184,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
@@ -227,11 +227,11 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.1.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.3.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/action_mailer
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.1.0
-post_install_message: 
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.3.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -247,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: ActionMailer instrumentation for the OpenTelemetry framework
 test_files: []