feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentation

Jul 17, 2026

dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts

-Original file line number
+Diff line change
@@ -0,0 +1,37 @@
+import type { RateLimit } from '@cloudflare/workers-types';
+import * as Sentry from '@sentry/cloudflare';
+interface Env {
+ SENTRY_DSN: string;
+ MY_RATE_LIMITER: RateLimit;
+}
+function json(data: unknown): Response {
+ return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } });
+}
+export default Sentry.withSentry(
+ (env: Env) => ({
+ dsn: env.SENTRY_DSN,
+ tracesSampleRate: 1,
+ }),
+ {
+ async fetch(request, env) {
+ const url = new URL(request.url);
+ if (url.pathname === '/ratelimit/allowed') {
+ const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' });
+ return json(outcome);
+ }
+ if (url.pathname === '/ratelimit/blocked') {
+ // The binding's limit is 1, so the second call within the period is rate limited.
+ await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' });
+ const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' });
+ return json(outcome);
+ }
+ return new Response('not found', { status: 404 });
+ },
+ } as ExportedHandler<Env>,
+);

dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts

-Original file line number
+Diff line change
@@ -0,0 +1,63 @@
+import type { Envelope } from '@sentry/core';
+import { expect, it } from 'vitest';
+import { createRunner } from '../../runner';
+function envelopeItemType(envelope: Envelope): string | undefined {
+ return envelope[1][0]?.[0]?.type as string | undefined;
+}
+function envelopeItem(envelope: Envelope): Record<string, unknown> {
+ return envelope[1][0]![1] as Record<string, unknown>;
+}
+function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> {
+ if (envelopeItemType(envelope) !== 'transaction') return [];
+ const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || [];
+ return spans.filter(
+ s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit',
+ );
+}
+it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => {
+ const runner = createRunner(__dirname)
+ .ignore('event')
+ .expect((envelope: Envelope) => {
+ expect(envelopeItemType(envelope)).toBe('transaction');
+ const event = envelopeItem(envelope);
+ expect(event.spans).toEqual([
+ {
+ data: {
+ 'sentry.origin': 'auto.faas.cloudflare.rate_limit',
+ },
+ description: 'rate_limit MY_RATE_LIMITER',
+ origin: 'auto.faas.cloudflare.rate_limit',
+ parent_span_id: expect.any(String),
+ span_id: expect.any(String),
+ start_timestamp: expect.any(Number),
+ timestamp: expect.any(Number),
+ trace_id: expect.any(String),
+ },
+ ]);
+ })
+ .start(signal);
+ const response = await runner.makeRequest('get', '/ratelimit/allowed');
+ expect(response).toEqual({ success: true });
+ await runner.completed();
+});
+it('instruments a rate-limited call automatically via env', async ({ signal }) => {
+ const runner = createRunner(__dirname)
+ .ignore('event')
+ .expect((envelope: Envelope) => {
+ expect(envelopeItemType(envelope)).toBe('transaction');
+ // Both `limit()` calls on the blocked endpoint are instrumented.
+ expect(findRateLimitSpans(envelope)).toHaveLength(2);
+ })
+ .start(signal);
+ const response = await runner.makeRequest('get', '/ratelimit/blocked');
+ expect(response).toEqual({ success: false });
+ await runner.completed();
+});

dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+{
+ "name": "worker-name",
+ "compatibility_date": "2025-06-17",
+ "main": "index.ts",
+ "compatibility_flags": ["nodejs_als"],
+ "ratelimits": [
+ {
+ "name": "MY_RATE_LIMITER",
+ "namespace_id": "1001",
+ "simple": { "limit": 1, "period": 60 },
+ },
+ ],
+}

packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts

-Original file line number
+Diff line change
@@ -1,13 +1,21 @@
 import { isObjectLike } from '@sentry/core';
 import type { CloudflareOptions } from '../../client';
-import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding';
+import {
+ isD1Database,
+ isDurableObjectNamespace,
+ isJSRPC,
+ isQueue,
+ isR2Bucket,
+ isRateLimit,
+} from '../../utils/isBinding';
 import { instrumentD1 } from './instrumentD1';
 import { appendRpcMeta } from '../../utils/rpcMeta';
 import { getEffectiveRpcPropagation } from '../../utils/rpcOptions';
 import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace';
 import { instrumentFetcher } from './instrumentFetcher';
 import { instrumentQueueProducer } from './instrumentQueueProducer';
 import { instrumentR2Bucket } from './instrumentR2';
+import { instrumentRateLimit } from './instrumentRateLimit';
 function isProxyable(item: unknown): item is object {
  return isObjectLike(item) || typeof item === 'function';
@@ Expand All / @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); @@
  * - Service bindings / JSRPC proxies
  * - Queue producers (via `send` + `sendBatch` duck-typing)
  * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing)
+ * - Rate limiters (via `limit` duck-typing)
  *
  * @param env - The Cloudflare env object to instrument
  * @param options - Optional CloudflareOptions to control RPC trace propagation
@@ Expand DownExpand Up @@
  return instrumented;
  }
+ if (isRateLimit(item)) {
+ const bindingName = typeof prop === 'string' ? prop : String(prop);
+ const instrumented = instrumentRateLimit(item, bindingName);
+ instrumentedBindings.set(item, instrumented);
+ return instrumented;
+ }
  if (!rpcPropagation) {
  return item;
  }
@@ Expand Down @@

packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts

-Original file line number
+Diff line change
@@ -0,0 +1,31 @@
+import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types';
+import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
+const ORIGIN = 'auto.faas.cloudflare.rate_limit';
+/**
+ * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call.
+ */
+export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T {
+ return new Proxy(rateLimit, {
+ get(target, prop, receiver) {
+ if (prop !== 'limit') {
+ return Reflect.get(target, prop, receiver);
+ }
+ const original = Reflect.get(target, prop, receiver) as RateLimit['limit'];
+ return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> {
+ return startSpan(
+ {
+ name: `rate_limit ${bindingName}`,
+ attributes: {
+ [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
+ },
+ },
+ () => Reflect.apply(original, target, [options]),
+ );
+ };
+ },
+ });
+}

packages/cloudflare/src/utils/isBinding.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -31,7 +31,7 @@ @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types';
+import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types';
 /**
  * Checks if a value is a JSRPC proxy (service binding).
@@ Expand DownExpand Up @@
  typeof item.createMultipartUpload === 'function'
  );
 }
+/**
+ * Duck-type check for RateLimit bindings.
+ * RateLimit only exposes a single `limit` method. Because that is a fairly
+ * common method name, this check is intentionally run after the more specific
+ * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding
+ * also happens to expose `limit`.
+ */
+export function isRateLimit(item: unknown): item is RateLimit {
+ return item != null && isNotJSRPC(item) && typeof item.limit === 'function';
+}

packages/cloudflare/test/instrumentations/instrumentEnv.test.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { @@
  expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace);
  });
+ it('wraps RateLimit bindings in a proxy and forwards calls', async () => {
+ const startSpanSpy = vi.spyOn(SentryCore, 'startSpan');
+ const limit = vi.fn().mockResolvedValue({ success: true });
+ const rateLimiter = { limit };
+ const env = { MY_RATE_LIMITER: rateLimiter };
+ const instrumented = instrumentEnv(env);
+ const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter;
+ // Wrapped binding is a Proxy, not the original reference
+ expect(wrapped).not.toBe(rateLimiter);
+ const outcome = await wrapped.limit({ key: 'user-123' });
+ expect(outcome).toEqual({ success: true });
+ expect(limit).toHaveBeenCalledTimes(1);
+ expect(startSpanSpy).toHaveBeenCalledWith(
+ expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }),
+ expect.any(Function),
+ );
+ });
+ it('caches the wrapped RateLimit binding across repeated access', () => {
+ const rateLimiter = { limit: vi.fn() };
+ const env = { MY_RATE_LIMITER: rateLimiter };
+ const instrumented = instrumentEnv(env);
+ expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER);
+ });
  describe('mTLS Fetcher bindings', () => {
  function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) {
  return new Proxy(
@@ Expand Down @@

packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts

-Original file line number
+Diff line change
@@ -0,0 +1,76 @@
+import type { RateLimit } from '@cloudflare/workers-types';
+import * as SentryCore from '@sentry/core';
+import type { MockInstance } from 'vitest';
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
+import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit';
+function createMockRateLimit(success = true): RateLimit {
+ return {
+ limit: vi.fn().mockResolvedValue({ success }),
+ } as unknown as RateLimit;
+}
+describe('instrumentRateLimit', () => {
+ let startSpanSpy: MockInstance;
+ beforeEach(() => {
+ startSpanSpy = vi.spyOn(SentryCore, 'startSpan');
+ });
+ afterEach(() => {
+ vi.restoreAllMocks();
+ });
+ describe('limit', () => {
+ test('forwards the call and returns the outcome', async () => {
+ const rateLimit = createMockRateLimit(true);
+ const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER');
+ const outcome = await wrapped.limit({ key: 'user-123' });
+ expect(outcome).toEqual({ success: true });
+ expect(rateLimit.limit).toHaveBeenCalledTimes(1);
+ expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' });
+ });
+ test('returns an unsuccessful (rate-limited) outcome unchanged', async () => {
+ const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER');
+ const outcome = await wrapped.limit({ key: 'user-123' });
+ expect(outcome).toEqual({ success: false });
+ });
+ test('starts a span with the binding name and origin', async () => {
+ const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER');
+ await wrapped.limit({ key: 'user-123' });
+ expect(startSpanSpy).toHaveBeenCalledTimes(1);
+ expect(startSpanSpy).toHaveBeenLastCalledWith(
+ {
+ name: 'rate_limit MY_RATE_LIMITER',
+ attributes: {
+ 'sentry.origin': 'auto.faas.cloudflare.rate_limit',
+ },
+ },
+ expect.any(Function),
+ );
+ });
+ test('does not record the rate limit key (avoids leaking PII)', async () => {
+ const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER');
+ await wrapped.limit({ key: 'super-secret-user-id' });
+ expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id');
+ });
+ });
+ test('forwards unknown property accesses transparently', () => {
+ const rateLimit = Object.assign(createMockRateLimit(), {
+ customMethod: vi.fn().mockReturnValue('hi'),
+ }) as unknown as RateLimit & { customMethod: () => string };
+ const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string };
+ expect(wrapped.customMethod()).toBe('hi');
+ });
+});

packages/cloudflare/test/utils/isBinding.test.ts

-Original file line number
+Diff line change
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding';
+import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding';
 describe('isJSRPC', () => {
  it('returns false for a plain object', () => {
@@ Expand DownExpand Up / @@ -210,3 +210,34 @@ describe('isD1Database', () => { @@
  expect(isD1Database(jsrpcProxy)).toBe(false);
  });
 });
+describe('isRateLimit', () => {
+ it('returns true for an object with a limit method', () => {
+ expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true);
+ });
+ it('returns false when limit is missing', () => {
+ expect(isRateLimit({ foo: 'bar' })).toBe(false);
+ });
+ it('returns false when limit is not a function', () => {
+ expect(isRateLimit({ limit: 'nope' })).toBe(false);
+ });
+ it('returns false for null and undefined', () => {
+ expect(isRateLimit(null)).toBe(false);
+ expect(isRateLimit(undefined)).toBe(false);
+ });
+ it('returns false for a JSRPC proxy even though it returns a function for limit', () => {
+ const jsrpcProxy = new Proxy(
+ {},
+ {
+ get(_target, _prop) {
+ return () => {};
+ },
+ },
+ );
+ expect(isRateLimit(jsrpcProxy)).toBe(false);
+ });
+});

blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + ' Skip to contentNavigation Menu Sign inAppearance settings AI CODE CREATIONGitHub CopilotWrite better code with AI GitHub Copilot appDirect agents from issue to merge MCP RegistryIntegrate external tools DEVELOPER WORKFLOWSActionsAutomate any workflow CodespacesInstant dev environments IssuesPlan and track work Code ReviewManage code changes Code QualityEnforce quality at merge APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities Code securitySecure your code as you build Secret protectionStop leaks before they start EXPLOREWhy GitHub Documentation Blog Changelog Marketplace View all features BY COMPANY SIZEEnterprises Small and medium teams Startups Nonprofits BY USE CASEApp Modernization DevSecOps DevOps CI/CD View all use cases BY INDUSTRYHealthcare Financial services Manufacturing Government View all industries View all solutions EXPLORE BY TOPICAI Software Development DevOps Security View all topics EXPLORE BY TYPECustomer stories Events & webinars Ebooks & reports Business insights GitHub Skills SUPPORT & SERVICESDocumentation Customer support Community forum Trust center Partners View all resources COMMUNITYGitHub SponsorsFund open source developers PROGRAMSSecurity Lab Maintainer Community GitHub Stars Archive Program REPOSITORIESTopics Trending Collections ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features Copilot for BusinessEnterprise-grade AI features Premium SupportEnterprise-grade 24/7 support Pricing Sign in Sign upAppearance settings You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert Uh oh! There was an error while loading. Please reload this page. getsentry /sentry-javascriptPublic Uh oh! There was an error while loading. Please reload this page. Notifications You must be signed in to change notification settings Fork 1.8k Star 8.7k Code Issues589 Pull requests70 Discussions Actions Security and quality5 Insights Additional navigation options Code Issues Pull requests Discussions Actions Security and quality Insights feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035 New issue Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community. Sign up for GitHub By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails. Already on GitHub? Sign in to your account Merged JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentationJul 17, 2026 Conversation 34 Commits 5 Checks 86 Files changed Uh oh! There was an error while loading. Please reload this page. Merged feat(cloudflare): Instrument Cloudflare rate limiter bindings #22035 Show file tree Hide file tree Changes from all commits Commits Show all changes 5 commits Select commit Hold shift + click to select a range 53a0a03 feat(cloudflare): Instrument Cloudflare rate limiter bindings PeterWadie Jul 8, 2026d2be645 test(cloudflare): Add rate limiter binding integration test PeterWadie Jul 8, 20262504ba9 ref(cloudflare): Address review feedback on rate limiter instrumentation PeterWadie Jul 13, 20260f63dd7 test(cloudflare): Filter rate limiter spans by data['sentry.origin'] PeterWadie Jul 13, 20264a9eb20 Merge branch 'develop' into feat/cloudflare-rate-limit-instrumentation PeterWadie Jul 14, 2026 File filter Filter by extension Filter by extension .jsonc (1) .ts (8) All 2 file types selected Viewed files Clear filters Conversations Failed to load comments. Loading Uh oh! There was an error while loading. Please reload this page. Jump to Jump to file Failed to load files. Loading Uh oh! There was an error while loading. Please reload this page. Diff view Unified Split Hide whitespace Diff view Unified Split Hide whitespace dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts index.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts test.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc wrangler.jsonc packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts instrumentEnv.ts packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts instrumentRateLimit.ts packages/cloudflare/src/utils/isBinding.ts isBinding.ts packages/cloudflare/test/instrumentations/instrumentEnv.test.ts instrumentEnv.test.ts packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts instrumentRateLimit.test.ts packages/cloudflare/test/utils/isBinding.test.ts isBinding.test.ts Some comments aren't visible on the classic Files Changed page. There are no files selected for viewing 37 changes: 37 additions & 0 deletions 37 dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,37 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as Sentry from '@sentry/cloudflare'; interface Env { SENTRY_DSN: string; MY_RATE_LIMITER: RateLimit; } function json(data: unknown): Response { return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } }); } export default Sentry.withSentry( (env: Env) => ({ dsn: env.SENTRY_DSN, tracesSampleRate: 1, }), { async fetch(request, env) { const url = new URL(request.url); if (url.pathname === '/ratelimit/allowed') { const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' }); return json(outcome); } if (url.pathname === '/ratelimit/blocked') { // The binding's limit is 1, so the second call within the period is rate limited. await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); return json(outcome); } return new Response('not found', { status: 404 }); }, } as ExportedHandler<Env>, ); 63 changes: 63 additions & 0 deletions 63 dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,63 @@ import type { Envelope } from '@sentry/core'; import { expect, it } from 'vitest'; import { createRunner } from '../../runner'; function envelopeItemType(envelope: Envelope): string | undefined { return envelope[1][0]?.[0]?.type as string | undefined; } function envelopeItem(envelope: Envelope): Record<string, unknown> { return envelope[1][0]![1] as Record<string, unknown>; } function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> { if (envelopeItemType(envelope) !== 'transaction') return []; const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || []; return spans.filter( s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit', ); } it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); const event = envelopeItem(envelope); expect(event.spans).toEqual([ { data: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, description: 'rate_limit MY_RATE_LIMITER', origin: 'auto.faas.cloudflare.rate_limit', parent_span_id: expect.any(String), span_id: expect.any(String), start_timestamp: expect.any(Number), timestamp: expect.any(Number), trace_id: expect.any(String), }, ]); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/allowed'); expect(response).toEqual({ success: true }); await runner.completed(); }); it('instruments a rate-limited call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); // Both `limit()` calls on the blocked endpoint are instrumented. expect(findRateLimitSpans(envelope)).toHaveLength(2); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/blocked'); expect(response).toEqual({ success: false }); await runner.completed(); }); 13 changes: 13 additions & 0 deletions 13 dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,13 @@ { "name": "worker-name", "compatibility_date": "2025-06-17", "main": "index.ts", "compatibility_flags": ["nodejs_als"], "ratelimits": [ { "name": "MY_RATE_LIMITER", "namespace_id": "1001", "simple": { "limit": 1, "period": 60 }, }, ], } 18 changes: 17 additions & 1 deletion 18 packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,13 +1,21 @@ import { isObjectLike } from '@sentry/core'; import type { CloudflareOptions } from '../../client'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket, isRateLimit, } from '../../utils/isBinding'; import { instrumentD1 } from './instrumentD1'; import { appendRpcMeta } from '../../utils/rpcMeta'; import { getEffectiveRpcPropagation } from '../../utils/rpcOptions'; import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace'; import { instrumentFetcher } from './instrumentFetcher'; import { instrumentQueueProducer } from './instrumentQueueProducer'; import { instrumentR2Bucket } from './instrumentR2'; import { instrumentRateLimit } from './instrumentRateLimit'; function isProxyable(item: unknown): item is object { return isObjectLike(item) || typeof item === 'function'; Expand All @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); * - Service bindings / JSRPC proxies * - Queue producers (via `send` + `sendBatch` duck-typing) * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing) * - Rate limiters (via `limit` duck-typing) * * @param env - The Cloudflare env object to instrument * @param options - Optional CloudflareOptions to control RPC trace propagation Expand DownExpand Up @@ -69,6 +78,13 @@ export function instrumentEnv<Env extends Record<string, unknown>>(env: Env, opt return instrumented; } if (isRateLimit(item)) { const bindingName = typeof prop === 'string' ? prop : String(prop); const instrumented = instrumentRateLimit(item, bindingName); instrumentedBindings.set(item, instrumented); return instrumented; } if (!rpcPropagation) { return item; } Expand Down 31 changes: 31 additions & 0 deletions 31 packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,31 @@ import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types'; import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core'; const ORIGIN = 'auto.faas.cloudflare.rate_limit'; /** * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call. */ export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T { return new Proxy(rateLimit, { get(target, prop, receiver) { if (prop !== 'limit') { return Reflect.get(target, prop, receiver); } const original = Reflect.get(target, prop, receiver) as RateLimit['limit']; return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> { return startSpan( { name: `rate_limit ${bindingName}`, attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN, }, }, () => Reflect.apply(original, target, [options]), ); }; }, }); } Comment threadcursor[bot] marked this conversation as resolved. Uh oh! There was an error while loading. Please reload this page. 13 changes: 12 additions & 1 deletion 13 packages/cloudflare/src/utils/isBinding.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -31,7 +31,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types'; import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types'; /** * Checks if a value is a JSRPC proxy (service binding). Expand DownExpand Up @@ -95,3 +95,14 @@ export function isR2Bucket(item: unknown): item is R2Bucket { typeof item.createMultipartUpload === 'function' ); } /** * Duck-type check for RateLimit bindings. * RateLimit only exposes a single `limit` method. Because that is a fairly * common method name, this check is intentionally run after the more specific * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding * also happens to expose `limit`. */ export function isRateLimit(item: unknown): item is RateLimit { return item != null && isNotJSRPC(item) && typeof item.limit === 'function'; } 28 changes: 28 additions & 0 deletions 28 packages/cloudflare/test/instrumentations/instrumentEnv.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace); }); it('wraps RateLimit bindings in a proxy and forwards calls', async () => { const startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); const limit = vi.fn().mockResolvedValue({ success: true }); const rateLimiter = { limit }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter; // Wrapped binding is a Proxy, not the original reference expect(wrapped).not.toBe(rateLimiter); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(limit).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenCalledWith( expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }), expect.any(Function), ); }); it('caches the wrapped RateLimit binding across repeated access', () => { const rateLimiter = { limit: vi.fn() }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER); }); describe('mTLS Fetcher bindings', () => { function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) { return new Proxy( Expand Down 76 changes: 76 additions & 0 deletions 76 packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,76 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as SentryCore from '@sentry/core'; import type { MockInstance } from 'vitest'; import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit'; function createMockRateLimit(success = true): RateLimit { return { limit: vi.fn().mockResolvedValue({ success }), } as unknown as RateLimit; } describe('instrumentRateLimit', () => { let startSpanSpy: MockInstance; beforeEach(() => { startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); }); afterEach(() => { vi.restoreAllMocks(); }); describe('limit', () => { test('forwards the call and returns the outcome', async () => { const rateLimit = createMockRateLimit(true); const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(rateLimit.limit).toHaveBeenCalledTimes(1); expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' }); }); test('returns an unsuccessful (rate-limited) outcome unchanged', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: false }); }); test('starts a span with the binding name and origin', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'user-123' }); expect(startSpanSpy).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenLastCalledWith( { name: 'rate_limit MY_RATE_LIMITER', attributes: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, }, expect.any(Function), ); }); test('does not record the rate limit key (avoids leaking PII)', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'super-secret-user-id' }); expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id'); }); }); test('forwards unknown property accesses transparently', () => { const rateLimit = Object.assign(createMockRateLimit(), { customMethod: vi.fn().mockReturnValue('hi'), }) as unknown as RateLimit & { customMethod: () => string }; const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string }; expect(wrapped.customMethod()).toBe('hi'); }); }); 33 changes: 32 additions & 1 deletion 33 packages/cloudflare/test/utils/isBinding.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,5 +1,5 @@ import { describe, expect, it } from 'vitest'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding'; describe('isJSRPC', () => { it('returns false for a plain object', () => { Expand DownExpand Up @@ -210,3 +210,34 @@ describe('isD1Database', () => { expect(isD1Database(jsrpcProxy)).toBe(false); }); }); describe('isRateLimit', () => { it('returns true for an object with a limit method', () => { expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true); }); it('returns false when limit is missing', () => { expect(isRateLimit({ foo: 'bar' })).toBe(false); }); it('returns false when limit is not a function', () => { expect(isRateLimit({ limit: 'nope' })).toBe(false); }); it('returns false for null and undefined', () => { expect(isRateLimit(null)).toBe(false); expect(isRateLimit(undefined)).toBe(false); }); it('returns false for a JSRPC proxy even though it returns a function for limit', () => { const jsrpcProxy = new Proxy( {}, { get(_target, _prop) { return () => {}; }, }, ); expect(isRateLimit(jsrpcProxy)).toBe(false); }); }); Loading Oops, something went wrong. Uh oh! There was an error while loading. Please reload this page. 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. Footer © 2026 GitHub, Inc. Footer navigation Terms Privacy Security Status Community Docs Contact You can’t perform that action at this time. , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Skip to contentNavigation Menu Sign inAppearance settings AI CODE CREATIONGitHub CopilotWrite better code with AI GitHub Copilot appDirect agents from issue to merge MCP RegistryIntegrate external tools DEVELOPER WORKFLOWSActionsAutomate any workflow CodespacesInstant dev environments IssuesPlan and track work Code ReviewManage code changes Code QualityEnforce quality at merge APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities Code securitySecure your code as you build Secret protectionStop leaks before they start EXPLOREWhy GitHub Documentation Blog Changelog Marketplace View all features BY COMPANY SIZEEnterprises Small and medium teams Startups Nonprofits BY USE CASEApp Modernization DevSecOps DevOps CI/CD View all use cases BY INDUSTRYHealthcare Financial services Manufacturing Government View all industries View all solutions EXPLORE BY TOPICAI Software Development DevOps Security View all topics EXPLORE BY TYPECustomer stories Events & webinars Ebooks & reports Business insights GitHub Skills SUPPORT & SERVICESDocumentation Customer support Community forum Trust center Partners View all resources COMMUNITYGitHub SponsorsFund open source developers PROGRAMSSecurity Lab Maintainer Community GitHub Stars Archive Program REPOSITORIESTopics Trending Collections ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features Copilot for BusinessEnterprise-grade AI features Premium SupportEnterprise-grade 24/7 support Pricing Sign in Sign upAppearance settings You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert Uh oh! There was an error while loading. Please reload this page. getsentry /sentry-javascriptPublic Uh oh! There was an error while loading. Please reload this page. Notifications You must be signed in to change notification settings Fork 1.8k Star 8.7k Code Issues589 Pull requests70 Discussions Actions Security and quality5 Insights Additional navigation options Code Issues Pull requests Discussions Actions Security and quality Insights feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035 New issue Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community. Sign up for GitHub By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails. Already on GitHub? Sign in to your account Merged JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentationJul 17, 2026 Conversation 34 Commits 5 Checks 86 Files changed Uh oh! There was an error while loading. Please reload this page. Merged feat(cloudflare): Instrument Cloudflare rate limiter bindings #22035 Show file tree Hide file tree Changes from all commits Commits Show all changes 5 commits Select commit Hold shift + click to select a range 53a0a03 feat(cloudflare): Instrument Cloudflare rate limiter bindings PeterWadie Jul 8, 2026d2be645 test(cloudflare): Add rate limiter binding integration test PeterWadie Jul 8, 20262504ba9 ref(cloudflare): Address review feedback on rate limiter instrumentation PeterWadie Jul 13, 20260f63dd7 test(cloudflare): Filter rate limiter spans by data['sentry.origin'] PeterWadie Jul 13, 20264a9eb20 Merge branch 'develop' into feat/cloudflare-rate-limit-instrumentation PeterWadie Jul 14, 2026 File filter Filter by extension Filter by extension .jsonc (1) .ts (8) All 2 file types selected Viewed files Clear filters Conversations Failed to load comments. Loading Uh oh! There was an error while loading. Please reload this page. Jump to Jump to file Failed to load files. Loading Uh oh! There was an error while loading. Please reload this page. Diff view Unified Split Hide whitespace Diff view Unified Split Hide whitespace dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts index.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts test.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc wrangler.jsonc packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts instrumentEnv.ts packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts instrumentRateLimit.ts packages/cloudflare/src/utils/isBinding.ts isBinding.ts packages/cloudflare/test/instrumentations/instrumentEnv.test.ts instrumentEnv.test.ts packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts instrumentRateLimit.test.ts packages/cloudflare/test/utils/isBinding.test.ts isBinding.test.ts Some comments aren't visible on the classic Files Changed page. There are no files selected for viewing 37 changes: 37 additions & 0 deletions 37 dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,37 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as Sentry from '@sentry/cloudflare'; interface Env { SENTRY_DSN: string; MY_RATE_LIMITER: RateLimit; } function json(data: unknown): Response { return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } }); } export default Sentry.withSentry( (env: Env) => ({ dsn: env.SENTRY_DSN, tracesSampleRate: 1, }), { async fetch(request, env) { const url = new URL(request.url); if (url.pathname === '/ratelimit/allowed') { const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' }); return json(outcome); } if (url.pathname === '/ratelimit/blocked') { // The binding's limit is 1, so the second call within the period is rate limited. await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); return json(outcome); } return new Response('not found', { status: 404 }); }, } as ExportedHandler<Env>, ); 63 changes: 63 additions & 0 deletions 63 dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,63 @@ import type { Envelope } from '@sentry/core'; import { expect, it } from 'vitest'; import { createRunner } from '../../runner'; function envelopeItemType(envelope: Envelope): string | undefined { return envelope[1][0]?.[0]?.type as string | undefined; } function envelopeItem(envelope: Envelope): Record<string, unknown> { return envelope[1][0]![1] as Record<string, unknown>; } function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> { if (envelopeItemType(envelope) !== 'transaction') return []; const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || []; return spans.filter( s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit', ); } it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); const event = envelopeItem(envelope); expect(event.spans).toEqual([ { data: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, description: 'rate_limit MY_RATE_LIMITER', origin: 'auto.faas.cloudflare.rate_limit', parent_span_id: expect.any(String), span_id: expect.any(String), start_timestamp: expect.any(Number), timestamp: expect.any(Number), trace_id: expect.any(String), }, ]); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/allowed'); expect(response).toEqual({ success: true }); await runner.completed(); }); it('instruments a rate-limited call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); // Both `limit()` calls on the blocked endpoint are instrumented. expect(findRateLimitSpans(envelope)).toHaveLength(2); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/blocked'); expect(response).toEqual({ success: false }); await runner.completed(); }); 13 changes: 13 additions & 0 deletions 13 dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,13 @@ { "name": "worker-name", "compatibility_date": "2025-06-17", "main": "index.ts", "compatibility_flags": ["nodejs_als"], "ratelimits": [ { "name": "MY_RATE_LIMITER", "namespace_id": "1001", "simple": { "limit": 1, "period": 60 }, }, ], } 18 changes: 17 additions & 1 deletion 18 packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,13 +1,21 @@ import { isObjectLike } from '@sentry/core'; import type { CloudflareOptions } from '../../client'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket, isRateLimit, } from '../../utils/isBinding'; import { instrumentD1 } from './instrumentD1'; import { appendRpcMeta } from '../../utils/rpcMeta'; import { getEffectiveRpcPropagation } from '../../utils/rpcOptions'; import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace'; import { instrumentFetcher } from './instrumentFetcher'; import { instrumentQueueProducer } from './instrumentQueueProducer'; import { instrumentR2Bucket } from './instrumentR2'; import { instrumentRateLimit } from './instrumentRateLimit'; function isProxyable(item: unknown): item is object { return isObjectLike(item) || typeof item === 'function'; Expand All @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); * - Service bindings / JSRPC proxies * - Queue producers (via `send` + `sendBatch` duck-typing) * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing) * - Rate limiters (via `limit` duck-typing) * * @param env - The Cloudflare env object to instrument * @param options - Optional CloudflareOptions to control RPC trace propagation Expand DownExpand Up @@ -69,6 +78,13 @@ export function instrumentEnv<Env extends Record<string, unknown>>(env: Env, opt return instrumented; } if (isRateLimit(item)) { const bindingName = typeof prop === 'string' ? prop : String(prop); const instrumented = instrumentRateLimit(item, bindingName); instrumentedBindings.set(item, instrumented); return instrumented; } if (!rpcPropagation) { return item; } Expand Down 31 changes: 31 additions & 0 deletions 31 packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,31 @@ import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types'; import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core'; const ORIGIN = 'auto.faas.cloudflare.rate_limit'; /** * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call. */ export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T { return new Proxy(rateLimit, { get(target, prop, receiver) { if (prop !== 'limit') { return Reflect.get(target, prop, receiver); } const original = Reflect.get(target, prop, receiver) as RateLimit['limit']; return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> { return startSpan( { name: `rate_limit ${bindingName}`, attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN, }, }, () => Reflect.apply(original, target, [options]), ); }; }, }); } Comment threadcursor[bot] marked this conversation as resolved. Uh oh! There was an error while loading. Please reload this page. 13 changes: 12 additions & 1 deletion 13 packages/cloudflare/src/utils/isBinding.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -31,7 +31,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types'; import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types'; /** * Checks if a value is a JSRPC proxy (service binding). Expand DownExpand Up @@ -95,3 +95,14 @@ export function isR2Bucket(item: unknown): item is R2Bucket { typeof item.createMultipartUpload === 'function' ); } /** * Duck-type check for RateLimit bindings. * RateLimit only exposes a single `limit` method. Because that is a fairly * common method name, this check is intentionally run after the more specific * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding * also happens to expose `limit`. */ export function isRateLimit(item: unknown): item is RateLimit { return item != null && isNotJSRPC(item) && typeof item.limit === 'function'; } 28 changes: 28 additions & 0 deletions 28 packages/cloudflare/test/instrumentations/instrumentEnv.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace); }); it('wraps RateLimit bindings in a proxy and forwards calls', async () => { const startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); const limit = vi.fn().mockResolvedValue({ success: true }); const rateLimiter = { limit }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter; // Wrapped binding is a Proxy, not the original reference expect(wrapped).not.toBe(rateLimiter); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(limit).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenCalledWith( expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }), expect.any(Function), ); }); it('caches the wrapped RateLimit binding across repeated access', () => { const rateLimiter = { limit: vi.fn() }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER); }); describe('mTLS Fetcher bindings', () => { function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) { return new Proxy( Expand Down 76 changes: 76 additions & 0 deletions 76 packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,76 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as SentryCore from '@sentry/core'; import type { MockInstance } from 'vitest'; import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit'; function createMockRateLimit(success = true): RateLimit { return { limit: vi.fn().mockResolvedValue({ success }), } as unknown as RateLimit; } describe('instrumentRateLimit', () => { let startSpanSpy: MockInstance; beforeEach(() => { startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); }); afterEach(() => { vi.restoreAllMocks(); }); describe('limit', () => { test('forwards the call and returns the outcome', async () => { const rateLimit = createMockRateLimit(true); const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(rateLimit.limit).toHaveBeenCalledTimes(1); expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' }); }); test('returns an unsuccessful (rate-limited) outcome unchanged', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: false }); }); test('starts a span with the binding name and origin', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'user-123' }); expect(startSpanSpy).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenLastCalledWith( { name: 'rate_limit MY_RATE_LIMITER', attributes: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, }, expect.any(Function), ); }); test('does not record the rate limit key (avoids leaking PII)', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'super-secret-user-id' }); expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id'); }); }); test('forwards unknown property accesses transparently', () => { const rateLimit = Object.assign(createMockRateLimit(), { customMethod: vi.fn().mockReturnValue('hi'), }) as unknown as RateLimit & { customMethod: () => string }; const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string }; expect(wrapped.customMethod()).toBe('hi'); }); }); 33 changes: 32 additions & 1 deletion 33 packages/cloudflare/test/utils/isBinding.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,5 +1,5 @@ import { describe, expect, it } from 'vitest'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding'; describe('isJSRPC', () => { it('returns false for a plain object', () => { Expand DownExpand Up @@ -210,3 +210,34 @@ describe('isD1Database', () => { expect(isD1Database(jsrpcProxy)).toBe(false); }); }); describe('isRateLimit', () => { it('returns true for an object with a limit method', () => { expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true); }); it('returns false when limit is missing', () => { expect(isRateLimit({ foo: 'bar' })).toBe(false); }); it('returns false when limit is not a function', () => { expect(isRateLimit({ limit: 'nope' })).toBe(false); }); it('returns false for null and undefined', () => { expect(isRateLimit(null)).toBe(false); expect(isRateLimit(undefined)).toBe(false); }); it('returns false for a JSRPC proxy even though it returns a function for limit', () => { const jsrpcProxy = new Proxy( {}, { get(_target, _prop) { return () => {}; }, }, ); expect(isRateLimit(jsrpcProxy)).toBe(false); }); }); Loading Oops, something went wrong. Uh oh! There was an error while loading. Please reload this page. 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. Footer © 2026 GitHub, Inc. Footer navigation Terms Privacy Security Status Community Docs Contact You can’t perform that action at this time. , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Skip to contentNavigation Menu Sign inAppearance settings AI CODE CREATIONGitHub CopilotWrite better code with AI GitHub Copilot appDirect agents from issue to merge MCP RegistryIntegrate external tools DEVELOPER WORKFLOWSActionsAutomate any workflow CodespacesInstant dev environments IssuesPlan and track work Code ReviewManage code changes Code QualityEnforce quality at merge APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities Code securitySecure your code as you build Secret protectionStop leaks before they start EXPLOREWhy GitHub Documentation Blog Changelog Marketplace View all features BY COMPANY SIZEEnterprises Small and medium teams Startups Nonprofits BY USE CASEApp Modernization DevSecOps DevOps CI/CD View all use cases BY INDUSTRYHealthcare Financial services Manufacturing Government View all industries View all solutions EXPLORE BY TOPICAI Software Development DevOps Security View all topics EXPLORE BY TYPECustomer stories Events & webinars Ebooks & reports Business insights GitHub Skills SUPPORT & SERVICESDocumentation Customer support Community forum Trust center Partners View all resources COMMUNITYGitHub SponsorsFund open source developers PROGRAMSSecurity Lab Maintainer Community GitHub Stars Archive Program REPOSITORIESTopics Trending Collections ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features Copilot for BusinessEnterprise-grade AI features Premium SupportEnterprise-grade 24/7 support Pricing Sign in Sign upAppearance settings You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert Uh oh! There was an error while loading. Please reload this page. getsentry /sentry-javascriptPublic Uh oh! There was an error while loading. Please reload this page. Notifications You must be signed in to change notification settings Fork 1.8k Star 8.7k Code Issues589 Pull requests70 Discussions Actions Security and quality5 Insights Additional navigation options Code Issues Pull requests Discussions Actions Security and quality Insights feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035 New issue Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community. Sign up for GitHub By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails. Already on GitHub? Sign in to your account Merged JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentationJul 17, 2026 Conversation 34 Commits 5 Checks 86 Files changed Uh oh! There was an error while loading. Please reload this page. Merged feat(cloudflare): Instrument Cloudflare rate limiter bindings #22035 Show file tree Hide file tree Changes from all commits Commits Show all changes 5 commits Select commit Hold shift + click to select a range 53a0a03 feat(cloudflare): Instrument Cloudflare rate limiter bindings PeterWadie Jul 8, 2026d2be645 test(cloudflare): Add rate limiter binding integration test PeterWadie Jul 8, 20262504ba9 ref(cloudflare): Address review feedback on rate limiter instrumentation PeterWadie Jul 13, 20260f63dd7 test(cloudflare): Filter rate limiter spans by data['sentry.origin'] PeterWadie Jul 13, 20264a9eb20 Merge branch 'develop' into feat/cloudflare-rate-limit-instrumentation PeterWadie Jul 14, 2026 File filter Filter by extension Filter by extension .jsonc (1) .ts (8) All 2 file types selected Viewed files Clear filters Conversations Failed to load comments. Loading Uh oh! There was an error while loading. Please reload this page. Jump to Jump to file Failed to load files. Loading Uh oh! There was an error while loading. Please reload this page. Diff view Unified Split Hide whitespace Diff view Unified Split Hide whitespace dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts index.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts test.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc wrangler.jsonc packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts instrumentEnv.ts packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts instrumentRateLimit.ts packages/cloudflare/src/utils/isBinding.ts isBinding.ts packages/cloudflare/test/instrumentations/instrumentEnv.test.ts instrumentEnv.test.ts packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts instrumentRateLimit.test.ts packages/cloudflare/test/utils/isBinding.test.ts isBinding.test.ts Some comments aren't visible on the classic Files Changed page. There are no files selected for viewing 37 changes: 37 additions & 0 deletions 37 dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,37 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as Sentry from '@sentry/cloudflare'; interface Env { SENTRY_DSN: string; MY_RATE_LIMITER: RateLimit; } function json(data: unknown): Response { return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } }); } export default Sentry.withSentry( (env: Env) => ({ dsn: env.SENTRY_DSN, tracesSampleRate: 1, }), { async fetch(request, env) { const url = new URL(request.url); if (url.pathname === '/ratelimit/allowed') { const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' }); return json(outcome); } if (url.pathname === '/ratelimit/blocked') { // The binding's limit is 1, so the second call within the period is rate limited. await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); return json(outcome); } return new Response('not found', { status: 404 }); }, } as ExportedHandler<Env>, ); 63 changes: 63 additions & 0 deletions 63 dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,63 @@ import type { Envelope } from '@sentry/core'; import { expect, it } from 'vitest'; import { createRunner } from '../../runner'; function envelopeItemType(envelope: Envelope): string | undefined { return envelope[1][0]?.[0]?.type as string | undefined; } function envelopeItem(envelope: Envelope): Record<string, unknown> { return envelope[1][0]![1] as Record<string, unknown>; } function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> { if (envelopeItemType(envelope) !== 'transaction') return []; const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || []; return spans.filter( s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit', ); } it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); const event = envelopeItem(envelope); expect(event.spans).toEqual([ { data: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, description: 'rate_limit MY_RATE_LIMITER', origin: 'auto.faas.cloudflare.rate_limit', parent_span_id: expect.any(String), span_id: expect.any(String), start_timestamp: expect.any(Number), timestamp: expect.any(Number), trace_id: expect.any(String), }, ]); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/allowed'); expect(response).toEqual({ success: true }); await runner.completed(); }); it('instruments a rate-limited call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); // Both `limit()` calls on the blocked endpoint are instrumented. expect(findRateLimitSpans(envelope)).toHaveLength(2); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/blocked'); expect(response).toEqual({ success: false }); await runner.completed(); }); 13 changes: 13 additions & 0 deletions 13 dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,13 @@ { "name": "worker-name", "compatibility_date": "2025-06-17", "main": "index.ts", "compatibility_flags": ["nodejs_als"], "ratelimits": [ { "name": "MY_RATE_LIMITER", "namespace_id": "1001", "simple": { "limit": 1, "period": 60 }, }, ], } 18 changes: 17 additions & 1 deletion 18 packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,13 +1,21 @@ import { isObjectLike } from '@sentry/core'; import type { CloudflareOptions } from '../../client'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket, isRateLimit, } from '../../utils/isBinding'; import { instrumentD1 } from './instrumentD1'; import { appendRpcMeta } from '../../utils/rpcMeta'; import { getEffectiveRpcPropagation } from '../../utils/rpcOptions'; import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace'; import { instrumentFetcher } from './instrumentFetcher'; import { instrumentQueueProducer } from './instrumentQueueProducer'; import { instrumentR2Bucket } from './instrumentR2'; import { instrumentRateLimit } from './instrumentRateLimit'; function isProxyable(item: unknown): item is object { return isObjectLike(item) || typeof item === 'function'; Expand All @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); * - Service bindings / JSRPC proxies * - Queue producers (via `send` + `sendBatch` duck-typing) * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing) * - Rate limiters (via `limit` duck-typing) * * @param env - The Cloudflare env object to instrument * @param options - Optional CloudflareOptions to control RPC trace propagation Expand DownExpand Up @@ -69,6 +78,13 @@ export function instrumentEnv<Env extends Record<string, unknown>>(env: Env, opt return instrumented; } if (isRateLimit(item)) { const bindingName = typeof prop === 'string' ? prop : String(prop); const instrumented = instrumentRateLimit(item, bindingName); instrumentedBindings.set(item, instrumented); return instrumented; } if (!rpcPropagation) { return item; } Expand Down 31 changes: 31 additions & 0 deletions 31 packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,31 @@ import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types'; import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core'; const ORIGIN = 'auto.faas.cloudflare.rate_limit'; /** * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call. */ export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T { return new Proxy(rateLimit, { get(target, prop, receiver) { if (prop !== 'limit') { return Reflect.get(target, prop, receiver); } const original = Reflect.get(target, prop, receiver) as RateLimit['limit']; return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> { return startSpan( { name: `rate_limit ${bindingName}`, attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN, }, }, () => Reflect.apply(original, target, [options]), ); }; }, }); } Comment threadcursor[bot] marked this conversation as resolved. Uh oh! There was an error while loading. Please reload this page. 13 changes: 12 additions & 1 deletion 13 packages/cloudflare/src/utils/isBinding.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -31,7 +31,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types'; import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types'; /** * Checks if a value is a JSRPC proxy (service binding). Expand DownExpand Up @@ -95,3 +95,14 @@ export function isR2Bucket(item: unknown): item is R2Bucket { typeof item.createMultipartUpload === 'function' ); } /** * Duck-type check for RateLimit bindings. * RateLimit only exposes a single `limit` method. Because that is a fairly * common method name, this check is intentionally run after the more specific * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding * also happens to expose `limit`. */ export function isRateLimit(item: unknown): item is RateLimit { return item != null && isNotJSRPC(item) && typeof item.limit === 'function'; } 28 changes: 28 additions & 0 deletions 28 packages/cloudflare/test/instrumentations/instrumentEnv.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace); }); it('wraps RateLimit bindings in a proxy and forwards calls', async () => { const startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); const limit = vi.fn().mockResolvedValue({ success: true }); const rateLimiter = { limit }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter; // Wrapped binding is a Proxy, not the original reference expect(wrapped).not.toBe(rateLimiter); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(limit).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenCalledWith( expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }), expect.any(Function), ); }); it('caches the wrapped RateLimit binding across repeated access', () => { const rateLimiter = { limit: vi.fn() }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER); }); describe('mTLS Fetcher bindings', () => { function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) { return new Proxy( Expand Down 76 changes: 76 additions & 0 deletions 76 packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,76 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as SentryCore from '@sentry/core'; import type { MockInstance } from 'vitest'; import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit'; function createMockRateLimit(success = true): RateLimit { return { limit: vi.fn().mockResolvedValue({ success }), } as unknown as RateLimit; } describe('instrumentRateLimit', () => { let startSpanSpy: MockInstance; beforeEach(() => { startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); }); afterEach(() => { vi.restoreAllMocks(); }); describe('limit', () => { test('forwards the call and returns the outcome', async () => { const rateLimit = createMockRateLimit(true); const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(rateLimit.limit).toHaveBeenCalledTimes(1); expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' }); }); test('returns an unsuccessful (rate-limited) outcome unchanged', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: false }); }); test('starts a span with the binding name and origin', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'user-123' }); expect(startSpanSpy).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenLastCalledWith( { name: 'rate_limit MY_RATE_LIMITER', attributes: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, }, expect.any(Function), ); }); test('does not record the rate limit key (avoids leaking PII)', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'super-secret-user-id' }); expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id'); }); }); test('forwards unknown property accesses transparently', () => { const rateLimit = Object.assign(createMockRateLimit(), { customMethod: vi.fn().mockReturnValue('hi'), }) as unknown as RateLimit & { customMethod: () => string }; const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string }; expect(wrapped.customMethod()).toBe('hi'); }); }); 33 changes: 32 additions & 1 deletion 33 packages/cloudflare/test/utils/isBinding.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,5 +1,5 @@ import { describe, expect, it } from 'vitest'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding'; describe('isJSRPC', () => { it('returns false for a plain object', () => { Expand DownExpand Up @@ -210,3 +210,34 @@ describe('isD1Database', () => { expect(isD1Database(jsrpcProxy)).toBe(false); }); }); describe('isRateLimit', () => { it('returns true for an object with a limit method', () => { expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true); }); it('returns false when limit is missing', () => { expect(isRateLimit({ foo: 'bar' })).toBe(false); }); it('returns false when limit is not a function', () => { expect(isRateLimit({ limit: 'nope' })).toBe(false); }); it('returns false for null and undefined', () => { expect(isRateLimit(null)).toBe(false); expect(isRateLimit(undefined)).toBe(false); }); it('returns false for a JSRPC proxy even though it returns a function for limit', () => { const jsrpcProxy = new Proxy( {}, { get(_target, _prop) { return () => {}; }, }, ); expect(isRateLimit(jsrpcProxy)).toBe(false); }); }); Loading Oops, something went wrong. Uh oh! There was an error while loading. Please reload this page. 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. Footer © 2026 GitHub, Inc. Footer navigation Terms Privacy Security Status Community Docs Contact You can’t perform that action at this time. , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Skip to contentNavigation Menu Sign inAppearance settings AI CODE CREATIONGitHub CopilotWrite better code with AI GitHub Copilot appDirect agents from issue to merge MCP RegistryIntegrate external tools DEVELOPER WORKFLOWSActionsAutomate any workflow CodespacesInstant dev environments IssuesPlan and track work Code ReviewManage code changes Code QualityEnforce quality at merge APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities Code securitySecure your code as you build Secret protectionStop leaks before they start EXPLOREWhy GitHub Documentation Blog Changelog Marketplace View all features BY COMPANY SIZEEnterprises Small and medium teams Startups Nonprofits BY USE CASEApp Modernization DevSecOps DevOps CI/CD View all use cases BY INDUSTRYHealthcare Financial services Manufacturing Government View all industries View all solutions EXPLORE BY TOPICAI Software Development DevOps Security View all topics EXPLORE BY TYPECustomer stories Events & webinars Ebooks & reports Business insights GitHub Skills SUPPORT & SERVICESDocumentation Customer support Community forum Trust center Partners View all resources COMMUNITYGitHub SponsorsFund open source developers PROGRAMSSecurity Lab Maintainer Community GitHub Stars Archive Program REPOSITORIESTopics Trending Collections ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features Copilot for BusinessEnterprise-grade AI features Premium SupportEnterprise-grade 24/7 support Pricing Sign in Sign upAppearance settings You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert Uh oh! There was an error while loading. Please reload this page. getsentry /sentry-javascriptPublic Uh oh! There was an error while loading. Please reload this page. Notifications You must be signed in to change notification settings Fork 1.8k Star 8.7k Code Issues589 Pull requests70 Discussions Actions Security and quality5 Insights Additional navigation options Code Issues Pull requests Discussions Actions Security and quality Insights feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035 New issue Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community. Sign up for GitHub By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails. Already on GitHub? Sign in to your account Merged JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentationJul 17, 2026 Conversation 34 Commits 5 Checks 86 Files changed Uh oh! There was an error while loading. Please reload this page. Merged feat(cloudflare): Instrument Cloudflare rate limiter bindings #22035 Show file tree Hide file tree Changes from all commits Commits Show all changes 5 commits Select commit Hold shift + click to select a range 53a0a03 feat(cloudflare): Instrument Cloudflare rate limiter bindings PeterWadie Jul 8, 2026d2be645 test(cloudflare): Add rate limiter binding integration test PeterWadie Jul 8, 20262504ba9 ref(cloudflare): Address review feedback on rate limiter instrumentation PeterWadie Jul 13, 20260f63dd7 test(cloudflare): Filter rate limiter spans by data['sentry.origin'] PeterWadie Jul 13, 20264a9eb20 Merge branch 'develop' into feat/cloudflare-rate-limit-instrumentation PeterWadie Jul 14, 2026 File filter Filter by extension Filter by extension .jsonc (1) .ts (8) All 2 file types selected Viewed files Clear filters Conversations Failed to load comments. Loading Uh oh! There was an error while loading. Please reload this page. Jump to Jump to file Failed to load files. Loading Uh oh! There was an error while loading. Please reload this page. Diff view Unified Split Hide whitespace Diff view Unified Split Hide whitespace dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts index.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts test.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc wrangler.jsonc packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts instrumentEnv.ts packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts instrumentRateLimit.ts packages/cloudflare/src/utils/isBinding.ts isBinding.ts packages/cloudflare/test/instrumentations/instrumentEnv.test.ts instrumentEnv.test.ts packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts instrumentRateLimit.test.ts packages/cloudflare/test/utils/isBinding.test.ts isBinding.test.ts Some comments aren't visible on the classic Files Changed page. There are no files selected for viewing 37 changes: 37 additions & 0 deletions 37 dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,37 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as Sentry from '@sentry/cloudflare'; interface Env { SENTRY_DSN: string; MY_RATE_LIMITER: RateLimit; } function json(data: unknown): Response { return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } }); } export default Sentry.withSentry( (env: Env) => ({ dsn: env.SENTRY_DSN, tracesSampleRate: 1, }), { async fetch(request, env) { const url = new URL(request.url); if (url.pathname === '/ratelimit/allowed') { const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' }); return json(outcome); } if (url.pathname === '/ratelimit/blocked') { // The binding's limit is 1, so the second call within the period is rate limited. await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); return json(outcome); } return new Response('not found', { status: 404 }); }, } as ExportedHandler<Env>, ); 63 changes: 63 additions & 0 deletions 63 dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,63 @@ import type { Envelope } from '@sentry/core'; import { expect, it } from 'vitest'; import { createRunner } from '../../runner'; function envelopeItemType(envelope: Envelope): string | undefined { return envelope[1][0]?.[0]?.type as string | undefined; } function envelopeItem(envelope: Envelope): Record<string, unknown> { return envelope[1][0]![1] as Record<string, unknown>; } function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> { if (envelopeItemType(envelope) !== 'transaction') return []; const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || []; return spans.filter( s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit', ); } it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); const event = envelopeItem(envelope); expect(event.spans).toEqual([ { data: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, description: 'rate_limit MY_RATE_LIMITER', origin: 'auto.faas.cloudflare.rate_limit', parent_span_id: expect.any(String), span_id: expect.any(String), start_timestamp: expect.any(Number), timestamp: expect.any(Number), trace_id: expect.any(String), }, ]); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/allowed'); expect(response).toEqual({ success: true }); await runner.completed(); }); it('instruments a rate-limited call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); // Both `limit()` calls on the blocked endpoint are instrumented. expect(findRateLimitSpans(envelope)).toHaveLength(2); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/blocked'); expect(response).toEqual({ success: false }); await runner.completed(); }); 13 changes: 13 additions & 0 deletions 13 dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,13 @@ { "name": "worker-name", "compatibility_date": "2025-06-17", "main": "index.ts", "compatibility_flags": ["nodejs_als"], "ratelimits": [ { "name": "MY_RATE_LIMITER", "namespace_id": "1001", "simple": { "limit": 1, "period": 60 }, }, ], } 18 changes: 17 additions & 1 deletion 18 packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,13 +1,21 @@ import { isObjectLike } from '@sentry/core'; import type { CloudflareOptions } from '../../client'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket, isRateLimit, } from '../../utils/isBinding'; import { instrumentD1 } from './instrumentD1'; import { appendRpcMeta } from '../../utils/rpcMeta'; import { getEffectiveRpcPropagation } from '../../utils/rpcOptions'; import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace'; import { instrumentFetcher } from './instrumentFetcher'; import { instrumentQueueProducer } from './instrumentQueueProducer'; import { instrumentR2Bucket } from './instrumentR2'; import { instrumentRateLimit } from './instrumentRateLimit'; function isProxyable(item: unknown): item is object { return isObjectLike(item) || typeof item === 'function'; Expand All @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); * - Service bindings / JSRPC proxies * - Queue producers (via `send` + `sendBatch` duck-typing) * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing) * - Rate limiters (via `limit` duck-typing) * * @param env - The Cloudflare env object to instrument * @param options - Optional CloudflareOptions to control RPC trace propagation Expand DownExpand Up @@ -69,6 +78,13 @@ export function instrumentEnv<Env extends Record<string, unknown>>(env: Env, opt return instrumented; } if (isRateLimit(item)) { const bindingName = typeof prop === 'string' ? prop : String(prop); const instrumented = instrumentRateLimit(item, bindingName); instrumentedBindings.set(item, instrumented); return instrumented; } if (!rpcPropagation) { return item; } Expand Down 31 changes: 31 additions & 0 deletions 31 packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,31 @@ import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types'; import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core'; const ORIGIN = 'auto.faas.cloudflare.rate_limit'; /** * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call. */ export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T { return new Proxy(rateLimit, { get(target, prop, receiver) { if (prop !== 'limit') { return Reflect.get(target, prop, receiver); } const original = Reflect.get(target, prop, receiver) as RateLimit['limit']; return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> { return startSpan( { name: `rate_limit ${bindingName}`, attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN, }, }, () => Reflect.apply(original, target, [options]), ); }; }, }); } Comment threadcursor[bot] marked this conversation as resolved. Uh oh! There was an error while loading. Please reload this page. 13 changes: 12 additions & 1 deletion 13 packages/cloudflare/src/utils/isBinding.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -31,7 +31,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types'; import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types'; /** * Checks if a value is a JSRPC proxy (service binding). Expand DownExpand Up @@ -95,3 +95,14 @@ export function isR2Bucket(item: unknown): item is R2Bucket { typeof item.createMultipartUpload === 'function' ); } /** * Duck-type check for RateLimit bindings. * RateLimit only exposes a single `limit` method. Because that is a fairly * common method name, this check is intentionally run after the more specific * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding * also happens to expose `limit`. */ export function isRateLimit(item: unknown): item is RateLimit { return item != null && isNotJSRPC(item) && typeof item.limit === 'function'; } 28 changes: 28 additions & 0 deletions 28 packages/cloudflare/test/instrumentations/instrumentEnv.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace); }); it('wraps RateLimit bindings in a proxy and forwards calls', async () => { const startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); const limit = vi.fn().mockResolvedValue({ success: true }); const rateLimiter = { limit }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter; // Wrapped binding is a Proxy, not the original reference expect(wrapped).not.toBe(rateLimiter); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(limit).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenCalledWith( expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }), expect.any(Function), ); }); it('caches the wrapped RateLimit binding across repeated access', () => { const rateLimiter = { limit: vi.fn() }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER); }); describe('mTLS Fetcher bindings', () => { function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) { return new Proxy( Expand Down 76 changes: 76 additions & 0 deletions 76 packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,76 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as SentryCore from '@sentry/core'; import type { MockInstance } from 'vitest'; import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit'; function createMockRateLimit(success = true): RateLimit { return { limit: vi.fn().mockResolvedValue({ success }), } as unknown as RateLimit; } describe('instrumentRateLimit', () => { let startSpanSpy: MockInstance; beforeEach(() => { startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); }); afterEach(() => { vi.restoreAllMocks(); }); describe('limit', () => { test('forwards the call and returns the outcome', async () => { const rateLimit = createMockRateLimit(true); const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(rateLimit.limit).toHaveBeenCalledTimes(1); expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' }); }); test('returns an unsuccessful (rate-limited) outcome unchanged', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: false }); }); test('starts a span with the binding name and origin', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'user-123' }); expect(startSpanSpy).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenLastCalledWith( { name: 'rate_limit MY_RATE_LIMITER', attributes: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, }, expect.any(Function), ); }); test('does not record the rate limit key (avoids leaking PII)', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'super-secret-user-id' }); expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id'); }); }); test('forwards unknown property accesses transparently', () => { const rateLimit = Object.assign(createMockRateLimit(), { customMethod: vi.fn().mockReturnValue('hi'), }) as unknown as RateLimit & { customMethod: () => string }; const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string }; expect(wrapped.customMethod()).toBe('hi'); }); }); 33 changes: 32 additions & 1 deletion 33 packages/cloudflare/test/utils/isBinding.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,5 +1,5 @@ import { describe, expect, it } from 'vitest'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding'; describe('isJSRPC', () => { it('returns false for a plain object', () => { Expand DownExpand Up @@ -210,3 +210,34 @@ describe('isD1Database', () => { expect(isD1Database(jsrpcProxy)).toBe(false); }); }); describe('isRateLimit', () => { it('returns true for an object with a limit method', () => { expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true); }); it('returns false when limit is missing', () => { expect(isRateLimit({ foo: 'bar' })).toBe(false); }); it('returns false when limit is not a function', () => { expect(isRateLimit({ limit: 'nope' })).toBe(false); }); it('returns false for null and undefined', () => { expect(isRateLimit(null)).toBe(false); expect(isRateLimit(undefined)).toBe(false); }); it('returns false for a JSRPC proxy even though it returns a function for limit', () => { const jsrpcProxy = new Proxy( {}, { get(_target, _prop) { return () => {}; }, }, ); expect(isRateLimit(jsrpcProxy)).toBe(false); }); }); Loading Oops, something went wrong. Uh oh! There was an error while loading. Please reload this page. 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. Footer © 2026 GitHub, Inc. Footer navigation Terms Privacy Security Status Community Docs Contact You can’t perform that action at this time. , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Skip to contentNavigation Menu Sign inAppearance settings AI CODE CREATIONGitHub CopilotWrite better code with AI GitHub Copilot appDirect agents from issue to merge MCP RegistryIntegrate external tools DEVELOPER WORKFLOWSActionsAutomate any workflow CodespacesInstant dev environments IssuesPlan and track work Code ReviewManage code changes Code QualityEnforce quality at merge APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities Code securitySecure your code as you build Secret protectionStop leaks before they start EXPLOREWhy GitHub Documentation Blog Changelog Marketplace View all features BY COMPANY SIZEEnterprises Small and medium teams Startups Nonprofits BY USE CASEApp Modernization DevSecOps DevOps CI/CD View all use cases BY INDUSTRYHealthcare Financial services Manufacturing Government View all industries View all solutions EXPLORE BY TOPICAI Software Development DevOps Security View all topics EXPLORE BY TYPECustomer stories Events & webinars Ebooks & reports Business insights GitHub Skills SUPPORT & SERVICESDocumentation Customer support Community forum Trust center Partners View all resources COMMUNITYGitHub SponsorsFund open source developers PROGRAMSSecurity Lab Maintainer Community GitHub Stars Archive Program REPOSITORIESTopics Trending Collections ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features Copilot for BusinessEnterprise-grade AI features Premium SupportEnterprise-grade 24/7 support Pricing Sign in Sign upAppearance settings You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert Uh oh! There was an error while loading. Please reload this page. getsentry /sentry-javascriptPublic Uh oh! There was an error while loading. Please reload this page. Notifications You must be signed in to change notification settings Fork 1.8k Star 8.7k Code Issues589 Pull requests70 Discussions Actions Security and quality5 Insights Additional navigation options Code Issues Pull requests Discussions Actions Security and quality Insights feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035 New issue Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community. Sign up for GitHub By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails. Already on GitHub? Sign in to your account Merged JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentationJul 17, 2026 Conversation 34 Commits 5 Checks 86 Files changed Uh oh! There was an error while loading. Please reload this page. Merged feat(cloudflare): Instrument Cloudflare rate limiter bindings #22035 Show file tree Hide file tree Changes from all commits Commits Show all changes 5 commits Select commit Hold shift + click to select a range 53a0a03 feat(cloudflare): Instrument Cloudflare rate limiter bindings PeterWadie Jul 8, 2026d2be645 test(cloudflare): Add rate limiter binding integration test PeterWadie Jul 8, 20262504ba9 ref(cloudflare): Address review feedback on rate limiter instrumentation PeterWadie Jul 13, 20260f63dd7 test(cloudflare): Filter rate limiter spans by data['sentry.origin'] PeterWadie Jul 13, 20264a9eb20 Merge branch 'develop' into feat/cloudflare-rate-limit-instrumentation PeterWadie Jul 14, 2026 File filter Filter by extension Filter by extension .jsonc (1) .ts (8) All 2 file types selected Viewed files Clear filters Conversations Failed to load comments. Loading Uh oh! There was an error while loading. Please reload this page. Jump to Jump to file Failed to load files. Loading Uh oh! There was an error while loading. Please reload this page. Diff view Unified Split Hide whitespace Diff view Unified Split Hide whitespace dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts index.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts test.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc wrangler.jsonc packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts instrumentEnv.ts packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts instrumentRateLimit.ts packages/cloudflare/src/utils/isBinding.ts isBinding.ts packages/cloudflare/test/instrumentations/instrumentEnv.test.ts instrumentEnv.test.ts packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts instrumentRateLimit.test.ts packages/cloudflare/test/utils/isBinding.test.ts isBinding.test.ts Some comments aren't visible on the classic Files Changed page. There are no files selected for viewing 37 changes: 37 additions & 0 deletions 37 dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,37 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as Sentry from '@sentry/cloudflare'; interface Env { SENTRY_DSN: string; MY_RATE_LIMITER: RateLimit; } function json(data: unknown): Response { return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } }); } export default Sentry.withSentry( (env: Env) => ({ dsn: env.SENTRY_DSN, tracesSampleRate: 1, }), { async fetch(request, env) { const url = new URL(request.url); if (url.pathname === '/ratelimit/allowed') { const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' }); return json(outcome); } if (url.pathname === '/ratelimit/blocked') { // The binding's limit is 1, so the second call within the period is rate limited. await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); return json(outcome); } return new Response('not found', { status: 404 }); }, } as ExportedHandler<Env>, ); 63 changes: 63 additions & 0 deletions 63 dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,63 @@ import type { Envelope } from '@sentry/core'; import { expect, it } from 'vitest'; import { createRunner } from '../../runner'; function envelopeItemType(envelope: Envelope): string | undefined { return envelope[1][0]?.[0]?.type as string | undefined; } function envelopeItem(envelope: Envelope): Record<string, unknown> { return envelope[1][0]![1] as Record<string, unknown>; } function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> { if (envelopeItemType(envelope) !== 'transaction') return []; const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || []; return spans.filter( s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit', ); } it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); const event = envelopeItem(envelope); expect(event.spans).toEqual([ { data: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, description: 'rate_limit MY_RATE_LIMITER', origin: 'auto.faas.cloudflare.rate_limit', parent_span_id: expect.any(String), span_id: expect.any(String), start_timestamp: expect.any(Number), timestamp: expect.any(Number), trace_id: expect.any(String), }, ]); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/allowed'); expect(response).toEqual({ success: true }); await runner.completed(); }); it('instruments a rate-limited call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); // Both `limit()` calls on the blocked endpoint are instrumented. expect(findRateLimitSpans(envelope)).toHaveLength(2); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/blocked'); expect(response).toEqual({ success: false }); await runner.completed(); }); 13 changes: 13 additions & 0 deletions 13 dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,13 @@ { "name": "worker-name", "compatibility_date": "2025-06-17", "main": "index.ts", "compatibility_flags": ["nodejs_als"], "ratelimits": [ { "name": "MY_RATE_LIMITER", "namespace_id": "1001", "simple": { "limit": 1, "period": 60 }, }, ], } 18 changes: 17 additions & 1 deletion 18 packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,13 +1,21 @@ import { isObjectLike } from '@sentry/core'; import type { CloudflareOptions } from '../../client'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket, isRateLimit, } from '../../utils/isBinding'; import { instrumentD1 } from './instrumentD1'; import { appendRpcMeta } from '../../utils/rpcMeta'; import { getEffectiveRpcPropagation } from '../../utils/rpcOptions'; import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace'; import { instrumentFetcher } from './instrumentFetcher'; import { instrumentQueueProducer } from './instrumentQueueProducer'; import { instrumentR2Bucket } from './instrumentR2'; import { instrumentRateLimit } from './instrumentRateLimit'; function isProxyable(item: unknown): item is object { return isObjectLike(item) || typeof item === 'function'; Expand All @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); * - Service bindings / JSRPC proxies * - Queue producers (via `send` + `sendBatch` duck-typing) * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing) * - Rate limiters (via `limit` duck-typing) * * @param env - The Cloudflare env object to instrument * @param options - Optional CloudflareOptions to control RPC trace propagation Expand DownExpand Up @@ -69,6 +78,13 @@ export function instrumentEnv<Env extends Record<string, unknown>>(env: Env, opt return instrumented; } if (isRateLimit(item)) { const bindingName = typeof prop === 'string' ? prop : String(prop); const instrumented = instrumentRateLimit(item, bindingName); instrumentedBindings.set(item, instrumented); return instrumented; } if (!rpcPropagation) { return item; } Expand Down 31 changes: 31 additions & 0 deletions 31 packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,31 @@ import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types'; import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core'; const ORIGIN = 'auto.faas.cloudflare.rate_limit'; /** * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call. */ export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T { return new Proxy(rateLimit, { get(target, prop, receiver) { if (prop !== 'limit') { return Reflect.get(target, prop, receiver); } const original = Reflect.get(target, prop, receiver) as RateLimit['limit']; return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> { return startSpan( { name: `rate_limit ${bindingName}`, attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN, }, }, () => Reflect.apply(original, target, [options]), ); }; }, }); } Comment threadcursor[bot] marked this conversation as resolved. Uh oh! There was an error while loading. Please reload this page. 13 changes: 12 additions & 1 deletion 13 packages/cloudflare/src/utils/isBinding.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -31,7 +31,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types'; import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types'; /** * Checks if a value is a JSRPC proxy (service binding). Expand DownExpand Up @@ -95,3 +95,14 @@ export function isR2Bucket(item: unknown): item is R2Bucket { typeof item.createMultipartUpload === 'function' ); } /** * Duck-type check for RateLimit bindings. * RateLimit only exposes a single `limit` method. Because that is a fairly * common method name, this check is intentionally run after the more specific * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding * also happens to expose `limit`. */ export function isRateLimit(item: unknown): item is RateLimit { return item != null && isNotJSRPC(item) && typeof item.limit === 'function'; } 28 changes: 28 additions & 0 deletions 28 packages/cloudflare/test/instrumentations/instrumentEnv.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace); }); it('wraps RateLimit bindings in a proxy and forwards calls', async () => { const startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); const limit = vi.fn().mockResolvedValue({ success: true }); const rateLimiter = { limit }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter; // Wrapped binding is a Proxy, not the original reference expect(wrapped).not.toBe(rateLimiter); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(limit).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenCalledWith( expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }), expect.any(Function), ); }); it('caches the wrapped RateLimit binding across repeated access', () => { const rateLimiter = { limit: vi.fn() }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER); }); describe('mTLS Fetcher bindings', () => { function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) { return new Proxy( Expand Down 76 changes: 76 additions & 0 deletions 76 packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,76 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as SentryCore from '@sentry/core'; import type { MockInstance } from 'vitest'; import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit'; function createMockRateLimit(success = true): RateLimit { return { limit: vi.fn().mockResolvedValue({ success }), } as unknown as RateLimit; } describe('instrumentRateLimit', () => { let startSpanSpy: MockInstance; beforeEach(() => { startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); }); afterEach(() => { vi.restoreAllMocks(); }); describe('limit', () => { test('forwards the call and returns the outcome', async () => { const rateLimit = createMockRateLimit(true); const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(rateLimit.limit).toHaveBeenCalledTimes(1); expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' }); }); test('returns an unsuccessful (rate-limited) outcome unchanged', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: false }); }); test('starts a span with the binding name and origin', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'user-123' }); expect(startSpanSpy).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenLastCalledWith( { name: 'rate_limit MY_RATE_LIMITER', attributes: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, }, expect.any(Function), ); }); test('does not record the rate limit key (avoids leaking PII)', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'super-secret-user-id' }); expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id'); }); }); test('forwards unknown property accesses transparently', () => { const rateLimit = Object.assign(createMockRateLimit(), { customMethod: vi.fn().mockReturnValue('hi'), }) as unknown as RateLimit & { customMethod: () => string }; const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string }; expect(wrapped.customMethod()).toBe('hi'); }); }); 33 changes: 32 additions & 1 deletion 33 packages/cloudflare/test/utils/isBinding.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,5 +1,5 @@ import { describe, expect, it } from 'vitest'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding'; describe('isJSRPC', () => { it('returns false for a plain object', () => { Expand DownExpand Up @@ -210,3 +210,34 @@ describe('isD1Database', () => { expect(isD1Database(jsrpcProxy)).toBe(false); }); }); describe('isRateLimit', () => { it('returns true for an object with a limit method', () => { expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true); }); it('returns false when limit is missing', () => { expect(isRateLimit({ foo: 'bar' })).toBe(false); }); it('returns false when limit is not a function', () => { expect(isRateLimit({ limit: 'nope' })).toBe(false); }); it('returns false for null and undefined', () => { expect(isRateLimit(null)).toBe(false); expect(isRateLimit(undefined)).toBe(false); }); it('returns false for a JSRPC proxy even though it returns a function for limit', () => { const jsrpcProxy = new Proxy( {}, { get(_target, _prop) { return () => {}; }, }, ); expect(isRateLimit(jsrpcProxy)).toBe(false); }); }); Loading Oops, something went wrong. Uh oh! There was an error while loading. Please reload this page. 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. Footer © 2026 GitHub, Inc. Footer navigation Terms Privacy Security Status Community Docs Contact You can’t perform that action at this time. , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Skip to contentNavigation Menu Sign inAppearance settings AI CODE CREATIONGitHub CopilotWrite better code with AI GitHub Copilot appDirect agents from issue to merge MCP RegistryIntegrate external tools DEVELOPER WORKFLOWSActionsAutomate any workflow CodespacesInstant dev environments IssuesPlan and track work Code ReviewManage code changes Code QualityEnforce quality at merge APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities Code securitySecure your code as you build Secret protectionStop leaks before they start EXPLOREWhy GitHub Documentation Blog Changelog Marketplace View all features BY COMPANY SIZEEnterprises Small and medium teams Startups Nonprofits BY USE CASEApp Modernization DevSecOps DevOps CI/CD View all use cases BY INDUSTRYHealthcare Financial services Manufacturing Government View all industries View all solutions EXPLORE BY TOPICAI Software Development DevOps Security View all topics EXPLORE BY TYPECustomer stories Events & webinars Ebooks & reports Business insights GitHub Skills SUPPORT & SERVICESDocumentation Customer support Community forum Trust center Partners View all resources COMMUNITYGitHub SponsorsFund open source developers PROGRAMSSecurity Lab Maintainer Community GitHub Stars Archive Program REPOSITORIESTopics Trending Collections ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features Copilot for BusinessEnterprise-grade AI features Premium SupportEnterprise-grade 24/7 support Pricing Sign in Sign upAppearance settings You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert Uh oh! There was an error while loading. Please reload this page. getsentry /sentry-javascriptPublic Uh oh! There was an error while loading. Please reload this page. Notifications You must be signed in to change notification settings Fork 1.8k Star 8.7k Code Issues589 Pull requests70 Discussions Actions Security and quality5 Insights Additional navigation options Code Issues Pull requests Discussions Actions Security and quality Insights feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035 New issue Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community. Sign up for GitHub By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails. Already on GitHub? Sign in to your account Merged JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentationJul 17, 2026 Conversation 34 Commits 5 Checks 86 Files changed Uh oh! There was an error while loading. Please reload this page. Merged feat(cloudflare): Instrument Cloudflare rate limiter bindings #22035 Show file tree Hide file tree Changes from all commits Commits Show all changes 5 commits Select commit Hold shift + click to select a range 53a0a03 feat(cloudflare): Instrument Cloudflare rate limiter bindings PeterWadie Jul 8, 2026d2be645 test(cloudflare): Add rate limiter binding integration test PeterWadie Jul 8, 20262504ba9 ref(cloudflare): Address review feedback on rate limiter instrumentation PeterWadie Jul 13, 20260f63dd7 test(cloudflare): Filter rate limiter spans by data['sentry.origin'] PeterWadie Jul 13, 20264a9eb20 Merge branch 'develop' into feat/cloudflare-rate-limit-instrumentation PeterWadie Jul 14, 2026 File filter Filter by extension Filter by extension .jsonc (1) .ts (8) All 2 file types selected Viewed files Clear filters Conversations Failed to load comments. Loading Uh oh! There was an error while loading. Please reload this page. Jump to Jump to file Failed to load files. Loading Uh oh! There was an error while loading. Please reload this page. Diff view Unified Split Hide whitespace Diff view Unified Split Hide whitespace dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts index.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts test.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc wrangler.jsonc packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts instrumentEnv.ts packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts instrumentRateLimit.ts packages/cloudflare/src/utils/isBinding.ts isBinding.ts packages/cloudflare/test/instrumentations/instrumentEnv.test.ts instrumentEnv.test.ts packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts instrumentRateLimit.test.ts packages/cloudflare/test/utils/isBinding.test.ts isBinding.test.ts Some comments aren't visible on the classic Files Changed page. There are no files selected for viewing 37 changes: 37 additions & 0 deletions 37 dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,37 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as Sentry from '@sentry/cloudflare'; interface Env { SENTRY_DSN: string; MY_RATE_LIMITER: RateLimit; } function json(data: unknown): Response { return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } }); } export default Sentry.withSentry( (env: Env) => ({ dsn: env.SENTRY_DSN, tracesSampleRate: 1, }), { async fetch(request, env) { const url = new URL(request.url); if (url.pathname === '/ratelimit/allowed') { const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' }); return json(outcome); } if (url.pathname === '/ratelimit/blocked') { // The binding's limit is 1, so the second call within the period is rate limited. await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); return json(outcome); } return new Response('not found', { status: 404 }); }, } as ExportedHandler<Env>, ); 63 changes: 63 additions & 0 deletions 63 dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,63 @@ import type { Envelope } from '@sentry/core'; import { expect, it } from 'vitest'; import { createRunner } from '../../runner'; function envelopeItemType(envelope: Envelope): string | undefined { return envelope[1][0]?.[0]?.type as string | undefined; } function envelopeItem(envelope: Envelope): Record<string, unknown> { return envelope[1][0]![1] as Record<string, unknown>; } function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> { if (envelopeItemType(envelope) !== 'transaction') return []; const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || []; return spans.filter( s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit', ); } it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); const event = envelopeItem(envelope); expect(event.spans).toEqual([ { data: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, description: 'rate_limit MY_RATE_LIMITER', origin: 'auto.faas.cloudflare.rate_limit', parent_span_id: expect.any(String), span_id: expect.any(String), start_timestamp: expect.any(Number), timestamp: expect.any(Number), trace_id: expect.any(String), }, ]); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/allowed'); expect(response).toEqual({ success: true }); await runner.completed(); }); it('instruments a rate-limited call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); // Both `limit()` calls on the blocked endpoint are instrumented. expect(findRateLimitSpans(envelope)).toHaveLength(2); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/blocked'); expect(response).toEqual({ success: false }); await runner.completed(); }); 13 changes: 13 additions & 0 deletions 13 dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,13 @@ { "name": "worker-name", "compatibility_date": "2025-06-17", "main": "index.ts", "compatibility_flags": ["nodejs_als"], "ratelimits": [ { "name": "MY_RATE_LIMITER", "namespace_id": "1001", "simple": { "limit": 1, "period": 60 }, }, ], } 18 changes: 17 additions & 1 deletion 18 packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,13 +1,21 @@ import { isObjectLike } from '@sentry/core'; import type { CloudflareOptions } from '../../client'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket, isRateLimit, } from '../../utils/isBinding'; import { instrumentD1 } from './instrumentD1'; import { appendRpcMeta } from '../../utils/rpcMeta'; import { getEffectiveRpcPropagation } from '../../utils/rpcOptions'; import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace'; import { instrumentFetcher } from './instrumentFetcher'; import { instrumentQueueProducer } from './instrumentQueueProducer'; import { instrumentR2Bucket } from './instrumentR2'; import { instrumentRateLimit } from './instrumentRateLimit'; function isProxyable(item: unknown): item is object { return isObjectLike(item) || typeof item === 'function'; Expand All @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); * - Service bindings / JSRPC proxies * - Queue producers (via `send` + `sendBatch` duck-typing) * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing) * - Rate limiters (via `limit` duck-typing) * * @param env - The Cloudflare env object to instrument * @param options - Optional CloudflareOptions to control RPC trace propagation Expand DownExpand Up @@ -69,6 +78,13 @@ export function instrumentEnv<Env extends Record<string, unknown>>(env: Env, opt return instrumented; } if (isRateLimit(item)) { const bindingName = typeof prop === 'string' ? prop : String(prop); const instrumented = instrumentRateLimit(item, bindingName); instrumentedBindings.set(item, instrumented); return instrumented; } if (!rpcPropagation) { return item; } Expand Down 31 changes: 31 additions & 0 deletions 31 packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,31 @@ import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types'; import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core'; const ORIGIN = 'auto.faas.cloudflare.rate_limit'; /** * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call. */ export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T { return new Proxy(rateLimit, { get(target, prop, receiver) { if (prop !== 'limit') { return Reflect.get(target, prop, receiver); } const original = Reflect.get(target, prop, receiver) as RateLimit['limit']; return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> { return startSpan( { name: `rate_limit ${bindingName}`, attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN, }, }, () => Reflect.apply(original, target, [options]), ); }; }, }); } Comment threadcursor[bot] marked this conversation as resolved. Uh oh! There was an error while loading. Please reload this page. 13 changes: 12 additions & 1 deletion 13 packages/cloudflare/src/utils/isBinding.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -31,7 +31,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types'; import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types'; /** * Checks if a value is a JSRPC proxy (service binding). Expand DownExpand Up @@ -95,3 +95,14 @@ export function isR2Bucket(item: unknown): item is R2Bucket { typeof item.createMultipartUpload === 'function' ); } /** * Duck-type check for RateLimit bindings. * RateLimit only exposes a single `limit` method. Because that is a fairly * common method name, this check is intentionally run after the more specific * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding * also happens to expose `limit`. */ export function isRateLimit(item: unknown): item is RateLimit { return item != null && isNotJSRPC(item) && typeof item.limit === 'function'; } 28 changes: 28 additions & 0 deletions 28 packages/cloudflare/test/instrumentations/instrumentEnv.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace); }); it('wraps RateLimit bindings in a proxy and forwards calls', async () => { const startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); const limit = vi.fn().mockResolvedValue({ success: true }); const rateLimiter = { limit }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter; // Wrapped binding is a Proxy, not the original reference expect(wrapped).not.toBe(rateLimiter); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(limit).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenCalledWith( expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }), expect.any(Function), ); }); it('caches the wrapped RateLimit binding across repeated access', () => { const rateLimiter = { limit: vi.fn() }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER); }); describe('mTLS Fetcher bindings', () => { function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) { return new Proxy( Expand Down 76 changes: 76 additions & 0 deletions 76 packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,76 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as SentryCore from '@sentry/core'; import type { MockInstance } from 'vitest'; import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit'; function createMockRateLimit(success = true): RateLimit { return { limit: vi.fn().mockResolvedValue({ success }), } as unknown as RateLimit; } describe('instrumentRateLimit', () => { let startSpanSpy: MockInstance; beforeEach(() => { startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); }); afterEach(() => { vi.restoreAllMocks(); }); describe('limit', () => { test('forwards the call and returns the outcome', async () => { const rateLimit = createMockRateLimit(true); const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(rateLimit.limit).toHaveBeenCalledTimes(1); expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' }); }); test('returns an unsuccessful (rate-limited) outcome unchanged', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: false }); }); test('starts a span with the binding name and origin', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'user-123' }); expect(startSpanSpy).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenLastCalledWith( { name: 'rate_limit MY_RATE_LIMITER', attributes: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, }, expect.any(Function), ); }); test('does not record the rate limit key (avoids leaking PII)', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'super-secret-user-id' }); expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id'); }); }); test('forwards unknown property accesses transparently', () => { const rateLimit = Object.assign(createMockRateLimit(), { customMethod: vi.fn().mockReturnValue('hi'), }) as unknown as RateLimit & { customMethod: () => string }; const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string }; expect(wrapped.customMethod()).toBe('hi'); }); }); 33 changes: 32 additions & 1 deletion 33 packages/cloudflare/test/utils/isBinding.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,5 +1,5 @@ import { describe, expect, it } from 'vitest'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding'; describe('isJSRPC', () => { it('returns false for a plain object', () => { Expand DownExpand Up @@ -210,3 +210,34 @@ describe('isD1Database', () => { expect(isD1Database(jsrpcProxy)).toBe(false); }); }); describe('isRateLimit', () => { it('returns true for an object with a limit method', () => { expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true); }); it('returns false when limit is missing', () => { expect(isRateLimit({ foo: 'bar' })).toBe(false); }); it('returns false when limit is not a function', () => { expect(isRateLimit({ limit: 'nope' })).toBe(false); }); it('returns false for null and undefined', () => { expect(isRateLimit(null)).toBe(false); expect(isRateLimit(undefined)).toBe(false); }); it('returns false for a JSRPC proxy even though it returns a function for limit', () => { const jsrpcProxy = new Proxy( {}, { get(_target, _prop) { return () => {}; }, }, ); expect(isRateLimit(jsrpcProxy)).toBe(false); }); }); Loading Oops, something went wrong. Uh oh! There was an error while loading. Please reload this page. 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. Footer © 2026 GitHub, Inc. Footer navigation Terms Privacy Security Status Community Docs Contact You can’t perform that action at this time. , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Skip to contentNavigation Menu Sign inAppearance settings AI CODE CREATIONGitHub CopilotWrite better code with AI GitHub Copilot appDirect agents from issue to merge MCP RegistryIntegrate external tools DEVELOPER WORKFLOWSActionsAutomate any workflow CodespacesInstant dev environments IssuesPlan and track work Code ReviewManage code changes Code QualityEnforce quality at merge APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities Code securitySecure your code as you build Secret protectionStop leaks before they start EXPLOREWhy GitHub Documentation Blog Changelog Marketplace View all features BY COMPANY SIZEEnterprises Small and medium teams Startups Nonprofits BY USE CASEApp Modernization DevSecOps DevOps CI/CD View all use cases BY INDUSTRYHealthcare Financial services Manufacturing Government View all industries View all solutions EXPLORE BY TOPICAI Software Development DevOps Security View all topics EXPLORE BY TYPECustomer stories Events & webinars Ebooks & reports Business insights GitHub Skills SUPPORT & SERVICESDocumentation Customer support Community forum Trust center Partners View all resources COMMUNITYGitHub SponsorsFund open source developers PROGRAMSSecurity Lab Maintainer Community GitHub Stars Archive Program REPOSITORIESTopics Trending Collections ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features Copilot for BusinessEnterprise-grade AI features Premium SupportEnterprise-grade 24/7 support Pricing Sign in Sign upAppearance settings You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert Uh oh! There was an error while loading. Please reload this page. getsentry /sentry-javascriptPublic Uh oh! There was an error while loading. Please reload this page. Notifications You must be signed in to change notification settings Fork 1.8k Star 8.7k Code Issues589 Pull requests70 Discussions Actions Security and quality5 Insights Additional navigation options Code Issues Pull requests Discussions Actions Security and quality Insights feat(cloudflare): Instrument Cloudflare rate limiter bindings#22035 New issue Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community. Sign up for GitHub By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails. Already on GitHub? Sign in to your account Merged JPeer264 merged 5 commits into getsentry:develop from PeterWadie:feat/cloudflare-rate-limit-instrumentationJul 17, 2026 Conversation 34 Commits 5 Checks 86 Files changed Uh oh! There was an error while loading. Please reload this page. Merged feat(cloudflare): Instrument Cloudflare rate limiter bindings #22035 Show file tree Hide file tree Changes from all commits Commits Show all changes 5 commits Select commit Hold shift + click to select a range 53a0a03 feat(cloudflare): Instrument Cloudflare rate limiter bindings PeterWadie Jul 8, 2026d2be645 test(cloudflare): Add rate limiter binding integration test PeterWadie Jul 8, 20262504ba9 ref(cloudflare): Address review feedback on rate limiter instrumentation PeterWadie Jul 13, 20260f63dd7 test(cloudflare): Filter rate limiter spans by data['sentry.origin'] PeterWadie Jul 13, 20264a9eb20 Merge branch 'develop' into feat/cloudflare-rate-limit-instrumentation PeterWadie Jul 14, 2026 File filter Filter by extension Filter by extension .jsonc (1) .ts (8) All 2 file types selected Viewed files Clear filters Conversations Failed to load comments. Loading Uh oh! There was an error while loading. Please reload this page. Jump to Jump to file Failed to load files. Loading Uh oh! There was an error while loading. Please reload this page. Diff view Unified Split Hide whitespace Diff view Unified Split Hide whitespace dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts index.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts test.ts dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc wrangler.jsonc packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts instrumentEnv.ts packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts instrumentRateLimit.ts packages/cloudflare/src/utils/isBinding.ts isBinding.ts packages/cloudflare/test/instrumentations/instrumentEnv.test.ts instrumentEnv.test.ts packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts instrumentRateLimit.test.ts packages/cloudflare/test/utils/isBinding.test.ts isBinding.test.ts Some comments aren't visible on the classic Files Changed page. There are no files selected for viewing 37 changes: 37 additions & 0 deletions 37 dev-packages/cloudflare-integration-tests/suites/ratelimit/index.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,37 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as Sentry from '@sentry/cloudflare'; interface Env { SENTRY_DSN: string; MY_RATE_LIMITER: RateLimit; } function json(data: unknown): Response { return new Response(JSON.stringify(data), { headers: { 'content-type': 'application/json' } }); } export default Sentry.withSentry( (env: Env) => ({ dsn: env.SENTRY_DSN, tracesSampleRate: 1, }), { async fetch(request, env) { const url = new URL(request.url); if (url.pathname === '/ratelimit/allowed') { const outcome = await env.MY_RATE_LIMITER.limit({ key: 'allowed-key' }); return json(outcome); } if (url.pathname === '/ratelimit/blocked') { // The binding's limit is 1, so the second call within the period is rate limited. await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); const outcome = await env.MY_RATE_LIMITER.limit({ key: 'blocked-key' }); return json(outcome); } return new Response('not found', { status: 404 }); }, } as ExportedHandler<Env>, ); 63 changes: 63 additions & 0 deletions 63 dev-packages/cloudflare-integration-tests/suites/ratelimit/test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,63 @@ import type { Envelope } from '@sentry/core'; import { expect, it } from 'vitest'; import { createRunner } from '../../runner'; function envelopeItemType(envelope: Envelope): string | undefined { return envelope[1][0]?.[0]?.type as string | undefined; } function envelopeItem(envelope: Envelope): Record<string, unknown> { return envelope[1][0]![1] as Record<string, unknown>; } function findRateLimitSpans(envelope: Envelope): Array<Record<string, unknown>> { if (envelopeItemType(envelope) !== 'transaction') return []; const spans = (envelopeItem(envelope).spans as Array<Record<string, unknown>>) || []; return spans.filter( s => (s.data as Record<string, unknown> | undefined)?.['sentry.origin'] === 'auto.faas.cloudflare.rate_limit', ); } it('instruments an allowed rate limiter call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); const event = envelopeItem(envelope); expect(event.spans).toEqual([ { data: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, description: 'rate_limit MY_RATE_LIMITER', origin: 'auto.faas.cloudflare.rate_limit', parent_span_id: expect.any(String), span_id: expect.any(String), start_timestamp: expect.any(Number), timestamp: expect.any(Number), trace_id: expect.any(String), }, ]); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/allowed'); expect(response).toEqual({ success: true }); await runner.completed(); }); it('instruments a rate-limited call automatically via env', async ({ signal }) => { const runner = createRunner(__dirname) .ignore('event') .expect((envelope: Envelope) => { expect(envelopeItemType(envelope)).toBe('transaction'); // Both `limit()` calls on the blocked endpoint are instrumented. expect(findRateLimitSpans(envelope)).toHaveLength(2); }) .start(signal); const response = await runner.makeRequest('get', '/ratelimit/blocked'); expect(response).toEqual({ success: false }); await runner.completed(); }); 13 changes: 13 additions & 0 deletions 13 dev-packages/cloudflare-integration-tests/suites/ratelimit/wrangler.jsonc Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,13 @@ { "name": "worker-name", "compatibility_date": "2025-06-17", "main": "index.ts", "compatibility_flags": ["nodejs_als"], "ratelimits": [ { "name": "MY_RATE_LIMITER", "namespace_id": "1001", "simple": { "limit": 1, "period": 60 }, }, ], } 18 changes: 17 additions & 1 deletion 18 packages/cloudflare/src/instrumentations/worker/instrumentEnv.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,13 +1,21 @@ import { isObjectLike } from '@sentry/core'; import type { CloudflareOptions } from '../../client'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket } from '../../utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isR2Bucket, isRateLimit, } from '../../utils/isBinding'; import { instrumentD1 } from './instrumentD1'; import { appendRpcMeta } from '../../utils/rpcMeta'; import { getEffectiveRpcPropagation } from '../../utils/rpcOptions'; import { instrumentDurableObjectNamespace, STUB_NON_RPC_METHODS } from '../instrumentDurableObjectNamespace'; import { instrumentFetcher } from './instrumentFetcher'; import { instrumentQueueProducer } from './instrumentQueueProducer'; import { instrumentR2Bucket } from './instrumentR2'; import { instrumentRateLimit } from './instrumentRateLimit'; function isProxyable(item: unknown): item is object { return isObjectLike(item) || typeof item === 'function'; Expand All @@ -24,6 +32,7 @@ const instrumentedBindings = new WeakMap<object, unknown>(); * - Service bindings / JSRPC proxies * - Queue producers (via `send` + `sendBatch` duck-typing) * - R2 Buckets (via `head` + `put` + `createMultipartUpload` duck-typing) * - Rate limiters (via `limit` duck-typing) * * @param env - The Cloudflare env object to instrument * @param options - Optional CloudflareOptions to control RPC trace propagation Expand DownExpand Up @@ -69,6 +78,13 @@ export function instrumentEnv<Env extends Record<string, unknown>>(env: Env, opt return instrumented; } if (isRateLimit(item)) { const bindingName = typeof prop === 'string' ? prop : String(prop); const instrumented = instrumentRateLimit(item, bindingName); instrumentedBindings.set(item, instrumented); return instrumented; } if (!rpcPropagation) { return item; } Expand Down 31 changes: 31 additions & 0 deletions 31 packages/cloudflare/src/instrumentations/worker/instrumentRateLimit.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,31 @@ import type { RateLimit, RateLimitOptions, RateLimitOutcome } from '@cloudflare/workers-types'; import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core'; const ORIGIN = 'auto.faas.cloudflare.rate_limit'; /** * Wraps a Cloudflare rate limiter binding to create a span on each `limit()` call. */ export function instrumentRateLimit<T extends RateLimit>(rateLimit: T, bindingName: string): T { return new Proxy(rateLimit, { get(target, prop, receiver) { if (prop !== 'limit') { return Reflect.get(target, prop, receiver); } const original = Reflect.get(target, prop, receiver) as RateLimit['limit']; return function (this: unknown, options: RateLimitOptions): Promise<RateLimitOutcome> { return startSpan( { name: `rate_limit ${bindingName}`, attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN, }, }, () => Reflect.apply(original, target, [options]), ); }; }, }); } Comment threadcursor[bot] marked this conversation as resolved. Uh oh! There was an error while loading. Please reload this page. 13 changes: 12 additions & 1 deletion 13 packages/cloudflare/src/utils/isBinding.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -31,7 +31,7 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ import type { D1Database, DurableObjectNamespace, Queue, R2Bucket } from '@cloudflare/workers-types'; import type { D1Database, DurableObjectNamespace, Queue, R2Bucket, RateLimit } from '@cloudflare/workers-types'; /** * Checks if a value is a JSRPC proxy (service binding). Expand DownExpand Up @@ -95,3 +95,14 @@ export function isR2Bucket(item: unknown): item is R2Bucket { typeof item.createMultipartUpload === 'function' ); } /** * Duck-type check for RateLimit bindings. * RateLimit only exposes a single `limit` method. Because that is a fairly * common method name, this check is intentionally run after the more specific * binding checks (Queue, R2, D1) in `instrumentEnv`, so those win when a binding * also happens to expose `limit`. */ export function isRateLimit(item: unknown): item is RateLimit { return item != null && isNotJSRPC(item) && typeof item.limit === 'function'; } 28 changes: 28 additions & 0 deletions 28 packages/cloudflare/test/instrumentations/instrumentEnv.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change Expand Up @@ -256,6 +256,34 @@ describe('instrumentEnv', () => { expect(instrumentDurableObjectNamespace).toHaveBeenCalledWith(doNamespace); }); it('wraps RateLimit bindings in a proxy and forwards calls', async () => { const startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); const limit = vi.fn().mockResolvedValue({ success: true }); const rateLimiter = { limit }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); const wrapped = instrumented.MY_RATE_LIMITER as typeof rateLimiter; // Wrapped binding is a Proxy, not the original reference expect(wrapped).not.toBe(rateLimiter); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(limit).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenCalledWith( expect.objectContaining({ name: 'rate_limit MY_RATE_LIMITER' }), expect.any(Function), ); }); it('caches the wrapped RateLimit binding across repeated access', () => { const rateLimiter = { limit: vi.fn() }; const env = { MY_RATE_LIMITER: rateLimiter }; const instrumented = instrumentEnv(env); expect(instrumented.MY_RATE_LIMITER).toBe(instrumented.MY_RATE_LIMITER); }); describe('mTLS Fetcher bindings', () => { function createMtlsFetcherProxy(mockFetch: ReturnType<typeof vi.fn>) { return new Proxy( Expand Down 76 changes: 76 additions & 0 deletions 76 packages/cloudflare/test/instrumentations/worker/instrumentRateLimit.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -0,0 +1,76 @@ import type { RateLimit } from '@cloudflare/workers-types'; import * as SentryCore from '@sentry/core'; import type { MockInstance } from 'vitest'; import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; import { instrumentRateLimit } from '../../../src/instrumentations/worker/instrumentRateLimit'; function createMockRateLimit(success = true): RateLimit { return { limit: vi.fn().mockResolvedValue({ success }), } as unknown as RateLimit; } describe('instrumentRateLimit', () => { let startSpanSpy: MockInstance; beforeEach(() => { startSpanSpy = vi.spyOn(SentryCore, 'startSpan'); }); afterEach(() => { vi.restoreAllMocks(); }); describe('limit', () => { test('forwards the call and returns the outcome', async () => { const rateLimit = createMockRateLimit(true); const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: true }); expect(rateLimit.limit).toHaveBeenCalledTimes(1); expect(rateLimit.limit).toHaveBeenCalledWith({ key: 'user-123' }); }); test('returns an unsuccessful (rate-limited) outcome unchanged', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(false), 'MY_RATE_LIMITER'); const outcome = await wrapped.limit({ key: 'user-123' }); expect(outcome).toEqual({ success: false }); }); test('starts a span with the binding name and origin', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'user-123' }); expect(startSpanSpy).toHaveBeenCalledTimes(1); expect(startSpanSpy).toHaveBeenLastCalledWith( { name: 'rate_limit MY_RATE_LIMITER', attributes: { 'sentry.origin': 'auto.faas.cloudflare.rate_limit', }, }, expect.any(Function), ); }); test('does not record the rate limit key (avoids leaking PII)', async () => { const wrapped = instrumentRateLimit(createMockRateLimit(true), 'MY_RATE_LIMITER'); await wrapped.limit({ key: 'super-secret-user-id' }); expect(JSON.stringify(startSpanSpy.mock.calls[0]![0])).not.toContain('super-secret-user-id'); }); }); test('forwards unknown property accesses transparently', () => { const rateLimit = Object.assign(createMockRateLimit(), { customMethod: vi.fn().mockReturnValue('hi'), }) as unknown as RateLimit & { customMethod: () => string }; const wrapped = instrumentRateLimit(rateLimit, 'MY_RATE_LIMITER') as RateLimit & { customMethod: () => string }; expect(wrapped.customMethod()).toBe('hi'); }); }); 33 changes: 32 additions & 1 deletion 33 packages/cloudflare/test/utils/isBinding.test.ts Show comments View file Open in desktop Original file line number Diff line number Diff line change @@ -1,5 +1,5 @@ import { describe, expect, it } from 'vitest'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue } from '../../src/utils/isBinding'; import { isD1Database, isDurableObjectNamespace, isJSRPC, isQueue, isRateLimit } from '../../src/utils/isBinding'; describe('isJSRPC', () => { it('returns false for a plain object', () => { Expand DownExpand Up @@ -210,3 +210,34 @@ describe('isD1Database', () => { expect(isD1Database(jsrpcProxy)).toBe(false); }); }); describe('isRateLimit', () => { it('returns true for an object with a limit method', () => { expect(isRateLimit({ limit: async () => ({ success: true }) })).toBe(true); }); it('returns false when limit is missing', () => { expect(isRateLimit({ foo: 'bar' })).toBe(false); }); it('returns false when limit is not a function', () => { expect(isRateLimit({ limit: 'nope' })).toBe(false); }); it('returns false for null and undefined', () => { expect(isRateLimit(null)).toBe(false); expect(isRateLimit(undefined)).toBe(false); }); it('returns false for a JSRPC proxy even though it returns a function for limit', () => { const jsrpcProxy = new Proxy( {}, { get(_target, _prop) { return () => {}; }, }, ); expect(isRateLimit(jsrpcProxy)).toBe(false); }); }); Loading Oops, something went wrong. Uh oh! There was an error while loading. Please reload this page. 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. Footer © 2026 GitHub, Inc. Footer navigation Terms Privacy Security Status Community Docs Contact You can’t perform that action at this time.