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
3 changes: 2 additions & 1 deletion docs/integrations/faststream.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Read more about available extras [here](../../../introduction/installation):

```python
from lite_bootstrap import FastStreamConfig, FastStreamBootstrapper
from faststream.asgi import AsgiFastStream
from faststream.redis.opentelemetry import RedisTelemetryMiddleware
from faststream.redis.prometheus import RedisPrometheusMiddleware
from faststream.redis import RedisBroker
Expand All @@ -44,7 +45,7 @@ bootstrapper_config = FastStreamConfig(
sentry_dsn="https://testdsn@localhost/1",
health_checks_path="/custom-health/",
logging_buffer_capacity=0,
broker=broker,
application=AsgiFastStream(broker),
)
bootstrapper = FastStreamBootstrapper(bootstrapper_config)
application = bootstrapper.bootstrap()
Expand Down
22 changes: 22 additions & 0 deletions docs/introduction/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,28 @@ Additional parameters:
- `logging_extra_processors`
- `logging_unset_handlers`.

### Structlog FastStream

When using FastStream, the structlog logger is automatically injected into the broker so that all broker
service messages (e.g. "Received", "Processed") are routed through structlog.

The broker log level is controlled independently from the application log level:

- `faststream_log_level` - log level for FastStream broker service messages (default: `logging.WARNING`).

This allows you to suppress broker noise while keeping your application logs at a lower level:

```python
import logging
from lite_bootstrap import FastStreamConfig

config = FastStreamConfig(
service_debug=False,
logging_log_level=logging.INFO, # your application logs
faststream_log_level=logging.WARNING, # broker "Received"/"Processed" messages (default)
)
```

## CORS

To bootstrap CORS headers, you must provide `cors_allowed_origins` or `cors_allowed_origin_regex`.
Expand Down
13 changes: 13 additions & 0 deletions lite_bootstrap/bootstrappers/faststream_bootstrapper.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import dataclasses
import json
import logging
import typing

from lite_bootstrap import import_checker
Expand All @@ -13,9 +14,13 @@


if import_checker.is_faststream_installed:
from faststream._internal.logger.params_storage import ManualLoggerStorage
from faststream.asgi import AsgiFastStream, AsgiResponse
from faststream.asgi import get as handle_get

if import_checker.is_structlog_installed:
import structlog

if import_checker.is_prometheus_client_installed:
import prometheus_client

Expand Down Expand Up @@ -62,6 +67,7 @@ class FastStreamConfig(
application: "AsgiFastStream" = dataclasses.field(default_factory=_make_asgi_faststream)
opentelemetry_middleware_cls: type[FastStreamTelemetryMiddlewareProtocol] | None = None
prometheus_middleware_cls: type[FastStreamPrometheusMiddlewareProtocol] | None = None
faststream_log_level: int = logging.WARNING


@dataclasses.dataclass(kw_only=True, slots=True, frozen=True)
Expand Down Expand Up @@ -99,6 +105,13 @@ async def _define_health_status(self) -> bool:
class FastStreamLoggingInstrument(LoggingInstrument):
bootstrap_config: FastStreamConfig

def bootstrap(self) -> None:
super().bootstrap()
broker = self.bootstrap_config.application.broker
if broker is not None and import_checker.is_structlog_installed and import_checker.is_faststream_installed:
broker.config.logger.params_storage = ManualLoggerStorage(structlog.get_logger("faststream"))
broker.config.logger.set_level(self.bootstrap_config.faststream_log_level)


@dataclasses.dataclass(kw_only=True, frozen=True)
class FastStreamOpenTelemetryInstrument(OpenTelemetryInstrument):
Expand Down
19 changes: 19 additions & 0 deletions tests/test_faststream_bootstrap.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import logging
import typing

import faststream.asgi
import pytest
import structlog
from faststream._internal.broker import BrokerUsecase
from faststream._internal.logger.params_storage import ManualLoggerStorage
from faststream.redis import RedisBroker, TestRedisBroker
from faststream.redis.opentelemetry import RedisTelemetryMiddleware
from faststream.redis.prometheus import RedisPrometheusMiddleware
Expand Down Expand Up @@ -85,6 +87,23 @@ async def test_faststream_bootstrap_health_check_wo_broker() -> None:
bootstrapper.teardown()


def test_faststream_logging_instrument_injects_structlog_logger(broker: RedisBroker) -> None:
bootstrap_config = FastStreamConfig(
service_debug=False,
logging_buffer_capacity=0,
logging_log_level=logging.INFO,
faststream_log_level=logging.WARNING,
application=faststream.asgi.AsgiFastStream(broker),
)
bootstrapper = FastStreamBootstrapper(bootstrap_config=bootstrap_config)
bootstrapper.bootstrap()
try:
assert isinstance(broker.config.logger.params_storage, ManualLoggerStorage)
assert broker.config.logger.log_level == logging.WARNING
finally:
bootstrapper.teardown()


def test_faststream_config_default_application() -> None:
config = FastStreamConfig()
assert isinstance(config.application, faststream.asgi.AsgiFastStream)
Expand Down
Loading