docs(15.9): document timed_out, shard_failed and the split timeout logging - #535
Merged
Merged
Conversation
…gging codelibs/fess#3440 adds timed_out and shard_failed to /api/v2/search and makes query.timeout.logging write [SEARCH TIMEOUT] for a timed-out search and [SEARCH SHARD FAILURE] for a search that lost a shard, instead of calling every shard failure a timeout. api-search.rst lists the two new fields and says when partial is set, and search-advanced.rst describes both log lines and where the reason for a shard failure is found, in all seven languages. The English search-config.rst gets the same correction, and properties.rst is regenerated with tools/update_properties_doc.sh for the new property description.
marevol
deleted the
docs/distinguish-search-timeout-and-shard-failure
branch
September 13, 2026 06:19
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents codelibs/fess#3440 in the 15.9 tree.
That PR fixes how Fess reports a search result that is not complete. The partial flag used to be set only when a shard failed, while the UI message and the
[SEARCH TIMEOUT]log line called it a timeout, and a real query timeout was not flagged at all. Now/api/v2/searchreturnstimed_outandshard_failednext topartial, andquery.timeout.loggingwrites[SEARCH TIMEOUT]for a timed-out search and[SEARCH SHARD FAILURE]for a search that lost a shard.Changes, all in the 15.9 tree:
api/api-search.rst(7 languages):timed_outandshard_failedadded to the response example and the field table, and thepartialrow now says it is always true when either is, and can also be true with neither when the search could not be run.config/search-advanced.rst(7 languages): thequery.timeout.loggingsection describes both log lines, that both are written when both happen, what each line contains, and that the reason for a shard failure is in_shards.failuresof the logged response because the search engine logs it only at DEBUG. Headings are unchanged, so anchors do not move.en/15.9/config/search-config.rst: the one paragraph onquery.timeout.logginggets the same correction.config/properties.rstandproperties.po: regenerated withtools/update_properties_doc.shfrom the fix(search): tell a query timeout apart from a failed shard fess#3440 branch. The only change is the new description ofquery.timeout.logging. If that description changes before the PR is merged, the script needs to run again.The admin search-list API is not changed by codelibs/fess#3440, so its page is untouched.
Verification
python3 tools/gen_properties_doc.py --check: the 7 properties pages agree.python3 tools/check_headings.pyon the 15.8 and 15.9 trees: passes.python3 -m unittest discover -s tools: 79 tests OK..rstfiles, compared withmain: no new system messages, section counts unchanged, the response tables still two columns, and the JSON examples parse in every language.dummybuild of each language's 15.9 tree, compared withmain: the warning count is identical in every language.The non-English wording has not been reviewed by native speakers.