apache / apache/lucene

NRTCachingDirectory shouldn't log to stdout [LUCENE-7082]

Open
#8,138 2 comments 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Major module:core/store type:bug
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

NRTCachingDirectory declares `final boolean VERBOSE = false` and then checks this value when determining whether to write additional logging to stdout or not.

Since this is only useful during development, we should change all of the statements to use proper debug logging that can be turned on/off via configuration in production.

---
Migrated from [LUCENE-7082](https://issues.apache.org/jira/browse/LUCENE-7082) by Mike Drob (@madrob)

Contributor guide

Open the contributing guide

Research direction

Locate the NRTCachingDirectory class and inspect every statement guarded by the VERBOSE constant that writes to stdout. Determine the project's existing debug-logging convention before changing those statements, and verify that the directory no longer writes development logging to stdout while logging can be enabled through configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
observability
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.