Skip to content
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

[worker] Document response stream disconnected error #18567

Open
wants to merge 2 commits into
base: production
Choose a base branch
from

Conversation

jackatbancast
Copy link

Summary

This change documents the responseStreamDisconnected event outcome seen in CloudFlare worker logs and error metrics.

Previously, this outcome doesn't appear to be documented, but presents as an error in metrics and presents as a non-error entry in the CloudFlare Worker Logs. This change aims to reduce confusion going forward.

Changes introducing responseStreamDisconnected: cloudflare/workerd#2503

Documentation checklist

Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 files reviewed, 1 total issue(s) found.

src/content/docs/workers/observability/errors.mdx Outdated Show resolved Hide resolved
This change documents the `responseStreamDisconnected` error `outcome`
seen in CloudFlare worker logs and error metrics.

Previously, this outcome doesn't appear to be documented, but presents
as an error in metrics and presents as a non-error entry in the
CloudFlare Worker Logs. This change aims to reduce confusion going forward.

Changes introducing `responseStreamDisconnected`: cloudflare/workerd#2503
@jackatbancast jackatbancast force-pushed the worker-add-responseStreamDisconnected-explanation branch from c63fc4e to ad090c0 Compare December 5, 2024 01:13
@irvinebroque
Copy link
Contributor

@jclee

@jclee
Copy link
Contributor

jclee commented Dec 6, 2024

@jclee

Looks reasonable to me, FWIW.

@ToriLindsay
Copy link
Contributor

@jackatbancast @jclee
This has been added as a sub-heading under "Runtime errors". Is this the best placement for it in the article? Would it make more sense to add it to the error message table that is directly above it? (See screenshot)
Screenshot 2025-01-06 at 3 45 03 PM

@jackatbancast
Copy link
Author

@ToriLindsay thank you for the feedback and the suggestions.

I'd initially considered adding this to the table mentioned, but I don't believe it quite fits there as we don't get an error message in the logs, instead getting an outcome that looks like an error through the metrics interface.

This being said, I'm not sure if this page is the best place for this content at all given that it is not an error log, but I thought it would be best to make it slightly more discoverable.

I'm happy to defer to guidance on where this would be best placed.

@ToriLindsay
Copy link
Contributor

@jackatbancast Thanks for the context!
In that case, would it make more sense to put it in the section directly below: "Identify errors: Workers Metrics" ?
Screenshot 2025-01-07 at 11 35 45 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:workers Related to Workers product size/xs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants