[BUG] Cancelling a PPL query sent by another plugin doesn't stop it, and its searches have no parent task
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 64/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- java
調査の方向性
Start in plugin/src/main/java/org/opensearch/sql/plugin/transport/TransportPPLQueryAction.java at the task checks in doExecute and submitAsync; compare them with OpenSearchQueryManager.setCancellableTask and OpenSearchNodeClient.applyParentTask. The issue proposes using the shared CancellableTask type for both paths. Done means PPL requests from another plugin link searches to their task, cancellation stops the query, and the async path accepts the task.
索引モデルが issue の本文から書いたものです。
説明
What is the bug?
A PPL query that another plugin sends through the cluster:admin/opensearch/ppl transport action, using its own bundled copy of the SQL classes, is not linked to its task. Examples are Alerting PPL monitors (PPLUtils → PPLPluginInterface.executeQuery) and Skills PPL tools (PPLTool, LogPatternTool, and tools that use PPLExecuteHelper). As a result:
- the searches the query runs have no parent task, and
POST _tasks/<ppl task id>/_cancelmarks the task cancelled, but the query keeps running.
TransportPPLQueryAction.doExecute only sets the query's cancellable task when the task is this plugin's own PPLQueryTask class (L212-L214):
if (task instanceof PPLQueryTask pplQueryTask) {
OpenSearchQueryManager.setCancellableTask(pplQueryTask);
}
Alerting and Skills bundle their own copy of the SQL classes (the opensearch-sql-thin jar) and don't extend opensearch-sql, so those classes load in the caller's classloader. Core creates the task through request.createTask(...) on the caller's TransportPPLQueryRequest, which returns the caller's copy of PPLQueryTask. That copy is a different class from this plugin's PPLQueryTask, so the instanceof check fails and the ThreadLocal is never set. OpenSearchNodeClient.applyParentTask (L254-L258) then sets no parent, and the engine's cancellation checks find no task. submitAsync makes the same check (L314-L316), so an async PPL request from another plugin fails with Async PPL queries require a cancellable PPLQueryTask. Async PPL is only on main so far, and neither Alerting nor Skills sends async requests today, so this part is latent.
How can one reproduce the bug?
Reproduced on a local single-node cluster with opensearch-sql and opensearch-alerting, on 3.10.0-SNAPSHOT (SQL at 24bfaaf) and on 3.9.0:
- Index 2M small docs into
big. To make one query run about 20 s, setindex.max_result_window: 10onbig, plusplugins.query.size_limit: 100000000andplugins.calcite.pushdown.enabled: false. Raiseplugins.alerting.ppl_query_max_execution_durationso the monitor waits for the whole query. - Run
source=big | where n < 0 | head 10from an Alerting PPL monitor (POST _plugins/_alerting/monitors/_execute?dryrun=truewith appl_monitor), and the same query throughPOST _plugins/_ppl. GET _tasks?detailed=true&actions=cluster:admin/opensearch/ppl,indices:data/read/search*. On main, the_plugins/_pplquery's searches have the PPL task asparent_task_id(300 of 300 sampled); the Alerting query's searches have none (0 of 279).POST _tasks/<ppl task id>/_cancelabout 5 s in. The_plugins/_pplquery stops right away. The Alerting query's task reports"cancelled": true, but the query runs all ~200k searches to completion, unlessplugins.ppl.query.timeoutfires first. Same result on 3.9.0.
What is the expected behavior?
A PPL query should be linked to its task whichever plugin sends it. Its searches should be children of the PPL task, and cancelling the task should stop the query.
Suggested fix: check for the core type instead of this plugin's class. CancellableTask is loaded by the server classloader, so it is the same class in every plugin.
if (task instanceof CancellableTask cancellableTask) {
OpenSearchQueryManager.setCancellableTask(cancellableTask);
}
Apply the same change in submitAsync; CancellableTask#cancel(String) is public. OpenSearchQueryManager.setCancellableTask already takes a CancellableTask. Features that need PPLQueryTask-specific state can stay limited to PPLQueryTask. For example, #5760 adds Query Insights fields and edits this same check.
What is your host/environment?
- Version: main (24bfaaf). The cancellation problem also affects releases since #5254: 3.6.0+ with Skills and 3.7.0+ with Alerting (reproduced on 3.9.0). In releases, searches issued by the background scanner have no parent task whoever sends the query (#5647, fixed on main by #5888), so the missing-parent part is specific to main. The async failure is main-only too.
- Plugins: opensearch-sql together with alerting and/or skills (all in the default distribution)
Do you have any additional context?
Found while reviewing opensearch-project/query-insights#699, which shows a running PPL query in Live Queries as one row by nesting its searches under the PPL task. PPL queries from other plugins don't get that grouping.
- 主要言語
- Java
- スター
- 175
- フォーク
- 233
- 平均マージ
- 2日 19時間
- マージ済み PR(30日)
- 37
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
opensearch-project/sql のほかの issue
-
[Enhancement] Make the flat_object read depth cap configurable instead of a constant対応中かも @RyanL1997 が 17 日前に担当しました。 オープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
opensearch-project/sql#5842 ·
メンテナーはふだん 1 日以内に返信
-
[BUG] PromQL queries fail with InvalidTypeIdException when metric has a label named "type"対応中かも @nagendramohan が 79 日前に担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
opensearch-project/sql#5684 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
[DOC] Calcite settings documentation missing examples対応中かも @AzazelSensei が 36 日前に担当しました。 オープンdocumentation PPL
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
opensearch-project/sql#4806 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
opensearch-project/sql#5912 ·
メンテナーはふだん 1 日以内に返信
-
bug PPL
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
opensearch-project/sql#5904 ·
メンテナーはふだん 1 日以内に返信
opensearch-project/sql の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
quarkiverse/quarkus-google-cloud-services#1188 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
opendataloader-project/opendataloader-pdf#851 ·
メンテナーはふだん 1 日以内に返信
-
Component: Frontend Component: Web Component Type: Maintenance
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
it-at-m/refarch-templates#1944 ·
メンテナーはふだん 2 日以内に返信
-
3.0.0-M*: every channel stays reachable from its session's KEX listeners, so a long-lived session leaks all closed channels対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信