Add backpressure sources, error messaging, to backpressure docs #4136
Conversation
conceptualshark
added
component:zeebe
|
👋 🤖 🤔 Hello! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
@conceptualshark I can take a look 👍 |
| @@ -57,17 +57,23 @@ This command can in turn be processed, completing the service task and driving t | |||
|
|
|||
| ## Handling backpressure | |||
There was a problem hiding this comment.
Non-blocking suggestion: Change to "Backpressure"
| When the broker receives more requests than it can process with an acceptable latency, it rejects some requests. | ||
| <BackpressureExport/> | ||
|
|
||
| To avoid such problems, Zeebe employs a [backpressure](/self-managed/zeebe-deployment/operations/backpressure.md) mechanism. When the broker receives more requests than it can process with an acceptable latency, it rejects some requests. |
There was a problem hiding this comment.
Non-blocking suggestion: "uses" instead of "employs" (plain English/better for translation down the line)
|
@mesellings This isn't ready for a technical writing review yet - I'd like to get the engineering asks in first, as we're not sure yet where it will land. |
|
|
||
| Backpressure is indicated to the client by throwing a **resource exhausted** exception. If a client sees this exception, it can retry the requests with an appropriate retry strategy. If the rejection rate is high, it indicates the broker is constantly under high load and you need to reduce the rate of requests. Alternatively, you can also increase broker resources to adjust to your needs. In high-load scenarios, it is recommended to [benchmark](https://camunda.com/blog/2022/05/how-to-benchmark-your-camunda-platform-8-cluster/) your Zeebe broker up front to size it correctly. | ||
| Backpressure is indicated to the client by throwing a **resource exhausted** exception, which indicates whether the write limit or request limit has been reached. |
There was a problem hiding this comment.
Non-blocking suggestion: "that" instead of "which"
| Backpressure is indicated to the client by throwing a **resource exhausted** exception. If a client sees this exception, it can retry the requests with an appropriate retry strategy. If the rejection rate is high, it indicates the broker is constantly under high load and you need to reduce the rate of requests. Alternatively, you can also increase broker resources to adjust to your needs. In high-load scenarios, it is recommended to [benchmark](https://camunda.com/blog/2022/05/how-to-benchmark-your-camunda-platform-8-cluster/) your Zeebe broker up front to size it correctly. | ||
| Backpressure is indicated to the client by throwing a **resource exhausted** exception, which indicates whether the write limit or request limit has been reached. | ||
|
|
||
| If a client sees this exception, it can retry the requests with an appropriate retry strategy. If the rejection rate is high, it indicates the broker is constantly under high load and you need to reduce the rate of requests. Alternatively, you can also increase broker resources to adjust to your needs. In high-load scenarios, it is recommended to [benchmark](https://camunda.com/blog/2022/05/how-to-benchmark-your-camunda-platform-8-cluster/) your Zeebe broker up front to size it correctly. |
There was a problem hiding this comment.
Non-blocking suggestion: Could run into one sentence, e.g. "high load, and you need to either reduce the rate of requests, or increase broker resources to adjust to your needs."
|
@npepinpe @lenaschoenburg Hi, is it possible to get an engineering review of this please, as it is marked as alpha 4 release, and we need to get this merged in today if we are to include it in the release? Alternatively, let us know if this is not something that should/can make it into the alpha 4 release? |
|
It's okay if it doesn't make it in alpha4. We are discussing this in https://camunda.slack.com/archives/C07GHC8JPC1, I think @conceptualshark wanted to close this PR anyway. |
|
🧹 Preview environment for this PR has been torn down. |
Description
Relates to https://github.com/camunda/product-hub/issues/1426, camunda/camunda#17547
Adding in information to the backpressure concept docs to reference new sources of backpressure (backlog created by export lag/elasticsearch load), and that
resource exhaustederror messaging now differentiates between write and request limits.When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).