Pooled clients leak a connection per call: pipelines and transactions taken from UnifiedJedis are never closed
評価
調査の方向性
バッチおよび定期的なエンキュー操作について AbstractClient.java の該当メソッドを読み、次に worker の失敗処理について AbstractWorker.java を読んでください。パイプラインとトランザクションがどのように取得され、閉じられるかを確認し、上限のあるプールの maxTotal を超える回数の呼び出しを行う回帰テストを追加してください。これらの呼び出しによってプールが枯渇せず、接続がプールに返却されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Version: jesque 3.0.0 with its jedis 7.2.1. The code is unchanged on master (e4d551d, jedis 8.0.0).
What happens
These calls each take a connection from the client's UnifiedJedis pool and never return it:
ClientPoolImpl.batchEnqueue(...), through a pipeline;ClientPoolImpl.recurringEnqueue(...)andClientPoolImpl.removeRecurringEnqueue(...), through a transaction;WorkerPoolImplfailure handling, through a transaction, when theFailQueueStrategyreturnsgetFailQueueMaxItems(...) > 0.
With a bounded pool, the call after maxTotal such calls fails:
redis.clients.jedis.exceptions.JedisException: Could not get a resource from the pool
Caused by: java.util.NoSuchElementException: Timeout waiting for idle object, maxWaitDuration=PT1S
at redis.clients.jedis.util.Pool.getResource(Pool.java:42)
...
at redis.clients.jedis.UnifiedJedis.pipelined(UnifiedJedis.java:6001)
at redis.clients.jedis.RedisClient.pipelined(RedisClient.java:167)
at net.greghaines.jesque.client.AbstractClient.doBatchEnqueue(AbstractClient.java:210)
That trace is from master (jedis 8.0.0). In the worker, the exception is caught and logged at WARN, so failures silently stop being recorded. With the default pool config (unbounded, non-blocking), nothing throws. Instead, every call leaves one more connection open on Redis: 50 batch enqueues took CLIENT LIST from 2 to 51 connections.
Why
UnifiedJedis.pipelined() and UnifiedJedis.multi() create the pipeline or transaction on a connection taken from the pool, with closeConnection = true, and only their close() returns it:
https://github.com/redis/jedis/blob/26bbb8e33af4efe569d8b7d1126329e257f79e0b/src/main/java/redis/clients/jedis/UnifiedJedis.java#L5129-L5137
https://github.com/redis/jedis/blob/26bbb8e33af4efe569d8b7d1126329e257f79e0b/src/main/java/redis/clients/jedis/UnifiedJedis.java#L5150-L5158
Jesque calls sync() or exec(), but never close():
- batch enqueue: https://github.com/gresrun/jesque/blob/2351628e4a7ee12e58b01a85ab93e314dfb9021d/src/main/java/net/greghaines/jesque/client/AbstractClient.java#L204-L216
- recurring enqueue: https://github.com/gresrun/jesque/blob/2351628e4a7ee12e58b01a85ab93e314dfb9021d/src/main/java/net/greghaines/jesque/client/AbstractClient.java#L363-L384
- recurring removal: https://github.com/gresrun/jesque/blob/2351628e4a7ee12e58b01a85ab93e314dfb9021d/src/main/java/net/greghaines/jesque/client/AbstractClient.java#L403-L422
- worker fail queue: https://github.com/gresrun/jesque/blob/2351628e4a7ee12e58b01a85ab93e314dfb9021d/src/main/java/net/greghaines/jesque/worker/AbstractWorker.java#L569-L574
In 2.3.0 these calls ran inside PoolUtils.doWorkInPool, which returns the Jedis to the pool, so the leak is new in 3.0.0:
The non-pooled ClientImpl and WorkerImpl aren't affected: closing a pipeline or transaction of a plain Jedis leaves its connection open.
How to reproduce
- Create a pooled client with
maxTotal = 3,blockWhenExhausted = trueandmaxWait = 1s: aJedisPooledon jedis 7.x, orPoolUtils.createJedisPool(config, poolConfig)on master. - Pass it to a
ClientPoolImpl. - Call
client.batchEnqueue("q", List.of(job))four times. - The 4th call fails as above, although nothing else uses the pool.
Fix
Close the pipelines and transactions with try-with-resources. AbstractPipeline and AbstractTransaction implement Closeable without a checked exception. I'll open a PR with the fix and regression tests that run more calls than a bounded pool's maxTotal.
Workaround
Subclass ClientPoolImpl, override doBatchEnqueue (and the recurring methods, if you use them), and close the pipeline or transaction there.
- 主要言語
- Java
- スター
- 629
- フォーク
- 132
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
gresrun/jesque のほかの issue
-
Latest jedis SDK support?再び着手できるかも @gresrun が 295 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンDiscussion
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
-
Redis Cluster Issueオープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
似ている issue
-
code-maintenance
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信
-
bug priority: medium Review effort [1-5]: 3 status: needs-triage type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
carlos-emr/carlos#5258 ·
メンテナーはふだん 1 日以内に返信
-
bug: author create/update with an unknown avatarId returns 404 instead of 400 UNKNOWN_REFERENCE対応中かも @Vinu2111 が今日担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
atomityhq/blog-cms#59 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
dev/release: verify-release-candidate.sh runs 0 Java tests with Debian's Maven対応中かも @kou が今日担当しました。 オープンType: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
apache/arrow-adbc#4947 ·
メンテナーはふだん 1 日以内に返信