v0.5.28

What's Changed

There were a lot of time since 0.5.7 OpenTelemetry release and now we completed Observability features we planned! FastStream supports Prometheus metrics in a native way!

Special thanks to @roma-frolov and @draincoder (again) for it!

To collect Prometheus metrics for your FastStream application you just need to install special distribution

pip install faststream[prometheus]

And use PrometheusMiddleware. Also, it could be helpful to use our ASGI to serve metrics endpoint in the same app.

from prometheus_client import CollectorRegistry, make_asgi_app
from faststream.asgi import AsgiFastStream
from faststream.nats import NatsBroker
from faststream.nats.prometheus import NatsPrometheusMiddleware

registry = CollectorRegistry()

broker = NatsBroker(
    middlewares=(
        NatsPrometheusMiddleware(registry=registry),
    )
)

app = AsgiFastStream(
    broker,
    asgi_routes=[
        ("/metrics", make_asgi_app(registry)),
    ]
)

Moreover, we have a ready-to-use Grafana dashboard you can just import and use!

To find more information about Prometheus support, just visit our documentation.

All changes

• docs: Correct minimum FastAPI version for lifespan handling by @tim-hutchinson in #1853
• add aiogram example by @IvanKirpichnikov in #1858
• Feature: Prometheus Middleware by @roma-frolov in #1791
• Add in-progress tutorial to how-to section by @sheldygg in #1859
• docs: Add info about Grafana dashboard by @draincoder in #1863

New Contributors

• @tim-hutchinson made their first contribution in #1853

Full Changelog: 0.5.27...0.5.28

v0.5.27

What's Changed

• fix: anyio major version parser by @dotX12 in #1850

New Contributors

• @dotX12 made their first contribution in #1850

Full Changelog: 0.5.26...0.5.27

v0.5.26

What's Changed

This it the official Python 3.13 support! Now, FastStream works (and tested) at Python 3.8 - 3.13 versions!

Warning: Python3.8 is EOF since 3.13 release and we plan to drop it support in FastStream 0.6.0 version.

Also, current release has little bugfixes related to CLI and AsyncAPI schema.

• fix: asgi docs by @Sehat1137 in #1828
• docs: add link to RU TG community by @Lancetnik in #1831
• docs: add dynaconf NATS HowTo example by @sheldygg in #1832
• Fix AsyncAPI 2.6.0 operation label by @KrySeyt in #1835
• fix: correct CLI factory behavior by @Lancetnik in #1838
• Autocommit precommit changes by @kumaranvpl in #1840
• Add devcontainers supporting all the brokers by @kumaranvpl in #1839
• Replace async Event with bool by @Olegt0rr in #1846
• Add support for Python 3.13 by @davorrunje in #1845

Full Changelog: 0.5.25...0.5.26

v0.5.25

What's Changed

• fix: CLI hotfix by @Lancetnik in #1816

Full Changelog: 0.5.24...0.5.25

v0.5.24

What's Changed

• Replace while-sleep with Event by @Olegt0rr in #1683
• feat: add explicit CLI import error by @Lancetnik in #1785
• fix (#1780): replace / in generated json refs by @Lancetnik in #1786
• Fix: this commit resolve #1765 by @Flosckow in #1789
• fix (#1792): make RMQ publisher.publish reply_to optional by @Lancetnik in #1795
• fix (#1793): FastStream Response support in FastAPI integration by @Lancetnik in #1796
• Update exception.md by @pepellsd in #1803
• Fixes the CI bug that allows PRs with failed tests to be merged. by @davorrunje in #1807
• feat: add CLI support for AsgiFastStream by @Sehat1137 in #1782
• docs: add contributors page by @kumaranvpl in #1808
• fix: correct dependency injection of custom context fields implementing partial eq/ne by @antoinehumbert in #1809
• do not assume discriminator is not a property by @lecko-cngroup in #1811

New Contributors

• @Olegt0rr made their first contribution in #1683
• @pepellsd made their first contribution in #1803
• @antoinehumbert made their first contribution in #1809
• @lecko-cngroup made their first contribution in #1811

Full Changelog: 0.5.23...0.5.24

v0.5.23

What's Changed

We made last release just a few days ago, but there are some big changes here already!

1. First of all - you can't use faststream run ... command without pip install faststream[cli] distribution anymore. It was made to minify default (and production) distribution by removing typer (rich and click) dependencies. CLI is a development-time feature, so if you don't need - just don't install! Special thanks to @RubenRibGarcia for this change

2. The next big change - Kafka publish confirmations by default! Previous FastStream version was working in publish & forgot style, but the new one blocks your broker.publish(...) call until Kafka confirmation frame received. To fallback to previous logic just use a new flag broker.publish(..., no_confirm=True)

3. Also, we made one more step forward to our 1.0.0 features plan! @KrySeyt implements get_one feature. Now you can use any broker subscriber to get messages in imperative style:

subscriber = broker.subscriber("in")
...
msg = await subscriber.get_one(timeout=5.0)

4. And the last one: @draincoder continues to develop OTEL support! Now he provides us with an ability to use OTEL spans and baggage in a comfortable FastStream-style. Just take a look at the new documentation section

Big thanks to all new and old contributors who makes such a great release!

• feat: AsgiFastStream hooks init options by @Lancetnik in #1768
• fix (#1748): add Kafka publish no_confirm option by @Lancetnik in #1749
• Fix GeneralExceptionHandler typehint by @sheldygg in #1773
• Add broker.subscriber().get_one() by @KrySeyt in #1726
• Add OTel baggage support by @draincoder in #1692
• build(#1430): separate cli faststream to its own distribution by @RubenRibGarcia in #1769

New Contributors

• @RubenRibGarcia made their first contribution in #1769

Full Changelog: 0.5.22...0.5.23

v0.5.22

What's Changed

• fix: FastAPI 0.112.4+ compatibility by @Lancetnik in #1766

Full Changelog: 0.5.21...0.5.22

v0.5.21

What's Changed

• feat (#1168): allow include regular router to FastAPI integration by @Lancetnik in #1747
• In case if core-subscriber receive a JetStream message. by @sheldygg in #1751
• feat: explicit final message commit status by @Lancetnik in #1754
• Fix/context get local default by @Lancetnik in #1752
• fix (#1759): correct ConfluentConfig with enums by @Lancetnik in #1762
• Adds SASLOAuthBearer flow to AIO Kafka's Faststream Security Parsing by @sifex in #1761
• fix: FastAPI 0.112.3 compatibility by @Lancetnik in #1763

Full Changelog: 0.5.20...0.5.21

v0.5.20

What's Changed

• Refactor: change publisher fake subscriber generation logic by @Lancetnik in #1729
• Remove docs/api directory before running create_api_docs script by @kumaranvpl in #1730
• CI: automatically approve & merge Dependabot PRs by @dolfinus in #1720
• Run check broken links after docs deploy by @kumaranvpl in #1733
• Feature: extend FastStream.init by @Sehat1137 in #1734
• Fix Dependabot group names by @dolfinus in #1737
• Fix: respect ignored exceptions by @Lancetnik in #1735
• Fix: update FastAPI to 0.112.2 by @Lancetnik in #1736

Full Changelog: 0.5.19...0.5.20

v0.5.19

What's Changed

The current release is planned as a latest feature release before 0.6.0. All other 0.5.19+ releases will contain only minor bugfixes and all the team work will be focused on next major one.

There a lot of changes we want to present you now though!

New RPC feature

Our old broker.publish(..., rpc=True) implementation was very limited and ugly. Now we present you a much suitable way to do the same thing - broker.request(...)

from faststream import FastStream
from faststream.nats import NatsBroker, NatsResponse, NatsMessage

broker = NatsBroker()

@broker.subscriber("test")
async def echo_handler(msg):
    return NatsResponse(msg, headers={"x-token": "some-token"})

@app.after_startup
async def test():
    # The old implementation was returning just a message body,
    # so you wasn't be able to check response headers, etc
    msg_body: str = await broker.publish("ping", "test", rpc=True)
    assert msg_body == "ping"
    
    # Now request return the whole message and you can validate any part of it
    # moreover it triggers all your middlewares
    response: NatsMessage = await broker.request("ping", "test")

Exception Middleware

Community asked and community did! Sorry, we've been putting off this job for too long. Thanks for @Rusich90 to help us!
Now you can wrap your application by a suitable exception handlers. Just check the new documentation to learn more.

Details

Also, there are a lot of minor changes you can find below. Big thanks to all our old and new contributors! You are amazing ones!

• Bug: resolve missing seek on kafka fakeconsumer by @JonathanSerafini in #1682
• replace pip with uv in CI by @newonlynew in #1688
• Added support for JSON serialization and deserialization by other libraries by @ulbwa in #1687
• Fix batch nack by @kumaranvpl in #1689
• Remove unused ignores by @kumaranvpl in #1690
• docs: add Kafka HowTo section by @Lancetnik in #1686
• Add missed out group_instance_id as subscriber and router parameter by @kumaranvpl in #1695
• Set warn_unused_ignores mypy config to true by @kumaranvpl in #1694
• Skip building docs in pre-commit CI job by @kumaranvpl in #1704
• Fix to run check-docs-changes workflow in forks by @kumaranvpl in #1710
• feature/exception_middleware add exception middleware by @Rusich90 in #1604
• Remove mentions of faststream-gen by @kumaranvpl in #1717
• Fix multiple docs issues by @kumaranvpl in #1718
• CI: group Dependabot updates into one PR by @dolfinus in #1719
• feat: CLI DX improvements by @Lancetnik in #1723
• fix: use async test subscribers functions by @Lancetnik in #1725
• feat: add broker.request method by @Lancetnik in #1649

New Contributors

• @JonathanSerafini made their first contribution in #1682
• @Rusich90 made their first contribution in #1604
• @dolfinus made their first contribution in #1719

Full Changelog: 0.5.18...0.5.19