Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1.8k
fix(node): Always flush on Vercel before Lambda freeze#15602
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
41 changes: 1 addition & 40 deletions
41 packages/node/src/integrations/http/SentryHttpInstrumentation.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
115 changes: 115 additions & 0 deletions
115 packages/node/src/integrations/http/SentryHttpInstrumentationBeforeOtel.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import { VERSION } from '@opentelemetry/core'; | ||
| import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation'; | ||
| import { flush, logger, vercelWaitUntil } from '@sentry/core'; | ||
| import type * as http from 'node:http'; | ||
| import type * as https from 'node:https'; | ||
| import { DEBUG_BUILD } from '../../debug-build'; | ||
| import { stealthWrap } from './utils'; | ||
| type Http = typeof http; | ||
| type Https = typeof https; | ||
| /** | ||
| * A Sentry specific http instrumentation that is applied before the otel instrumentation. | ||
| */ | ||
| export class SentryHttpInstrumentationBeforeOtel extends InstrumentationBase { | ||
| public constructor() { | ||
| super('@sentry/instrumentation-http-before-otel', VERSION, {}); | ||
| } | ||
| // eslint-disable-next-line jsdoc/require-jsdoc | ||
| public init(): [InstrumentationNodeModuleDefinition, InstrumentationNodeModuleDefinition] { | ||
| return [this._getHttpsInstrumentation(), this._getHttpInstrumentation()]; | ||
| } | ||
| /** Get the instrumentation for the http module. */ | ||
| private _getHttpInstrumentation(): InstrumentationNodeModuleDefinition { | ||
| return new InstrumentationNodeModuleDefinition('http', ['*'], (moduleExports: Http): Http => { | ||
| // Patch incoming requests | ||
| stealthWrap(moduleExports.Server.prototype, 'emit', this._getPatchIncomingRequestFunction()); | ||
| return moduleExports; | ||
| }); | ||
| } | ||
| /** Get the instrumentation for the https module. */ | ||
| private _getHttpsInstrumentation(): InstrumentationNodeModuleDefinition { | ||
| return new InstrumentationNodeModuleDefinition('https', ['*'], (moduleExports: Https): Https => { | ||
| // Patch incoming requests | ||
| stealthWrap(moduleExports.Server.prototype, 'emit', this._getPatchIncomingRequestFunction()); | ||
| return moduleExports; | ||
| }); | ||
| } | ||
| /** | ||
| * Patch the incoming request function for request isolation. | ||
| */ | ||
| private _getPatchIncomingRequestFunction(): ( | ||
| original: (event: string, ...args: unknown[]) => boolean, | ||
| ) => (this: unknown, event: string, ...args: unknown[]) => boolean { | ||
| return ( | ||
| original: (event: string, ...args: unknown[]) => boolean, | ||
| ): ((this: unknown, event: string, ...args: unknown[]) => boolean) => { | ||
| return function incomingRequest(this: unknown, event: string, ...args: unknown[]): boolean { | ||
| // Only traces request events | ||
| if (event !== 'request') { | ||
| return original.apply(this, [event, ...args]); | ||
| } | ||
| const response = args[1] as http.OutgoingMessage; | ||
| patchResponseToFlushOnServerlessPlatforms(response); | ||
| return original.apply(this, [event, ...args]); | ||
| }; | ||
| }; | ||
| } | ||
| } | ||
| function patchResponseToFlushOnServerlessPlatforms(res: http.OutgoingMessage): void { | ||
| // Freely extend this function with other platforms if necessary | ||
| if (process.env.VERCEL) { | ||
| let markOnEndDone = (): void => undefined; | ||
| const onEndDonePromise = new Promise<void>(res => { | ||
| markOnEndDone = res; | ||
| }); | ||
| res.on('close', () => { | ||
| markOnEndDone(); | ||
| }); | ||
| // eslint-disable-next-line @typescript-eslint/unbound-method | ||
| res.end = new Proxy(res.end, { | ||
| apply(target, thisArg, argArray) { | ||
| vercelWaitUntil( | ||
| new Promise<void>(finishWaitUntil => { | ||
| // Define a timeout that unblocks the lambda just to be safe so we're not indefinitely keeping it alive, exploding server bills | ||
| const timeout = setTimeout(() => { | ||
| finishWaitUntil(); | ||
| }, 2000); | ||
| onEndDonePromise | ||
| .then(() => { | ||
| DEBUG_BUILD && logger.log('Flushing events before Vercel Lambda freeze'); | ||
| return flush(2000); | ||
| }) | ||
| .then( | ||
| () => { | ||
| clearTimeout(timeout); | ||
| finishWaitUntil(); | ||
| }, | ||
| e => { | ||
| clearTimeout(timeout); | ||
| DEBUG_BUILD && logger.log('Error while flushing events for Vercel:\n', e); | ||
| finishWaitUntil(); | ||
| }, | ||
| ); | ||
| }), | ||
| ); | ||
| return target.apply(thisArg, argArray); | ||
| }, | ||
| }); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /** | ||
| * This is a minimal version of `wrap` from shimmer: | ||
| * https://github.com/othiym23/shimmer/blob/master/index.js | ||
| * | ||
| * In contrast to the original implementation, this version does not allow to unwrap, | ||
| * and does not make it clear that the method is wrapped. | ||
| * This is necessary because we want to wrap the http module with our own code, | ||
| * while still allowing to use the HttpInstrumentation from OTEL. | ||
| * | ||
| * Without this, if we'd just use `wrap` from shimmer, the OTEL instrumentation would remove our wrapping, | ||
| * because it only allows any module to be wrapped a single time. | ||
| */ | ||
| export function stealthWrap<Nodule extends object, FieldName extends keyof Nodule>( | ||
| nodule: Nodule, | ||
| name: FieldName, | ||
| wrapper: (original: Nodule[FieldName]) => Nodule[FieldName], | ||
| ): Nodule[FieldName] { | ||
| const original = nodule[name]; | ||
| const wrapped = wrapper(original); | ||
| defineProperty(nodule, name, wrapped); | ||
| return wrapped; | ||
| } | ||
| // Sets a property on an object, preserving its enumerability. | ||
| function defineProperty<Nodule extends object, FieldName extends keyof Nodule>( | ||
| obj: Nodule, | ||
| name: FieldName, | ||
| value: Nodule[FieldName], | ||
| ): void { | ||
| const enumerable = !!obj[name] && Object.prototype.propertyIsEnumerable.call(obj, name); | ||
| Object.defineProperty(obj, name, { | ||
| configurable: true, | ||
| enumerable: enumerable, | ||
| writable: true, | ||
| value: value, | ||
| }); | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just saw this now, could you add the reasoning for this (that is in the PR description) as a comment here too? Was super confused why this exists, and it's not really clear from the code alone why this is necessary! @lforst