MagicStack / MagicStack/asyncpg

Feature Request: Retry on failed acquires (timeouterror/connectionerror)

オープン
#620 コメント 0 件 リアクション 10 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
8.1k
フォーク
468
PR マージ指標
30日以内にマージされた PR はありません

説明

* **asyncpg version**: 0.21.0
* **PostgreSQL version**: any
* **Do you use a PostgreSQL SaaS? If so, which? Can you reproduce
the issue with a local PostgreSQL install?**: -- dont use it
* **Python version**: any
* **Platform**: any
* **Do you use pgbouncer?**: no
* **Did you install asyncpg with pip?**: yes
* **If you built asyncpg locally, which version of Cython did you use?**: not built locally
* **Can the issue be reproduced under both asyncio and
[uvloop](https://github.com/magicstack/uvloop)?**: yes

Would you accept a contribution to asyncpg's Pool in which we can retry failed acquires (timeouterrors/connectionresetbypeer/...) which are caused by network issues?
The default behaviour wouldn't retry, as it's happening right now.

This is useful for data processing pipelines with multiple acquires in it's flow (distinct dbs): Being able to configure acquire_max_retries when creating the pool would help keeping the code simpler and not have to wrap all our 'acquires' with retries. The retry decorator logic on acquire can become non-trivial because of the contextmanager auto-releasing the connection after successful usage OR other errors (unrelated to asyncpg) that happen after acquiring a connection+exiting the context (this caused some pain for us).

If you are willing to accept this feature, I'm happy to implement it on my own and submit a PR.

Just to give you an idea, this is what we had to implement on our project in order to have pool acquires with retries:

```
async def retry(coro, exceptions=(Exception,), max_retries=3, retry_delay_seconds=0):
for attempt in range(max_retries):
try:
return await coro()
except exceptions:
logger.exception(f"{coro} attempt failed. Attempt {attempt + 1}/{max_retries}")
if attempt + 1 == max_retries:
raise
await asyncio.sleep(retry_delay_seconds)

class PoolWithRetries:
def __init__(self, pool: asyncpg.pool.Pool, max_retries=3, retry_delay_seconds=0):
self.pool = pool
self.max_retries = max_retries
self.retry_delay_seconds = retry_delay_seconds

@asynccontextmanager
async def acquire(self, *args, **kwargs):
# Reimplementation of PoolAcquireContext with retries
# Only supports `async with this.acquire() as con` syntax
con = await retry(
partial(self.pool.acquire, *args, **kwargs),
exceptions=(asyncio.TimeoutError, ConnectionError),
max_retries=self.max_retries,
retry_delay_seconds=self.retry_delay_seconds,
)
try:
yield con
finally:
await self.pool.release(con)

async def release(self, *args, **kwargs):
await self.pool.release(*args, **kwargs)

async def close(self):
await self.pool.close()
```

The implementation becomes much simpler if we can do it inside asyncpg.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

asyncpg Pool.acquire のエントリポイントと、issue に記載されている PoolAcquireContext の動作から始めます。設定可能な acquire のリトライで、タイムアウトエラーと接続エラーをどのように扱うかを定義し、無関係なエラーはリトライせず、コンテキストマネージャーによる解放も妨げないようにします。そのうえで、受け入れられるリトライ動作のテストカバレッジを追加してから、機能が完成したと判断します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
postgresql, python
領域
backend-api-design, database
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。