Skip to content

docs(caches): Add cache.write and cache.operation to span data spec#17022

Merged
adinauer merged 3 commits intomasterfrom
adinauer/caches-spec-cache-write
Mar 25, 2026
Merged

docs(caches): Add cache.write and cache.operation to span data spec#17022
adinauer merged 3 commits intomasterfrom
adinauer/caches-spec-cache-write

Conversation

@adinauer
Copy link
Copy Markdown
Member

Add cache.write and cache.operation to the Caches module span data spec, and clarify that span operations should use the real method name.

cache.write indicates whether a cache operation resulted in a write to the cache. It reflects the actual outcome for conditional operations (e.g. putIfAbsent, replace) and is always true for unconditional writes. This is now set by the sentry-java SDK across its Spring Cache and JCache integrations.

cache.operation captures the specific cache method name, which is useful when SDKs use more granular span operations than the four base ops defined here.

The span operations section now notes that cache.<methodName> is the intended format, with the table serving as common examples rather than an exhaustive list.

Also fixes a typo: "sepreated" → "separated".

Add cache.write (bool) to the required span data table — indicates
whether a write-operation actually modified the cache, reflecting the
actual outcome for conditional operations like putIfAbsent and replace.

Add cache.operation (string) as an optional attribute for SDKs that use
granular span operations beyond the four base ops.

Fix typo: "sepreated" → "separated" in span description section.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 23, 2026 1:56pm
sentry-docs Ready Ready Preview, Comment Mar 23, 2026 1:56pm

Request Review

Expand cache attributes in span data conventions to match the\ncache module guidance in this PR.\n\nDocument operation, write outcome, success, TTL, and cache peer\nnetwork attributes so SDK teams can implement consistent span data.

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@adinauer adinauer merged commit 3f9b1ab into master Mar 25, 2026
18 checks passed
@adinauer adinauer deleted the adinauer/caches-spec-cache-write branch March 25, 2026 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants