From 0359430ace4a9d2e1176fee20ef340b79edaa07f Mon Sep 17 00:00:00 2001 From: Felix Fanghaenel <35657654+flxdot@users.noreply.github.com> Date: Fri, 2 Jan 2026 12:55:42 +0100 Subject: [PATCH 1/2] Fix heading levels in middlewares documentation Updated headings in the middlewares documentation to improve formatting and consistency. --- docs/available-components/middlewares.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/available-components/middlewares.md b/docs/available-components/middlewares.md index f21d948..4893a1c 100644 --- a/docs/available-components/middlewares.md +++ b/docs/available-components/middlewares.md @@ -7,7 +7,7 @@ order: 5 Middlewares allow you to execute code when specific event occurs. Taskiq has several default middlewares. -### Simple retry middleware +## Simple retry middleware This middleware allows you to restart functions on errors. If exception was raised during task execution, the task would be resent with same parameters. @@ -38,7 +38,7 @@ async def test(): The `SmartRetryMiddleware` automatically retries tasks with flexible delay settings and retry strategies when errors occur. This is particularly useful when tasks fail due to temporary issues, such as network errors or temporary unavailability of external services. -### Key Features: +### Key Features * **Retry Limits**: Set the maximum number of retry attempts (`max_retries`). * **Delay Before Retry**: Define a fixed delay or use additional strategies. @@ -85,7 +85,7 @@ Use jitter and exponential backoff to avoid repetitive load peaks, especially in -### Prometheus middleware +## Prometheus middleware You can enable prometheus metrics for workers by adding `PrometheusMiddleware`. To do so, you need to install `prometheus_client` package or you can install metrics extras for taskiq. @@ -119,7 +119,7 @@ broker = ZeroMQBroker().with_middlewares( After that, metrics will be available at port 9000. Of course, this parameter can be configured. If you have other metrics, they'll be shown as well. -### OpenTelemetry Middleware +## OpenTelemetry Middleware You can enable opentelemetry tracing for workers by adding `OpenTelemetryMiddleware` or using `TaskiqInstrumentor` (preferred). From 88c1c9b120100e4fb9c6fc8bfe27b44c3cf778fb Mon Sep 17 00:00:00 2001 From: Felix Fanghaenel <35657654+flxdot@users.noreply.github.com> Date: Fri, 2 Jan 2026 12:58:32 +0100 Subject: [PATCH 2/2] Fix heading case for Smart Retry Middleware Updated heading formatting for consistency and clarity. --- docs/available-components/middlewares.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/available-components/middlewares.md b/docs/available-components/middlewares.md index 4893a1c..3d0ecc9 100644 --- a/docs/available-components/middlewares.md +++ b/docs/available-components/middlewares.md @@ -34,7 +34,7 @@ async def test(): `retry_on_error` enables retries for a task. `max_retries` is the maximum number of times,. -## Smart Retry Middleware +## Smart retry middleware The `SmartRetryMiddleware` automatically retries tasks with flexible delay settings and retry strategies when errors occur. This is particularly useful when tasks fail due to temporary issues, such as network errors or temporary unavailability of external services.