opensearch-project / opensearch-project/sql

[RFC] Standardizing OSD–PPL Interaction

Open
#4,532 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement PPL RFC
Dominant language
Java
Stars
176
Forks
229
Avg merge
2d 21h
Merged PRs (30d)
43

Description

Problem Statements

  • Incomplete language awareness in OSD typeahead, OSD cannot reliably detect the exact PPL version and supported commands/functions for a connected cluster or engine. Lack of a machine-readable, versioned capabilities contract leads to incorrect or missing completions, stale suggestions, and confusing editor diagnostics.
  • Unreliable “raw events before first reduce” on the Events page: OSD is expected to display raw events up to (but not including) the first reducing operator (e.g., dedup, stats). Without an authoritative definition or introspection of reducing boundaries, OSD uses heuristics that fail on complex pipelines (subqueries, macros, mvexpand, field mutations), causing incorrect previews and user confusion.
  • Ambiguity in “raw events” for the Timeline page: The Timeline page should visualize counts over raw events using an effective timestamp field before any reducing step. OSD lacks a consistent, query-aware definition of “raw events”.
  • No first-class cancellation for long-running PPL queries: Frontend needs to cancel in-flight or superseded queries (typing, tab switches, navigation). Lack of a Cancel API and stable query identifiers prevents responsive UX, wastes cluster resources, and complicates concurrency control in OSD.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing the four problem statements and the existing OSD–PPL interaction to determine whether a capabilities contract, raw-event boundary definition, timeline semantics, or query-cancellation API is in scope. Done requires an agreed, versioned design rather than a single implementation change.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend-api-design, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
18/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.