[BUG] Cancelling a PPL query sent by another plugin doesn't stop it, and its searches have no parent task
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 64/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- java
- Área
- backend, distributed-systems
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Java
- Estrellas
- 175
- Forks
- 233
- Merge medio
- 2 d 19 h
- PR fusionados (30 d)
- 37
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de opensearch-project/sql
-
[Enhancement] Make the flat_object read depth cap configurable instead of a constantPosiblemente ocupada @RyanL1997 la tomó hace 16 días. Abiertoenhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
opensearch-project/sql#5842 ·
Los mantenedores suelen responder en 1 día
-
[BUG] PromQL queries fail with InvalidTypeIdException when metric has a label named "type"Posiblemente ocupada @nagendramohan la tomó hace 79 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
opensearch-project/sql#5684 · 4 comentarios ·
Los mantenedores suelen responder en 1 día
-
[DOC] Calcite settings documentation missing examplesPosiblemente ocupada @AzazelSensei la tomó hace 36 días. Abiertodocumentation PPL
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
opensearch-project/sql#4806 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[Feature][PPL] Admit every query through one scheduler before it reaches the SQL worker poolsAbiertoenhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
opensearch-project/sql#5912 ·
Los mantenedores suelen responder en 1 día
-
bug PPL
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
opensearch-project/sql#5904 ·
Los mantenedores suelen responder en 1 día
Todos los issues de opensearch-project/sql
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
OpenAPITools/openapi-generator#25454 ·
Los mantenedores suelen responder en 1 día
-
Component - Build
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
Update the Russian localizationAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
navikt/mock-oauth2-server#1149 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
oracle/graalvm-reachability-metadata#11318 ·
Los mantenedores suelen responder en 1 día