Skip to content

Commit

Permalink
Document cache_*_multi events [ci-skip]
Browse files Browse the repository at this point in the history
This adds documentation for the `cache_read_multi.active_support`,
`cache_write_multi.active_support`, and `cache_delete_multi.active_support`
events to the Instrumentation guide.
  • Loading branch information
jonathanhefner committed May 6, 2023
1 parent 74e24ae commit d7a562e
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion guides/source/active_support_instrumentation.md
Expand Up @@ -451,7 +451,16 @@ INFO. This event is only emitted when `config.active_record.action_on_strict_loa
| `:key` | Key used in the store |
| `:store` | Name of the store class |
| `:hit` | If this read is a hit |
| `:super_operation` | `:fetch` is added when a read is used with `#fetch` |
| `:super_operation` | `:fetch` is added when a read is done with `#fetch` |

#### cache_read_multi.active_support

| Key | Value |
| ------------------ | --------------------------------------------------------------- |
| `:key` | Keys used in the store |
| `:store` | Name of the store class |
| `:hits` | Keys of cache hits |
| `:super_operation` | `:fetch_multi` is added when a read is done with `#fetch_multi` |

#### cache_generate.active_support

Expand Down Expand Up @@ -505,6 +514,13 @@ INFO. Cache stores may add their own keys
}
```

#### cache_write_multi.active_support

| Key | Value |
| -------- | ------------------------------------ |
| `:key` | Keys and values written to the store |
| `:store` | Name of the store class |

#### cache_delete.active_support

| Key | Value |
Expand All @@ -519,6 +535,13 @@ INFO. Cache stores may add their own keys
}
```

#### cache_delete_multi.active_support

| Key | Value |
| -------- | ----------------------- |
| `:key` | Keys used in the store |
| `:store` | Name of the store class |

#### cache_exist?.active_support

| Key | Value |
Expand Down

0 comments on commit d7a562e

Please sign in to comment.