opentelemetry-instrumentation-action_mailer 0.8.0 → 0.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +29 -0
- data/lib/opentelemetry/instrumentation/action_mailer/version.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5abf1bf8555a66c613ca8c7fae22e0ede917732d116abe5c0ddcbe00dc012630
|
|
4
|
+
data.tar.gz: c64224779e91c1c85ea9a77754bcf55c5d49d7ef5a7c769171f2ada8182050ef
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b262bb650c026af8e75a6c971e446d5196c2a72c8bf5afd7e3dde4114af4d629a16cce940b156bf10fb6f6948a9d0e65894d4b0a4a4dcc758c033019b1cc74ca
|
|
7
|
+
data.tar.gz: abf0f194b0f7d030958761181536e2dbc9b98399a892ddcfc8c958ef73d2bb6954665c6c5d93dcc77d95ed01a8b986987ca0463c17546bfa2adc515f68b22553
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# Release History: opentelemetry-instrumentation-action_mailer
|
|
2
2
|
|
|
3
|
+
## v0.8.1 / 2026-06-02
|
|
4
|
+
|
|
5
|
+
- DOCS: Document payload-key and payload-transform options in action_mailer and active_storage READMEs (#2363)
|
|
6
|
+
|
|
3
7
|
## v0.8.0 / 2026-04-28
|
|
4
8
|
|
|
5
9
|
- BREAKING CHANGE: Min Rails 7.1 (enforced this time) (#2283)
|
data/README.md
CHANGED
|
@@ -36,6 +36,35 @@ OpenTelemetry::SDK.configure do |c|
|
|
|
36
36
|
end
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
## Configuration Options
|
|
40
|
+
|
|
41
|
+
The instrumentation supports the following configuration options:
|
|
42
|
+
|
|
43
|
+
- **`disallowed_notification_payload_keys`:** Array of keys excluded from the `deliver.action_mailer` notification payload before they are recorded as span attributes. Keys are matched against the payload after the ECS-style transform documented under [Semantic Conventions](#semantic-conventions), so use the transformed names (e.g. `email.to.address`).
|
|
44
|
+
- Default: `[]`
|
|
45
|
+
- **`disallowed_process_payload_keys`:** Array of keys excluded from the `process.action_mailer` notification payload before they are recorded as span attributes.
|
|
46
|
+
- Default: `[]`
|
|
47
|
+
- **`notification_payload_transform`:** Custom `proc` used to extract span attributes from the `deliver.action_mailer` notification payload. The proc receives the payload after the built-in ECS-style transform has been applied and must return a `Hash`. Use this to rename keys, extract nested values, or perform any other custom logic.
|
|
48
|
+
- Default: `nil`
|
|
49
|
+
- **`process_payload_transform`:** Custom `proc` used to extract span attributes from the `process.action_mailer` notification payload. Must return a `Hash`.
|
|
50
|
+
- Default: `nil`
|
|
51
|
+
- **`email_address`:** Whether to include email addresses (`email.to.address`, `email.from.address`, `email.cc.address`, `email.bcc.address`) as span attributes. Valid values are `:omit` and `:include`. When set to `:omit`, these keys are appended to `disallowed_notification_payload_keys`.
|
|
52
|
+
- Default: `:omit`
|
|
53
|
+
|
|
54
|
+
Example with all options set:
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
OpenTelemetry::SDK.configure do |c|
|
|
58
|
+
c.use 'OpenTelemetry::Instrumentation::ActionMailer', {
|
|
59
|
+
disallowed_notification_payload_keys: ['email.subject'],
|
|
60
|
+
disallowed_process_payload_keys: ['args'],
|
|
61
|
+
notification_payload_transform: ->(payload) { payload.merge('email.tenant' => payload['email.x_mailer']) },
|
|
62
|
+
process_payload_transform: ->(payload) { payload },
|
|
63
|
+
email_address: :include,
|
|
64
|
+
}
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
39
68
|
## Active Support Instrumentation
|
|
40
69
|
|
|
41
70
|
This instrumentation relies entirely on `ActiveSupport::Notifications` and registers a custom Subscriber that listens to relevant events to report as spans.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: opentelemetry-instrumentation-action_mailer
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.8.
|
|
4
|
+
version: 0.8.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenTelemetry Authors
|
|
@@ -44,10 +44,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
|
|
|
44
44
|
licenses:
|
|
45
45
|
- Apache-2.0
|
|
46
46
|
metadata:
|
|
47
|
-
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.8.
|
|
48
|
-
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-action_mailer/v0.8.
|
|
47
|
+
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.8.1/file/CHANGELOG.md
|
|
48
|
+
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-action_mailer/v0.8.1/instrumentation/action_mailer
|
|
49
49
|
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
|
|
50
|
-
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.8.
|
|
50
|
+
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_mailer/0.8.1
|
|
51
51
|
rdoc_options: []
|
|
52
52
|
require_paths:
|
|
53
53
|
- lib
|
|
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
62
62
|
- !ruby/object:Gem::Version
|
|
63
63
|
version: '0'
|
|
64
64
|
requirements: []
|
|
65
|
-
rubygems_version: 4.0.
|
|
65
|
+
rubygems_version: 4.0.10
|
|
66
66
|
specification_version: 4
|
|
67
67
|
summary: ActionMailer instrumentation for the OpenTelemetry framework
|
|
68
68
|
test_files: []
|