feat(cloudflare): Add R2 bucket auto-instrumentation#21327
Open
JPeer264 wants to merge 2 commits into
Open
Conversation
JPeer264
requested review from
andreiborza and
mydea
and removed request for
a team
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+75
to
+82
| export function isR2Bucket(item: unknown): item is R2Bucket { | ||
| return ( | ||
| item != null && | ||
| isNotJSRPC(item) && | ||
| typeof item.head === 'function' && | ||
| typeof item.put === 'function' && | ||
| typeof item.createMultipartUpload === 'function' | ||
| ); |
Contributor
There was a problem hiding this comment.
Bug: The isR2Bucket function uses fragile duck-typing to detect R2 buckets, which could misidentify other objects and lacks test coverage for validation.
Severity: LOW
Suggested Fix
Add comprehensive unit tests for the isR2Bucket function in isBinding.test.ts. The tests should cover positive and negative cases, including objects that have some but not all of the required methods, to ensure the detection logic is robust and prevent future regressions.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: packages/cloudflare/src/utils/isBinding.ts#L75-L82
Potential issue: The `isR2Bucket` function identifies R2 buckets by checking for the
presence of `head`, `put`, and `createMultipartUpload` methods. This duck-typing
approach is inherently fragile and could lead to false positives. If a different type of
object, such as a custom user object or a future Cloudflare binding, happens to have the
same method names, it would be incorrectly wrapped for R2 instrumentation. This would
not cause a crash but would generate incorrect telemetry spans, which could mislead
debugging efforts. The analysis highlights that this new function lacks any test
coverage in `isBinding.test.ts`, unlike other binding detection functions in the same
file.
Also affects:
packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts:57~62
Did we get this right? 👍 / 👎 to inform future reviews.
Contributor
size-limit report 📦
|
JPeer264
force-pushed
the
jp/cloudflare-r2-instrumentation
branch
from
3605367 to
3671f29
Compare
Contributor
|
👋 @isaacs, @andreiborza — Please review this PR when you get a chance! |
andreiborza
reviewed
Jun 9, 2026
| const requestKey = Array.isArray(key) ? key.join(', ') : typeof key === 'string' ? key : undefined; | ||
|
|
||
| return { | ||
| op: 'cloud.r2', |
Member
There was a problem hiding this comment.
m: This op seems weird, maybe file would make a more meaningful op to mark that these are operations on the "filesystem" (I know it's not 100% applicable as these are objects but seems the closest).
Member
Author
There was a problem hiding this comment.
Maybe cloudflare.r2 fits the best, as it is definitely no file
Edit: I asked internally what we could use the best.
Member
Author
There was a problem hiding this comment.
Now it changed to a proper OP 💯
| ...(requestKey !== undefined && { 'cloudflare.r2.request.key': requestKey }), | ||
| ...(isR2ListOptions(key) && key.prefix !== undefined && { 'cloudflare.r2.request.prefix': key.prefix }), | ||
| ...(isR2ListOptions(key) && key.delimiter !== undefined && { 'cloudflare.r2.request.delimiter': key.delimiter }), | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'cloud.r2', |
Contributor
|
👋 @isaacs — Please review this PR when you get a chance! |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit de254da. Configure here.
JPeer264
force-pushed
the
jp/cloudflare-r2-instrumentation
branch
from
de254da to
e51fed0
Compare
Member
Author
|
Moving to draft as the OP is not yet decided for Also the e2e tests are failing |
JPeer264
force-pushed
the
jp/cloudflare-r2-instrumentation
branch
2 times, most recently
from
03f9066 to
2be24fb
Compare
Auto-detect R2 bucket bindings via duck-typing in instrumentEnv and wrap all operations with spans. Span names and attributes align with Cloudflare's built-in tracing conventions (r2_get, r2_put, etc.). Instrumented methods: get, head, put, delete, list, createMultipartUpload, resumeMultipartUpload, and the resulting multipart upload operations (uploadPart, abort, complete). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
JPeer264
force-pushed
the
jp/cloudflare-r2-instrumentation
branch
from
f5359b8 to
97398f7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #20836
closes JS-2448
This implements R2 spans. All attributes were taken from Cloudflare itself. The only thing which does not exist in Cloudflare and is added here (inspired by AWS S3), is
cloudflare.r2.bucketand gives information of the binding itself.This should be merged after the Sentry conventions PR and the Sentry docs PR (or at least after approval, in case some OPs change)
AI generated text:
Auto-detect R2 bucket bindings via duck-typing in instrumentEnv and wrap all operations with spans. Span names and attributes align with Cloudflare's built-in tracing conventions (r2_get, r2_put, etc.).
Instrumented methods: get, head, put, delete, list, createMultipartUpload, resumeMultipartUpload, and the resulting multipart upload operations (uploadPart, abort, complete).