feat(cloudflare): Add plugin for cloudflare pages#13123

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
AbhiPrasad merged 1 commit into from
Jul 31, 2024
Merged

feat(cloudflare): Add plugin for cloudflare pages #13123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
dsn: __PUBLIC_DSN__,
// Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down
53 changes: 46 additions & 7 deletions packages/cloudflare/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
</a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
dsn: process.env.SENTRY_DSN,
// Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
// Make sure Sentry is the first middleware
Sentry.sentryPagesPlugin({
dsn: process.env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
// Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down
104 changes: 5 additions & 99 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
ExportedHandler,
ExportedHandlerFetchHandler,
IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
captureException,
continueTrace,
flush,
setHttpStatus,
startSpan,
withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
* Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
handler.fetch = new Proxy(handler.fetch, {
apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
const [request, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,
};

const contentLength = request.headers.get('content-length');
if (contentLength) {
attributes['http.request.body.size'] = parseInt(contentLength, 10);
}

let pathname = '';
try {
const url = new URL(request.url);
pathname = url.pathname;
attributes['server.address'] = url.hostname;
attributes['url.scheme'] = url.protocol.replace(':', '');
} catch {
// skip
}

addRequest(isolationScope, request);
addCloudResourceContext(isolationScope);
if (request.cf) {
addCultureContext(isolationScope, request.cf);
attributes['network.protocol.name'] = request.cf.httpProtocol;
}

const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

return continueTrace(
{ sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
() => {
// Note: This span will not have a duration unless I/O happens in the handler. This is
// because of how the cloudflare workers runtime works.
// See: https://developers.cloudflare.com/workers/runtime-apis/performance/
return startSpan(
{
name: routeName,
attributes,
},
async span => {
try {
const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
setHttpStatus(span, res.status);
return res;
} catch (e) {
captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
throw e;
} finally {
context.waitUntil(flush(2000));
}
},
);
},
);
});
const options = optionsCallback(env);
return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
},
});

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
isolationScope.setContext('cloud_resource', {
'cloud.provider': 'cloudflare',
});
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
isolationScope.setContext('culture', {
timezone: cf.timezone,
});
}

function addRequest(isolationScope: Scope, request: Request): void {
isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}
1 change: 1 addition & 0 deletions packages/cloudflare/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down
32 changes: 32 additions & 0 deletions packages/cloudflare/src/pages-plugin.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
* Plugin middleware for Cloudflare Pages.
*
* Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
*
* @example
* ```javascript
* // functions/_middleware.js
* import * as Sentry from '@sentry/cloudflare';
*
* export const onRequest = Sentry.sentryPagesPlugin({
* dsn: process.env.SENTRY_DSN,
* tracesSampleRate: 1.0,
* });
* ```
*
* @param _options
* @returns
*/
export function sentryPagesPlugin<
Env = unknown,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Params extends string = any,
Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
setAsyncLocalStorageAsyncContextStrategy();
return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 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 content
feat(cloudflare): Add plugin for cloudflare pages#13123

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

AbhiPrasad
merged 1 commit into

from

Jul 31, 2024
 Merged


feat(cloudflare): Add plugin for cloudflare pages
#13123
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 22 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: __PUBLIC_DSN__,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down

53 changes: 46 additions & 7 deletions
packages/cloudflare/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 </a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
 // Make sure Sentry is the first middleware
 Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 tracesSampleRate: 1.0,
 }),
 // Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down

104 changes: 5 additions & 99 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 flush,
 setHttpStatus,
 startSpan,
 withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
 * Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 ['http.request.method']: request.method,
 ['url.full']: request.url,
 };

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }

 addRequest(isolationScope, request);
 addCloudResourceContext(isolationScope);
 if (request.cf) {
 addCultureContext(isolationScope, request.cf);
 attributes['network.protocol.name'] = request.cf.httpProtocol;
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Note: This span will not have a duration unless I/O happens in the handler. This is
 // because of how the cloudflare workers runtime works.
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 attributes,
 },
 async span => {
 try {
 const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
 setHttpStatus(span, res.status);
 return res;
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 },
 );
 });
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

 return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
 isolationScope.setContext('cloud_resource', {
 'cloud.provider': 'cloudflare',
 });
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
 isolationScope.setContext('culture', {
 timezone: cf.timezone,
 });
}

function addRequest(isolationScope: Scope, request: Request): void {
 isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down

32 changes: 32 additions & 0 deletions
packages/cloudflare/src/pages-plugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
 * Plugin middleware for Cloudflare Pages.
 *
 * Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
 *
 * @example
 * ```javascript
 * // functions/_middleware.js
 * import * as Sentry from '@sentry/cloudflare';
 *
 * export const onRequest = Sentry.sentryPagesPlugin({
 * dsn: process.env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * });
 * ```
 *
 * @param _options
 * @returns
 */
export function sentryPagesPlugin<
 Env = unknown,
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
 setAsyncLocalStorageAsyncContextStrategy();
 return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading

, '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 content
feat(cloudflare): Add plugin for cloudflare pages#13123

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

AbhiPrasad
merged 1 commit into

from

Jul 31, 2024
 Merged


feat(cloudflare): Add plugin for cloudflare pages
#13123
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 22 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: __PUBLIC_DSN__,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down

53 changes: 46 additions & 7 deletions
packages/cloudflare/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 </a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
 // Make sure Sentry is the first middleware
 Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 tracesSampleRate: 1.0,
 }),
 // Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down

104 changes: 5 additions & 99 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 flush,
 setHttpStatus,
 startSpan,
 withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
 * Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 ['http.request.method']: request.method,
 ['url.full']: request.url,
 };

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }

 addRequest(isolationScope, request);
 addCloudResourceContext(isolationScope);
 if (request.cf) {
 addCultureContext(isolationScope, request.cf);
 attributes['network.protocol.name'] = request.cf.httpProtocol;
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Note: This span will not have a duration unless I/O happens in the handler. This is
 // because of how the cloudflare workers runtime works.
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 attributes,
 },
 async span => {
 try {
 const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
 setHttpStatus(span, res.status);
 return res;
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 },
 );
 });
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

 return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
 isolationScope.setContext('cloud_resource', {
 'cloud.provider': 'cloudflare',
 });
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
 isolationScope.setContext('culture', {
 timezone: cf.timezone,
 });
}

function addRequest(isolationScope: Scope, request: Request): void {
 isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down

32 changes: 32 additions & 0 deletions
packages/cloudflare/src/pages-plugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
 * Plugin middleware for Cloudflare Pages.
 *
 * Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
 *
 * @example
 * ```javascript
 * // functions/_middleware.js
 * import * as Sentry from '@sentry/cloudflare';
 *
 * export const onRequest = Sentry.sentryPagesPlugin({
 * dsn: process.env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * });
 * ```
 *
 * @param _options
 * @returns
 */
export function sentryPagesPlugin<
 Env = unknown,
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
 setAsyncLocalStorageAsyncContextStrategy();
 return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading

, '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 content
feat(cloudflare): Add plugin for cloudflare pages#13123

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

AbhiPrasad
merged 1 commit into

from

Jul 31, 2024
 Merged


feat(cloudflare): Add plugin for cloudflare pages
#13123
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 22 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: __PUBLIC_DSN__,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down

53 changes: 46 additions & 7 deletions
packages/cloudflare/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 </a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
 // Make sure Sentry is the first middleware
 Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 tracesSampleRate: 1.0,
 }),
 // Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down

104 changes: 5 additions & 99 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 flush,
 setHttpStatus,
 startSpan,
 withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
 * Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 ['http.request.method']: request.method,
 ['url.full']: request.url,
 };

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }

 addRequest(isolationScope, request);
 addCloudResourceContext(isolationScope);
 if (request.cf) {
 addCultureContext(isolationScope, request.cf);
 attributes['network.protocol.name'] = request.cf.httpProtocol;
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Note: This span will not have a duration unless I/O happens in the handler. This is
 // because of how the cloudflare workers runtime works.
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 attributes,
 },
 async span => {
 try {
 const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
 setHttpStatus(span, res.status);
 return res;
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 },
 );
 });
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

 return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
 isolationScope.setContext('cloud_resource', {
 'cloud.provider': 'cloudflare',
 });
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
 isolationScope.setContext('culture', {
 timezone: cf.timezone,
 });
}

function addRequest(isolationScope: Scope, request: Request): void {
 isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down

32 changes: 32 additions & 0 deletions
packages/cloudflare/src/pages-plugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
 * Plugin middleware for Cloudflare Pages.
 *
 * Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
 *
 * @example
 * ```javascript
 * // functions/_middleware.js
 * import * as Sentry from '@sentry/cloudflare';
 *
 * export const onRequest = Sentry.sentryPagesPlugin({
 * dsn: process.env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * });
 * ```
 *
 * @param _options
 * @returns
 */
export function sentryPagesPlugin<
 Env = unknown,
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
 setAsyncLocalStorageAsyncContextStrategy();
 return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading

, '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 content
feat(cloudflare): Add plugin for cloudflare pages#13123

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

AbhiPrasad
merged 1 commit into

from

Jul 31, 2024
 Merged


feat(cloudflare): Add plugin for cloudflare pages
#13123
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 22 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: __PUBLIC_DSN__,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down

53 changes: 46 additions & 7 deletions
packages/cloudflare/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 </a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
 // Make sure Sentry is the first middleware
 Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 tracesSampleRate: 1.0,
 }),
 // Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down

104 changes: 5 additions & 99 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 flush,
 setHttpStatus,
 startSpan,
 withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
 * Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 ['http.request.method']: request.method,
 ['url.full']: request.url,
 };

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }

 addRequest(isolationScope, request);
 addCloudResourceContext(isolationScope);
 if (request.cf) {
 addCultureContext(isolationScope, request.cf);
 attributes['network.protocol.name'] = request.cf.httpProtocol;
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Note: This span will not have a duration unless I/O happens in the handler. This is
 // because of how the cloudflare workers runtime works.
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 attributes,
 },
 async span => {
 try {
 const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
 setHttpStatus(span, res.status);
 return res;
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 },
 );
 });
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

 return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
 isolationScope.setContext('cloud_resource', {
 'cloud.provider': 'cloudflare',
 });
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
 isolationScope.setContext('culture', {
 timezone: cf.timezone,
 });
}

function addRequest(isolationScope: Scope, request: Request): void {
 isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down

32 changes: 32 additions & 0 deletions
packages/cloudflare/src/pages-plugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
 * Plugin middleware for Cloudflare Pages.
 *
 * Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
 *
 * @example
 * ```javascript
 * // functions/_middleware.js
 * import * as Sentry from '@sentry/cloudflare';
 *
 * export const onRequest = Sentry.sentryPagesPlugin({
 * dsn: process.env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * });
 * ```
 *
 * @param _options
 * @returns
 */
export function sentryPagesPlugin<
 Env = unknown,
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
 setAsyncLocalStorageAsyncContextStrategy();
 return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading

, '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 content
feat(cloudflare): Add plugin for cloudflare pages#13123

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

AbhiPrasad
merged 1 commit into

from

Jul 31, 2024
 Merged


feat(cloudflare): Add plugin for cloudflare pages
#13123
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 22 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: __PUBLIC_DSN__,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down

53 changes: 46 additions & 7 deletions
packages/cloudflare/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 </a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
 // Make sure Sentry is the first middleware
 Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 tracesSampleRate: 1.0,
 }),
 // Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down

104 changes: 5 additions & 99 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 flush,
 setHttpStatus,
 startSpan,
 withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
 * Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 ['http.request.method']: request.method,
 ['url.full']: request.url,
 };

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }

 addRequest(isolationScope, request);
 addCloudResourceContext(isolationScope);
 if (request.cf) {
 addCultureContext(isolationScope, request.cf);
 attributes['network.protocol.name'] = request.cf.httpProtocol;
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Note: This span will not have a duration unless I/O happens in the handler. This is
 // because of how the cloudflare workers runtime works.
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 attributes,
 },
 async span => {
 try {
 const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
 setHttpStatus(span, res.status);
 return res;
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 },
 );
 });
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

 return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
 isolationScope.setContext('cloud_resource', {
 'cloud.provider': 'cloudflare',
 });
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
 isolationScope.setContext('culture', {
 timezone: cf.timezone,
 });
}

function addRequest(isolationScope: Scope, request: Request): void {
 isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down

32 changes: 32 additions & 0 deletions
packages/cloudflare/src/pages-plugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
 * Plugin middleware for Cloudflare Pages.
 *
 * Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
 *
 * @example
 * ```javascript
 * // functions/_middleware.js
 * import * as Sentry from '@sentry/cloudflare';
 *
 * export const onRequest = Sentry.sentryPagesPlugin({
 * dsn: process.env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * });
 * ```
 *
 * @param _options
 * @returns
 */
export function sentryPagesPlugin<
 Env = unknown,
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
 setAsyncLocalStorageAsyncContextStrategy();
 return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading

, '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 content
feat(cloudflare): Add plugin for cloudflare pages#13123

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

AbhiPrasad
merged 1 commit into

from

Jul 31, 2024
 Merged


feat(cloudflare): Add plugin for cloudflare pages
#13123
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 22 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: __PUBLIC_DSN__,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down

53 changes: 46 additions & 7 deletions
packages/cloudflare/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 </a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
 // Make sure Sentry is the first middleware
 Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 tracesSampleRate: 1.0,
 }),
 // Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down

104 changes: 5 additions & 99 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 flush,
 setHttpStatus,
 startSpan,
 withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
 * Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 ['http.request.method']: request.method,
 ['url.full']: request.url,
 };

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }

 addRequest(isolationScope, request);
 addCloudResourceContext(isolationScope);
 if (request.cf) {
 addCultureContext(isolationScope, request.cf);
 attributes['network.protocol.name'] = request.cf.httpProtocol;
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Note: This span will not have a duration unless I/O happens in the handler. This is
 // because of how the cloudflare workers runtime works.
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 attributes,
 },
 async span => {
 try {
 const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
 setHttpStatus(span, res.status);
 return res;
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 },
 );
 });
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

 return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
 isolationScope.setContext('cloud_resource', {
 'cloud.provider': 'cloudflare',
 });
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
 isolationScope.setContext('culture', {
 timezone: cf.timezone,
 });
}

function addRequest(isolationScope: Scope, request: Request): void {
 isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down

32 changes: 32 additions & 0 deletions
packages/cloudflare/src/pages-plugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
 * Plugin middleware for Cloudflare Pages.
 *
 * Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
 *
 * @example
 * ```javascript
 * // functions/_middleware.js
 * import * as Sentry from '@sentry/cloudflare';
 *
 * export const onRequest = Sentry.sentryPagesPlugin({
 * dsn: process.env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * });
 * ```
 *
 * @param _options
 * @returns
 */
export function sentryPagesPlugin<
 Env = unknown,
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
 setAsyncLocalStorageAsyncContextStrategy();
 return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading

, '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 content
feat(cloudflare): Add plugin for cloudflare pages#13123

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

AbhiPrasad
merged 1 commit into

from

Jul 31, 2024
 Merged


feat(cloudflare): Add plugin for cloudflare pages
#13123
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 22 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,28 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## Unreleased

### Important Changes

- **feat(cloudflare): Add plugin for cloudflare pages (#13123)**

This release adds support for Cloudflare Pages to `@sentry/cloudflare`, our SDK for the
[Cloudflare Workers JavaScript Runtime](https://developers.cloudflare.com/workers/)! For details on how to use it,
please see the [README](./packages/cloudflare/README.md). Any feedback/bug reports are greatly appreciated, please
[reach out on GitHub](https://github.com/getsentry/sentry-javascript/issues/12620).

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: __PUBLIC_DSN__,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

## 8.21.0

### Important Changes
Expand Down

53 changes: 46 additions & 7 deletions
packages/cloudflare/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 </a>
</p>

# Official Sentry SDK for Cloudflare [UNRELEASED]
# Official Sentry SDK for Cloudflare

[![npm version](https://img.shields.io/npm/v/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
[![npm dm](https://img.shields.io/npm/dm/@sentry/cloudflare.svg)](https://www.npmjs.com/package/@sentry/cloudflare)
Expand All@@ -18,9 +18,7 @@
**Note: This SDK is unreleased. Please follow the
[tracking GH issue](https://github.com/getsentry/sentry-javascript/issues/12620) for updates.**

Below details the setup for the Cloudflare Workers. Cloudflare Pages support is in active development.

## Setup (Cloudflare Workers)
## Install

To get started, first install the `@sentry/cloudflare` package:

Expand All@@ -36,6 +34,46 @@ compatibility_flags = ["nodejs_compat"]
# compatibility_flags = ["nodejs_als"]
```

Then you can either setup up the SDK for [Cloudflare Pages](#setup-cloudflare-pages) or
[Cloudflare Workers](#setup-cloudflare-workers).

## Setup (Cloudflare Pages)

To use this SDK, add the `sentryPagesPlugin` as
[middleware to your Cloudflare Pages application](https://developers.cloudflare.com/pages/functions/middleware/).

We recommend adding a `functions/_middleware.js` for the middleware setup so that Sentry is initialized for your entire
app.

```javascript
// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
 tracesSampleRate: 1.0,
});
```

If you need to to chain multiple middlewares, you can do so by exporting an array of middlewares. Make sure the Sentry
middleware is the first one in the array.

```javascript
import * as Sentry from '@sentry/cloudflare';

export const onRequest = [
 // Make sure Sentry is the first middleware
 Sentry.sentryPagesPlugin({
 dsn: process.env.SENTRY_DSN,
 tracesSampleRate: 1.0,
 }),
 // Add more middlewares here
];
```

## Setup (Cloudflare Workers)

To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the
environment. Note that you can turn off almost all side effects using the respective options.

Expand All@@ -58,7 +96,7 @@ export default withSentry(
);
```

### Sourcemaps (Cloudflare Workers)
### Sourcemaps

Configure uploading sourcemaps via the Sentry Wizard:

Expand All@@ -68,10 +106,11 @@ npx @sentry/wizard@latest -i sourcemaps

See more details in our [docs](https://docs.sentry.io/platforms/javascript/sourcemaps/).

## Usage (Cloudflare Workers)
## Usage

To set context information or send manual events, use the exported functions of `@sentry/cloudflare`. Note that these
functions will require your exported handler to be wrapped in `withSentry`.
functions will require the usage of the Sentry helpers, either `withSentry` function for Cloudflare Workers or the
`sentryPagesPlugin` middleware for Cloudflare Pages.

```javascript
import * as Sentry from '@sentry/cloudflare';
Expand Down

104 changes: 5 additions & 99 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 IncomingRequestCfProperties,
} from '@cloudflare/workers-types';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 flush,
 setHttpStatus,
 startSpan,
 withIsolationScope,
} from '@sentry/core';
import type { Options, Scope, SpanAttributes } from '@sentry/types';
import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils';
import type { ExportedHandler, ExportedHandlerFetchHandler } from '@cloudflare/workers-types';
import type { Options } from '@sentry/types';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import { init } from './sdk';
import { wrapRequestHandler } from './request';

/**
 * Extract environment generic from exported handler.
Expand DownExpand Up@@ -47,70 +31,8 @@ export function withSentry<E extends ExportedHandler<any>>(
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare-worker',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 ['http.request.method']: request.method,
 ['url.full']: request.url,
 };

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }

 addRequest(isolationScope, request);
 addCloudResourceContext(isolationScope);
 if (request.cf) {
 addCultureContext(isolationScope, request.cf);
 attributes['network.protocol.name'] = request.cf.httpProtocol;
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Note: This span will not have a duration unless I/O happens in the handler. This is
 // because of how the cloudflare workers runtime works.
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 attributes,
 },
 async span => {
 try {
 const res = await (target.apply(thisArg, args) as ReturnType<typeof target>);
 setHttpStatus(span, res.status);
 return res;
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 },
 );
 });
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

Expand All@@ -120,19 +42,3 @@ export function withSentry<E extends ExportedHandler<any>>(

 return handler;
}

function addCloudResourceContext(isolationScope: Scope): void {
 isolationScope.setContext('cloud_resource', {
 'cloud.provider': 'cloudflare',
 });
}

function addCultureContext(isolationScope: Scope, cf: IncomingRequestCfProperties): void {
 isolationScope.setContext('culture', {
 timezone: cf.timezone,
 });
}

function addRequest(isolationScope: Scope, request: Request): void {
 isolationScope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) });
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { sentryPagesPlugin } from './pages-plugin';

export { CloudflareClient } from './client';
export { getDefaultIntegrations } from './sdk';
Expand Down

32 changes: 32 additions & 0 deletions
packages/cloudflare/src/pages-plugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { wrapRequestHandler } from './request';

/**
 * Plugin middleware for Cloudflare Pages.
 *
 * Initializes the SDK and wraps cloudflare pages requests with SDK instrumentation.
 *
 * @example
 * ```javascript
 * // functions/_middleware.js
 * import * as Sentry from '@sentry/cloudflare';
 *
 * export const onRequest = Sentry.sentryPagesPlugin({
 * dsn: process.env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * });
 * ```
 *
 * @param _options
 * @returns
 */
export function sentryPagesPlugin<
 Env = unknown,
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 Params extends string = any,
 Data extends Record<string, unknown> = Record<string, unknown>,
>(options: CloudflareOptions): PagesPluginFunction<Env, Params, Data, CloudflareOptions> {
 setAsyncLocalStorageAsyncContextStrategy();
 return context => wrapRequestHandler({ options, request: context.request, context }, () => context.next());
}
Loading