feat(cloudflare): Add instrumentWorkflowWithSentry to instrument workflows
#16672
Conversation
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
timfish
commented
Jun 22, 2025
| return wrapRequestHandler({ options, request: context.request, context }, () => context.next()); | ||
| return wrapRequestHandler({ options, request: context.request, context: { ...context, props: {} } }, () => | ||
| context.next(), | ||
| ); |
There was a problem hiding this comment.
This change was due to updating to the latest Cloudflare types.
ExecutionContext now has a props property which isn't on EventPluginContext.
timfish
commented
Jun 22, 2025
| @@ -34,7 +34,7 @@ export function initCloudflareSentryHandle(options: CloudflareOptions): Handle { | |||
| return wrapRequestHandler( | |||
| { | |||
| options: opts, | |||
| request: event.request, | |||
| request: event.request as Request<unknown, IncomingRequestCfProperties<unknown>>, | |||
There was a problem hiding this comment.
Type updates also broke this...
❌ Unsupported file format
|
AbhiPrasad
reviewed
Jun 23, 2025
…try/sentry-javascript into timfish/feat/cloudflare-workflows
AbhiPrasad
approved these changes
Jun 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It was tricky to instrument Cloudflare workflows! The code for a workflow might look simple but there is a lot of clever shenanigans going on under the hood in the runtime to allow suspension of workflows. Workflows can be hibernated at any time and all state/context inside the your workflow class and elsewhere is lost. Ideally we want all of our step runs to have the same
trace_idso all steps in a workflow run are linked together and all steps should have the same sampling decision.To work around the state limitations, we use the workflow
instanceIdas both the Sentrytrace_idand the last 4 characters are used to generate thesample_randused in the sampling decision. Cloudflare uses uuid's by default forinstanceIdbut users do have the option of passing their own IDs. If users are supplying their owninstanceId's, they need to be both random and a 32 character uuid (with or without hyphens) or the Sentry instrumentation will throw an error.Points worthy of note:
enableDedupeconfig option (docs hidden) which removes thededupeIntegrationfor workflows. We want to get duplicate errors for step retriesWorkflowStepobject in another class. The Cloudflare step object is native so it's properties can't be overridden or proxiedin_app: falsestep.sleep,step.sleepUntilorstep.waitForEventbecause code doesn't run after the Cloudflare native function returnssetPropagationContextdirectly on the isolation context didn't work. It needed anotherwithScopeinside forsetPropagationContextto work. @mydea is that expected?Here is an example trace showing the final step failing (throwing) 6 times before completing successfully. The exponential retry backoff is clearly visible.