opensearch-project/OpenSearch

[Feature Request] Enable debug logging for Approximation framework

Open

#18,318 opened on May 16, 2025

View on GitHub
 (7 comments) (0 reactions) (2 assignees)Java (8,123 stars) (1,505 forks)batch import
Search:Performanceenhancementgood first issue

Description

Is your feature request related to a problem? Please describe

Similar to how we have debug logs in other optimization paths eg - https://github.com/opensearch-project/OpenSearch/blob/5fb4e6951b6c80db5c9c45398ed3704ac4092ba3/server/src/main/java/org/opensearch/search/aggregations/bucket/filterrewrite/FilterRewriteOptimizationContext.java#L89.

We should enable debug logging for how the optimization works, how many docs per segment we are collecting. How many nodes of the point tree we are visiting, how many leaves we are reading etc. This should help us understand if/when there are regressions.

Describe the solution you'd like

  • Enable debug logging
  • Enable more logs by adding them to AbstractProfiler so that we can profile the results

Related component

Search:Performance

Describe alternatives you've considered

No response

Additional context

No response

Contributor guide

Tech stack
java
Domain
performance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Java knowledgeOpenSearch codebase familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue requests debug logging for the Approximation framework. Start by examining the existing debug logging in FilterRewriteOptimizationContext.java (linked in the issue) to understand the pattern. Then locate the Approximation framework's optimization classes and AbstractProfiler to add similar logging. Consider measuring docs per segment, point tree nodes visited, and leaves read. Since there are two assignees, check the issue comments for any discussion on implementation details.