-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cloudflare): Add plugin for cloudflare pages
- Loading branch information
1 parent
2d43b64
commit a793bd5
Showing
9 changed files
with
506 additions
and
355 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import { setAsyncLocalStorageAsyncContextStrategy } from './async'; | ||
| import type { CloudflareOptions } from './client'; | ||
| import { wrapRequestHandler } from './request'; | ||
|
|
||
| /** | ||
| * | ||
| * @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()); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| import type { ExecutionContext, 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 { Scope, SpanAttributes } from '@sentry/types'; | ||
| import { stripUrlQueryAndFragment, winterCGRequestToRequestData } from '@sentry/utils'; | ||
| import type { CloudflareOptions } from './client'; | ||
| import { init } from './sdk'; | ||
|
|
||
| interface RequestHandlerWrapperOptions { | ||
| options: CloudflareOptions; | ||
| request: Request<unknown, IncomingRequestCfProperties<unknown>>; | ||
| context: ExecutionContext; | ||
| } | ||
|
|
||
| /** | ||
| * Wraps a cloudflare request handler in Sentry instrumentation | ||
| */ | ||
| export function wrapRequestHandler( | ||
| wrapperOptions: RequestHandlerWrapperOptions, | ||
| handler: (...args: unknown[]) => Response | Promise<Response>, | ||
| ): Promise<Response> { | ||
| return withIsolationScope(async isolationScope => { | ||
| const { options, request, context } = wrapperOptions; | ||
| 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 | ||
| } | ||
|
|
||
| addCloudResourceContext(isolationScope); | ||
| if (request) { | ||
| addRequest(isolationScope, request); | ||
| 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 handler(); | ||
| setHttpStatus(span, res.status); | ||
| return res; | ||
| } catch (e) { | ||
| captureException(e, { mechanism: { handled: false, type: 'cloudflare' } }); | ||
| throw e; | ||
| } finally { | ||
| context.waitUntil(flush(2000)); | ||
| } | ||
| }, | ||
| ); | ||
| }, | ||
| ); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Set cloud resource context on scope. | ||
| */ | ||
| function addCloudResourceContext(scope: Scope): void { | ||
| scope.setContext('cloud_resource', { | ||
| 'cloud.provider': 'cloudflare', | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Set culture context on scope | ||
| */ | ||
| function addCultureContext(scope: Scope, cf: IncomingRequestCfProperties): void { | ||
| scope.setContext('culture', { | ||
| timezone: cf.timezone, | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Set request data on scope | ||
| */ | ||
| function addRequest(scope: Scope, request: Request): void { | ||
| scope.setSDKProcessingMetadata({ request: winterCGRequestToRequestData(request) }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.