Skip to content

Commit 1545a8d

Browse files
Merge pull request #48211 from jonathanhefner/guide-instrumentation-pseudo-subsections
Add pseudo-subsections to Instrumentation guide [ci-skip]
2 parents dc86d86 + e4fa1c4 commit 1545a8d

File tree

1 file changed

+76
-70
lines changed

1 file changed

+76
-70
lines changed

guides/source/active_support_instrumentation.md

Lines changed: 76 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -102,54 +102,6 @@ Within the Ruby on Rails framework, there are a number of hooks provided for com
102102

103103
### Action Controller
104104

105-
#### `write_fragment.action_controller`
106-
107-
| Key | Value |
108-
| ------ | ---------------- |
109-
| `:key` | The complete key |
110-
111-
```ruby
112-
{
113-
key: 'posts/1-dashboard-view'
114-
}
115-
```
116-
117-
#### `read_fragment.action_controller`
118-
119-
| Key | Value |
120-
| ------ | ---------------- |
121-
| `:key` | The complete key |
122-
123-
```ruby
124-
{
125-
key: 'posts/1-dashboard-view'
126-
}
127-
```
128-
129-
#### `expire_fragment.action_controller`
130-
131-
| Key | Value |
132-
| ------ | ---------------- |
133-
| `:key` | The complete key |
134-
135-
```ruby
136-
{
137-
key: 'posts/1-dashboard-view'
138-
}
139-
```
140-
141-
#### `exist_fragment?.action_controller`
142-
143-
| Key | Value |
144-
| ------ | ---------------- |
145-
| `:key` | The complete key |
146-
147-
```ruby
148-
{
149-
key: 'posts/1-dashboard-view'
150-
}
151-
```
152-
153105
#### `start_processing.action_controller`
154106

155107
| Key | Value |
@@ -255,6 +207,56 @@ Additional keys may be added by the caller.
255207
| `:keys` | The unpermitted keys |
256208
| `:context` | Hash with the following keys: `:controller`, `:action`, `:params`, `:request` |
257209

210+
### Action Controller — Caching
211+
212+
#### `write_fragment.action_controller`
213+
214+
| Key | Value |
215+
| ------ | ---------------- |
216+
| `:key` | The complete key |
217+
218+
```ruby
219+
{
220+
key: 'posts/1-dashboard-view'
221+
}
222+
```
223+
224+
#### `read_fragment.action_controller`
225+
226+
| Key | Value |
227+
| ------ | ---------------- |
228+
| `:key` | The complete key |
229+
230+
```ruby
231+
{
232+
key: 'posts/1-dashboard-view'
233+
}
234+
```
235+
236+
#### `expire_fragment.action_controller`
237+
238+
| Key | Value |
239+
| ------ | ---------------- |
240+
| `:key` | The complete key |
241+
242+
```ruby
243+
{
244+
key: 'posts/1-dashboard-view'
245+
}
246+
```
247+
248+
#### `exist_fragment?.action_controller`
249+
250+
| Key | Value |
251+
| ------ | ---------------- |
252+
| `:key` | The complete key |
253+
254+
```ruby
255+
{
256+
key: 'posts/1-dashboard-view'
257+
}
258+
```
259+
258260
### Action Dispatch
259261

260262
#### `process_middleware.action_dispatch`
@@ -441,7 +443,7 @@ This event is only emitted when [`config.active_record.action_on_strict_loading_
441443
}
442444
```
443445

444-
### Active Support
446+
### Active Support — Caching
445447

446448
#### `cache_read.active_support`
447449

@@ -644,6 +646,15 @@ This event is only emitted when using [`MemoryStore`][ActiveSupport::Cache::Memo
644646
}
645647
```
646648

649+
[ActiveSupport::Cache::FileStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/FileStore.html
650+
[ActiveSupport::Cache::MemCacheStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/MemCacheStore.html
651+
[ActiveSupport::Cache::MemoryStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html
652+
[ActiveSupport::Cache::RedisCacheStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/RedisCacheStore.html
653+
[ActiveSupport::Cache::Store#fetch]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch
654+
[ActiveSupport::Cache::Store#fetch_multi]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch_multi
655+
656+
### Active Support — Messages
657+
647658
#### `message_serializer_fallback.active_support`
648659

649660
| Key | Value |
@@ -662,13 +673,6 @@ This event is only emitted when using [`MemoryStore`][ActiveSupport::Cache::Memo
662673
}
663674
```
664675

665-
[ActiveSupport::Cache::FileStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/FileStore.html
666-
[ActiveSupport::Cache::MemCacheStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/MemCacheStore.html
667-
[ActiveSupport::Cache::MemoryStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html
668-
[ActiveSupport::Cache::RedisCacheStore]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/RedisCacheStore.html
669-
[ActiveSupport::Cache::Store#fetch]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch
670-
[ActiveSupport::Cache::Store#fetch_multi]: https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch_multi
671-
672676
### Active Job
673677

674678
#### `enqueue_at.active_job`
@@ -772,6 +776,22 @@ This event is only emitted when using [`MemoryStore`][ActiveSupport::Cache::Memo
772776

773777
### Active Storage
774778

779+
#### `preview.active_storage`
780+
781+
| Key | Value |
782+
| ------------ | ------------------- |
783+
| `:key` | Secure token |
784+
785+
#### `transform.active_storage`
786+
787+
#### `analyze.active_storage`
788+
789+
| Key | Value |
790+
| ------------ | ------------------------------ |
791+
| `:analyzer` | Name of analyzer e.g., ffprobe |
792+
793+
### Active Storage — Storage Service
794+
775795
#### `service_upload.active_storage`
776796

777797
| Key | Value |
@@ -843,20 +863,6 @@ This event is only emitted when using the Google Cloud Storage service.
843863
| `:content_type` | HTTP `Content-Type` field |
844864
| `:disposition` | HTTP `Content-Disposition` field |
845865

846-
#### `preview.active_storage`
847-
848-
| Key | Value |
849-
| ------------ | ------------------- |
850-
| `:key` | Secure token |
851-
852-
#### `transform.active_storage`
853-
854-
#### `analyze.active_storage`
855-
856-
| Key | Value |
857-
| ------------ | ------------------------------ |
858-
| `:analyzer` | Name of analyzer e.g., ffprobe |
859-
860866
### Action Mailbox
861867

862868
#### `process.action_mailbox`

0 commit comments

Comments
 (0)