opentelemetry-instrumentation-action_view 0.11.1 → 0.11.2
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 +5 -1
- data/README.md +40 -1
- data/lib/opentelemetry/instrumentation/action_view/version.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e4fa3d44004b75050ad640764079adf59efef06eeed011b76a039e3b767be8e3
|
|
4
|
+
data.tar.gz: e5bbe04a286d23034c1766df5773080553210ffaf6a5a5bdac17dd7f71b0935e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 20a23515af1799c2afb6ef8dfd36b1abc18e030288f6e7c9cc0cf5376e9e8885a47a6b93a9ffa4d93f22078845acda13c9842012e7b30acb3b0cb1c0c529d4de
|
|
7
|
+
data.tar.gz: ba4e3164028899726f0781182136355ec44776237959548645321e8ecf0ed9308d5ad60076039ecfaae5c0d47d4aaa175ffa91432c7cbccc5d909426278fd0fe
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# Release History: opentelemetry-instrumentation-action_view
|
|
2
2
|
|
|
3
|
+
### v0.11.2 / 2026-01-06
|
|
4
|
+
|
|
5
|
+
* DOCS: Update ActionView Documentation
|
|
6
|
+
|
|
3
7
|
### v0.11.1 / 2025-10-22
|
|
4
8
|
|
|
5
9
|
* FIXED: Update opentelemetry-instrumentation-base dependency
|
|
@@ -86,7 +90,7 @@
|
|
|
86
90
|
|
|
87
91
|
### v0.1.3 / 2021-10-06
|
|
88
92
|
|
|
89
|
-
* FIXED: Do not replace
|
|
93
|
+
* FIXED: Do not replace fan-out
|
|
90
94
|
|
|
91
95
|
### v0.1.2 / 2021-09-29
|
|
92
96
|
|
data/README.md
CHANGED
|
@@ -32,6 +32,45 @@ OpenTelemetry::SDK.configure do |c|
|
|
|
32
32
|
end
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
+
## Configuration Options
|
|
36
|
+
|
|
37
|
+
The instrumentation supports the following configuration options:
|
|
38
|
+
|
|
39
|
+
- **disallowed_notification_payload_keys:** Specifies an array of keys that should be excluded from the notification payload as span attributes.
|
|
40
|
+
- Default: `[]`
|
|
41
|
+
- **notification_payload_transform:** Specifies custom proc used to extract span attributes from the notification payload. Use this to rename keys, extract nested values, or perform any other custom logic.
|
|
42
|
+
- Default: `nil`
|
|
43
|
+
- **legacy_span_names:** Specifies whether span names should use the legacy format where the subscription was reverse ordered and white space separated (e.g. `action_view render_template`). If set to `false`, the span name will match the name of the notification itself (e.g. `render_template.action_view`).
|
|
44
|
+
- Default: `false`
|
|
45
|
+
|
|
46
|
+
## Active Support Instrumentation
|
|
47
|
+
|
|
48
|
+
This instrumentation relies entirely on `ActiveSupport::Notifications` and registers a custom Subscriber that listens to relevant events to report as spans.
|
|
49
|
+
|
|
50
|
+
See the table below for details of what [Rails Framework Hook Events](https://guides.rubyonrails.org/active_support_instrumentation.html#action-view) are recorded by this instrumentation:
|
|
51
|
+
|
|
52
|
+
| Event Name | Creates Span? | Notes |
|
|
53
|
+
| - | - | - |
|
|
54
|
+
| `render_template.action_view` | :white_check_mark: | Creates a span with kind `internal` |
|
|
55
|
+
| `render_partial.action_view` | :white_check_mark: | Creates a span with kind `internal` |
|
|
56
|
+
| `render_collection.action_view` | :white_check_mark: | Creates a span with kind `internal` |
|
|
57
|
+
| `render_layout.action_view` | :white_check_mark: | Creates a span with kind `internal` |
|
|
58
|
+
|
|
59
|
+
## Semantic Conventions
|
|
60
|
+
|
|
61
|
+
Internal spans are named using the name of the `ActiveSupport` event that was provided (e.g. `render_template.action_view`).
|
|
62
|
+
|
|
63
|
+
The following attributes may be recorded depending on the event type:
|
|
64
|
+
|
|
65
|
+
| Attribute Name | Type | Event(s) | Notes |
|
|
66
|
+
| - | - | - | - |
|
|
67
|
+
| `identifier` | String | All events | Full path to the template, partial, collection, or layout file |
|
|
68
|
+
| `layout` | String | `render_template.action_view` | Name of the layout being used (if applicable) |
|
|
69
|
+
| `count` | Integer | `render_collection.action_view` | Number of items in the collection |
|
|
70
|
+
| `cache_hits` | Integer | `render_collection.action_view` | Number of partials fetched from cache (only included when `cached: true`) |
|
|
71
|
+
|
|
72
|
+
> **Note:** The `locals` hash from the event payloads is not collected as an attribute because complex types like hashes are not supported by the OpenTelemetry specification v1.10.0. Only primitive types (String, Boolean, Numeric) and arrays of primitives are valid attribute values.
|
|
73
|
+
|
|
35
74
|
## Examples
|
|
36
75
|
|
|
37
76
|
Example usage can be seen in the [`./example/trace_request_demonstration.ru` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_view/example/trace_request_demonstration.ru)
|
|
@@ -41,7 +80,7 @@ Example usage can be seen in the [`./example/trace_request_demonstration.ru` fil
|
|
|
41
80
|
ActionView instrumentation uses ActiveSupport notifications and in the case when a subscriber raises in start method an unclosed span would break successive spans ends. Example:
|
|
42
81
|
|
|
43
82
|
```ruby
|
|
44
|
-
class
|
|
83
|
+
class CrashingStartSubscriber
|
|
45
84
|
def start(name, id, payload)
|
|
46
85
|
raise 'boom'
|
|
47
86
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: opentelemetry-instrumentation-action_view
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.11.
|
|
4
|
+
version: 0.11.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenTelemetry Authors
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2026-01-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: opentelemetry-instrumentation-active_support
|
|
@@ -45,10 +45,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
|
|
|
45
45
|
licenses:
|
|
46
46
|
- Apache-2.0
|
|
47
47
|
metadata:
|
|
48
|
-
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.11.
|
|
48
|
+
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.11.2/file/CHANGELOG.md
|
|
49
49
|
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/action_view
|
|
50
50
|
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
|
|
51
|
-
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.11.
|
|
51
|
+
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_view/0.11.2
|
|
52
52
|
post_install_message:
|
|
53
53
|
rdoc_options: []
|
|
54
54
|
require_paths:
|