Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 37 additions & 1 deletion docs/available-components/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Use jitter and exponential backoff to avoid repetitive load peaks, especially in

### Prometheus middleware

You can enable prometheus metrics for workers by adding PrometheusMiddleware.
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.

::: tabs
Expand Down Expand Up @@ -118,3 +118,39 @@ 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

You can enable opentelemetry tracing for workers by adding `OpenTelemetryMiddleware` or using `TaskiqInstrumentor` (preferred).

```bash
pip install "taskiq[opentelemetry]"
```

::: tabs


@tab instrumentor

```python
from taskiq import ZeroMQBroker
from taskiq.instrumentation import TaskiqInstrumentor

TaskiqInstrumentor().instrument()
broker = ZeroMQBroker()
```

@tab middleware

```python
from taskiq import ZeroMQBroker
from taskiq.middlewares.opentelemetry_middleware import OpenTelemetryMiddleware

broker = ZeroMQBroker().with_middlewares(
OpenTelemetryMiddleware,
)
```

:::

Auto-instrumentation is also supported.
2 changes: 1 addition & 1 deletion taskiq/instrumentation.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

import asyncio

from taskiq import InMemoryBroker, TaskiqEvents, TaskiqState
from taskiq import InMemoryBroker
from taskiq.instrumentation import TaskiqInstrumentor

broker = InMemoryBroker()
Expand Down