MagicStack / MagicStack/asyncpg
Feature Request: Retry on failed acquires (timeouterror/connectionerror)
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 8.1k
- Fork
- 468
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
* **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.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với điểm vào asyncpg Pool.acquire và hành vi của PoolAcquireContext được mô tả trong issue. Xác định cách các lần retry acquire có thể cấu hình phải xử lý lỗi timeout và lỗi kết nối mà không retry các lỗi không liên quan hoặc làm gián đoạn việc release của context manager, sau đó bổ sung coverage cho hành vi retry được chấp nhận trước khi coi tính năng là hoàn tất.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- postgresql, python
- Lĩnh vực
- backend-api-design, database
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 25/100