Skip to main content

Various strategies for sending requests

Project description

aio-request

This library simplifies an interaction between microservices:

  1. Allows sending requests using various strategies
  2. Propagates a deadline and a priority of requests
  3. Exposes client/server metrics

Example:

import aiohttp
import aio_request

async with aiohttp.ClientSession() as client_session:
    client = aio_request.setup(
        transport=aio_request.AioHttpTransport(client_session),
        endpoint="http://endpoint:8080/",
    )
    response_ctx = client.request(
        aio_request.get("thing"),
        deadline=aio_request.Deadline.from_timeout(5)
    )
    async with response_ctx as response:
        pass  # process response here

Request strategies

The following strategies are supported:

  1. Single attempt. Only one attempt is sent.
  2. Sequential. Attempts are sent sequentially with delays between them.
  3. Parallel. Attempts are sent in parallel one by one with delays between them.

Attempts count and delays are configurable.

Example:

import aiohttp
import aio_request

async with aiohttp.ClientSession() as client_session:
    client = aio_request.setup(
        transport=aio_request.AioHttpTransport(client_session),
        endpoint="http://endpoint:8080/",
    )
    response_ctx = client.request(
        aio_request.get("thing"),
        deadline=aio_request.Deadline.from_timeout(5),
        strategy=aio_request.parallel_strategy(
            attempts_count=3,
            delays_provider=aio_request.linear_delays(min_delay_seconds=0.1, delay_multiplier=0.1)
        )
    )
    async with response_ctx as response:
        pass  # process response here

Deadline & priority propagation

To enable it for the server side a middleware should be configured:

import aiohttp.web
import aio_request

app = aiohttp.web.Application(middlewares=[aio_request.aiohttp_middleware_factory()])

Expose client/server metrics

To enable client metrics a metrics provider should be passed to the transport:

import aiohttp
import aio_request

async with aiohttp.ClientSession() as client_session:
    client = aio_request.setup(
        transport=aio_request.AioHttpTransport(
            client_session,
            metrics_provider=aio_request.PROMETHEUS_METRICS_PROVIDER
        ),
        endpoint="http://endpoint:8080/",
    )

It is an example of how it should be done for aiohttp and prometheus.

To enable client metrics a metrics provider should be passed to the middleware:

import aiohttp.web
import aio_request

app = aiohttp.web.Application(
    middlewares=[
        aio_request.aiohttp_middleware_factory(
            metrics_provider=aio_request.PROMETHEUS_METRICS_PROVIDER
        )
    ]
)

Circuit breaker

import aiohttp
import aio_request

async with aiohttp.ClientSession() as client_session:
    client = aio_request.setup_v2(
        transport=aio_request.AioHttpTransport(client_session),
        endpoint="http://endpoint:8080/",
        circuit_breaker=aio_request.DefaultCircuitBreaker[str, int](
            break_duration=1.0,
            sampling_duration=1.0,
            minimum_throughput=2,
            failure_threshold=0.5,
        ),
    )

In the case of requests count >= minimum throughput(>=2) in sampling period(1 second) the circuit breaker will open if failed requests count/total requests count >= failure threshold(50%).

v0.1.28 (2023-04-27)

v0.1.27 (2023-02-16)

v0.1.26 (2022-11-02)

v0.1.25 (2022-08-25)

v0.1.24 (2022-07-04)

v0.1.23 (2022-02-08)

v0.1.22 (2022-01-08)

v0.1.21 (2022-01-05)

  • Content type should be None in Response.json()

v0.1.20 (2022-01-05)

v0.1.19 (2021-11-01)

v0.1.18 (2021-09-08)

v0.1.17 (2021-09-01)

v0.1.16 (2021-09-01)

v0.1.15 (2021-09-01)

v0.1.14 (2021-08-18)

v0.1.13 (2021-08-15)

v0.1.12 (2021-07-21)

v0.1.11 (2021-07-21)

  • Fix Request.update_headers, add Request.extend_headers #59

v0.1.10 (2021-07-20)

  • Add Response.is_json property to check whether content-type is json compatible #58
  • Tracing support #54,
  • Configuration of a new pipeline

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aio-request-0.1.28.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

aio_request-0.1.28-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file aio-request-0.1.28.tar.gz.

File metadata

  • Download URL: aio-request-0.1.28.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for aio-request-0.1.28.tar.gz
Algorithm Hash digest
SHA256 ff2af3805eca2fa423095c79d2d0597bc97fcac223f83aeeb4004a746cbbdf70
MD5 72c26f1c33df916cad7394aed4e53843
BLAKE2b-256 46236ee5f23ee3dcf8ec2150c69e7e8980cecbb5f094780bca99070355f75fce

See more details on using hashes here.

Provenance

File details

Details for the file aio_request-0.1.28-py3-none-any.whl.

File metadata

  • Download URL: aio_request-0.1.28-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for aio_request-0.1.28-py3-none-any.whl
Algorithm Hash digest
SHA256 a5622c63b4332611ad088848b73b28f40a3fed49806f737687d1e11e1ac2573e
MD5 47c87f567332afd8d37d0a240d34f877
BLAKE2b-256 6ea262c6f4fa5327d9e37963091fdfba28a1eb17f1b9e354c50f16edc8f2fc73

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page