Skip to content

Fix heading levels in middlewares documentation #576

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.

Sign up for GitHub

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

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

Fix heading levels in middlewares documentation #576

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0359430
Fix heading levels in middlewares documentation
flxdot Jan 2, 2026
88c1c9b
Fix heading case for Smart Retry Middleware
flxdot Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/available-components/middlewares.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -34,11 +34,11 @@ 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.

### 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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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).

Expand Down