Skip to content

Commit

Permalink
Update caches.mdx (#1289)
Browse files Browse the repository at this point in the history
  • Loading branch information
cleptric committed May 23, 2024
1 parent 5932b5a commit f0c61f9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/docs/sdk/performance/modules/caches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ The SDK's caching integration is agnostic to the underlying engine used. In most
| `cache.remove` | A single item or multiple items are removed from the cache |
| `cache.flush` | The entire content of the cache is deleted |

### Span Description

The description of cache spans should be set to the cache key(s), sepreated by commas, e.g. `posts`, or `article1, article2`.

### Span Data

| Data Key | Type | Description | Conditions
|:--|:--|:--|:--|
| `cache.hit` | bool | cache hit or miss | required only on read-operations (`cache.get`)
| `cache.key ` | array | the key(s) involved in the operation | required only on operations that have a key
| `cache.key` | array | the key(s) involved in the operation | required only on operations that have a key

The following data attributes are only to be set if exposed by the instrumented cache abstraction or retrievable with minimal overhead.

Expand Down

0 comments on commit f0c61f9

Please sign in to comment.