[worker] Document response stream disconnected error

[jackatbancast]

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

• The documentation style guide has been adhered to.

[hyperlint-ai]

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

[irvinebroque]

@jclee

[jclee]

@jclee

Looks reasonable to me, FWIW.

[ToriLindsay]

@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)

[jackatbancast]

@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]

@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" ?

[ToriLindsay]

@GregBrimble @jasnell Would either of you mind confirming that the location that I moved this info to in the docs makes sense?
(Tldr: The contributor confirmed that it didn't belong under "Runtime errors", where he originally had it, so I moved it to "Identify errors: Workers Metrics" instead because I thought it might make more sense there.)

[jackatbancast]

@ToriLindsay, thank you for making these changes. I was planning to pick this back up today after closing off other priorities. I think the change makes sense from my side, thank you for actioning your feedback.

[holopin-bot]

Congratulations @jackatbancast, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm7j96j4v78640cjvzqvqeoia

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!