From 69cd28649df94e49eeb325634bb94fa0ed3ad088 Mon Sep 17 00:00:00 2001 From: Shinsuke Sugaya Date: Sun, 13 Sep 2026 14:21:49 +0900 Subject: [PATCH] docs(15.9): document timed_out, shard_failed and the split timeout logging 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. --- de/15.9/api/api-search.rst | 8 +++++++- de/15.9/config/properties.po | 2 +- de/15.9/config/properties.rst | 2 +- de/15.9/config/search-advanced.rst | 10 +++++++++- en/15.9/api/api-search.rst | 8 +++++++- en/15.9/config/properties.rst | 2 +- en/15.9/config/search-advanced.rst | 10 +++++++++- en/15.9/config/search-config.rst | 2 +- es/15.9/api/api-search.rst | 8 +++++++- es/15.9/config/properties.po | 2 +- es/15.9/config/properties.rst | 2 +- es/15.9/config/search-advanced.rst | 10 +++++++++- fr/15.9/api/api-search.rst | 8 +++++++- fr/15.9/config/properties.po | 2 +- fr/15.9/config/properties.rst | 2 +- fr/15.9/config/search-advanced.rst | 10 +++++++++- ja/15.9/api/api-search.rst | 8 +++++++- ja/15.9/config/properties.po | 2 +- ja/15.9/config/properties.rst | 2 +- ja/15.9/config/search-advanced.rst | 10 +++++++++- ko/15.9/api/api-search.rst | 8 +++++++- ko/15.9/config/properties.po | 2 +- ko/15.9/config/properties.rst | 2 +- ko/15.9/config/search-advanced.rst | 10 +++++++++- zh-cn/15.9/api/api-search.rst | 8 +++++++- zh-cn/15.9/config/properties.po | 2 +- zh-cn/15.9/config/properties.rst | 2 +- zh-cn/15.9/config/search-advanced.rst | 10 +++++++++- 28 files changed, 126 insertions(+), 28 deletions(-) diff --git a/de/15.9/api/api-search.rst b/de/15.9/api/api-search.rst index 448b01848..e51209d18 100644 --- a/de/15.9/api/api-search.rst +++ b/de/15.9/api/api-search.rst @@ -96,6 +96,8 @@ Bei Erfolg (200) werden die folgenden Felder direkt unter ``response`` im gemein "end_record_number": 20, "page_numbers": ["1", "2", "3"], "partial": false, + "timed_out": false, + "shard_failed": false, "search_query": "title:Fess OR content:Fess", "requested_time": 1717142400000, "related_query": ["enterprise search"], @@ -159,7 +161,11 @@ Die einzelnen Felder sind wie folgt beschrieben: * - ``page_numbers`` - Array der im Pager angezeigten Seitennummern (Zeichenketten). * - ``partial`` - - Gibt an, ob das Ergebnis unvollständig ist (bool). + - Gibt an, ob das Ergebnis unvollständig sein kann (bool). Immer ``true``, wenn ``timed_out`` oder ``shard_failed`` den Wert ``true`` hat; kann aber auch ``true`` sein, wenn keines von beiden zutrifft, zum Beispiel wenn die Suche nicht ausgeführt werden konnte. + * - ``timed_out`` + - Gibt an, ob das Such-Timeout (``query.timeout``) abgelaufen ist und die Suchmaschine das Sammeln von Treffern abgebrochen hat (bool). + * - ``shard_failed`` + - Gibt an, ob bei einem oder mehreren Shards ein Fehler aufgetreten ist (bool). * - ``search_query`` - Tatsächlich ausgeführte Suchabfrage. * - ``requested_time`` diff --git a/de/15.9/config/properties.po b/de/15.9/config/properties.po index df1b64150..b97f2b179 100644 --- a/de/15.9/config/properties.po +++ b/de/15.9/config/properties.po @@ -789,7 +789,7 @@ msgstr "" msgid "Timeout (ms) for search queries." msgstr "" -msgid "Whether to enable logging for query timeouts." +msgid "Whether to log searches whose results are incomplete because the query timed out or a shard failed." msgstr "" msgid "Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused." diff --git a/de/15.9/config/properties.rst b/de/15.9/config/properties.rst index 89f83201c..aa528d427 100644 --- a/de/15.9/config/properties.rst +++ b/de/15.9/config/properties.rst @@ -1042,7 +1042,7 @@ Index - Timeout (ms) for search queries. - ``10000`` * - query.timeout.logging - - Whether to enable logging for query timeouts. + - Whether to log searches whose results are incomplete because the query timed out or a shard failed. - ``true`` * - query.track.total.hits - Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused. diff --git a/de/15.9/config/search-advanced.rst b/de/15.9/config/search-advanced.rst index cf027fb8e..7153397cd 100644 --- a/de/15.9/config/search-advanced.rst +++ b/de/15.9/config/search-advanced.rst @@ -38,7 +38,15 @@ Standardwert ist 1000 Zeichen. Protokollierung von Such-Timeouts ================================== -Protokollierungseinstellung für den Fall von Such-Timeouts. +Legt fest, ob Suchen protokolliert werden, deren Ergebnisse unvollständig sind, weil das Such-Timeout abgelaufen ist oder ein Shard fehlgeschlagen ist. +Ist die Einstellung aktiviert, wird in folgenden Fällen eine Protokollzeile der Stufe WARN ausgegeben: + +- ``[SEARCH TIMEOUT]``: Das Such-Timeout (``query.timeout``) ist abgelaufen und die Suchmaschine hat das Sammeln von Treffern abgebrochen. +- ``[SEARCH SHARD FAILURE]``: Bei einem oder mehreren Shards ist ein Fehler aufgetreten. + +Tritt beides auf, werden beide Zeilen ausgegeben. +Jede Zeile enthält ``exec_time`` (Millisekunden), die Anfrage und die vollständige Antwort. +Bei einem Shard-Fehler steht die Ursache in ``_shards.failures`` dieser Antwort; die Suchmaschine selbst protokolliert sie nur auf der Stufe DEBUG. Standardwert ist ``true`` (aktiviert). :: diff --git a/en/15.9/api/api-search.rst b/en/15.9/api/api-search.rst index cd8b2421f..bd0107462 100644 --- a/en/15.9/api/api-search.rst +++ b/en/15.9/api/api-search.rst @@ -96,6 +96,8 @@ On success (200), the following fields are returned directly under ``response`` "end_record_number": 20, "page_numbers": ["1", "2", "3"], "partial": false, + "timed_out": false, + "shard_failed": false, "search_query": "title:Fess OR content:Fess", "requested_time": 1717142400000, "related_query": ["enterprise search"], @@ -159,7 +161,11 @@ Each field is described below. * - ``page_numbers`` - Array of page numbers to display in the pager (strings). * - ``partial`` - - Whether the result is partial (bool). + - Whether the result may be incomplete (bool). Always ``true`` when ``timed_out`` or ``shard_failed`` is ``true``; it can also be ``true`` when neither is, for example when the search could not be run. + * - ``timed_out`` + - Whether the query timeout (``query.timeout``) elapsed and the search engine stopped collecting results (bool). + * - ``shard_failed`` + - Whether one or more shards failed (bool). * - ``search_query`` - The actual search query that was executed. * - ``requested_time`` diff --git a/en/15.9/config/properties.rst b/en/15.9/config/properties.rst index 89f83201c..aa528d427 100644 --- a/en/15.9/config/properties.rst +++ b/en/15.9/config/properties.rst @@ -1042,7 +1042,7 @@ Index - Timeout (ms) for search queries. - ``10000`` * - query.timeout.logging - - Whether to enable logging for query timeouts. + - Whether to log searches whose results are incomplete because the query timed out or a shard failed. - ``true`` * - query.track.total.hits - Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused. diff --git a/en/15.9/config/search-advanced.rst b/en/15.9/config/search-advanced.rst index ba4f5afae..934edb415 100644 --- a/en/15.9/config/search-advanced.rst +++ b/en/15.9/config/search-advanced.rst @@ -38,7 +38,15 @@ The default is 1000 characters. Search Timeout Logging ====================== -Log output setting when a search timeout occurs. +Whether to log searches whose results are incomplete because the query timed out or a shard failed. +When enabled, a WARN log line is written in the following cases: + +- ``[SEARCH TIMEOUT]``: the query timeout (``query.timeout``) elapsed and the search engine stopped collecting results. +- ``[SEARCH SHARD FAILURE]``: one or more shards failed. + +When both happen, both lines are written. +Each line contains ``exec_time`` (milliseconds), the request and the full response. +For a shard failure, the reason is in ``_shards.failures`` of that response; the search engine itself logs it only at DEBUG level. The default is ``true`` (enabled). :: diff --git a/en/15.9/config/search-config.rst b/en/15.9/config/search-config.rst index 9d3808fd3..62717d8bc 100644 --- a/en/15.9/config/search-config.rst +++ b/en/15.9/config/search-config.rst @@ -33,7 +33,7 @@ You can specify the maximum character count for searches. The default value is 1 Search Timeout Logging ====================== -This setting controls log output when a timeout occurs during a search. The default value is `true (enabled)`. +This setting controls whether searches whose results are incomplete are logged. A WARN line starting with `[SEARCH TIMEOUT]` is written when the query timed out, and one starting with `[SEARCH SHARD FAILURE]` when one or more shards failed; the reason for a shard failure is in `_shards.failures` of the logged response. The default value is `true (enabled)`. :: query.timeout.logging=true diff --git a/es/15.9/api/api-search.rst b/es/15.9/api/api-search.rst index d804954eb..cc50c287b 100644 --- a/es/15.9/api/api-search.rst +++ b/es/15.9/api/api-search.rst @@ -96,6 +96,8 @@ En caso de éxito (200), se devuelven los siguientes campos directamente bajo `` "end_record_number": 20, "page_numbers": ["1", "2", "3"], "partial": false, + "timed_out": false, + "shard_failed": false, "search_query": "title:Fess OR content:Fess", "requested_time": 1717142400000, "related_query": ["enterprise search"], @@ -159,7 +161,11 @@ Los campos son los siguientes: * - ``page_numbers`` - Array de números de página para mostrar en el paginador (cadenas de texto). * - ``partial`` - - Si los resultados son parciales (bool). + - Si los resultados pueden ser parciales (bool). Siempre es ``true`` cuando ``timed_out`` o ``shard_failed`` es ``true``; también puede ser ``true`` sin que lo sea ninguno de los dos, por ejemplo cuando no se pudo ejecutar la búsqueda. + * - ``timed_out`` + - Si se agotó el tiempo de espera de la consulta (``query.timeout``) y el motor de búsqueda dejó de recopilar resultados (bool). + * - ``shard_failed`` + - Si fallaron uno o más shards (bool). * - ``search_query`` - La consulta de búsqueda que se ejecutó realmente. * - ``requested_time`` diff --git a/es/15.9/config/properties.po b/es/15.9/config/properties.po index df1b64150..b97f2b179 100644 --- a/es/15.9/config/properties.po +++ b/es/15.9/config/properties.po @@ -789,7 +789,7 @@ msgstr "" msgid "Timeout (ms) for search queries." msgstr "" -msgid "Whether to enable logging for query timeouts." +msgid "Whether to log searches whose results are incomplete because the query timed out or a shard failed." msgstr "" msgid "Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused." diff --git a/es/15.9/config/properties.rst b/es/15.9/config/properties.rst index 89f83201c..aa528d427 100644 --- a/es/15.9/config/properties.rst +++ b/es/15.9/config/properties.rst @@ -1042,7 +1042,7 @@ Index - Timeout (ms) for search queries. - ``10000`` * - query.timeout.logging - - Whether to enable logging for query timeouts. + - Whether to log searches whose results are incomplete because the query timed out or a shard failed. - ``true`` * - query.track.total.hits - Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused. diff --git a/es/15.9/config/search-advanced.rst b/es/15.9/config/search-advanced.rst index 25321498d..3f3c46371 100644 --- a/es/15.9/config/search-advanced.rst +++ b/es/15.9/config/search-advanced.rst @@ -38,7 +38,15 @@ El valor predeterminado es 1000 caracteres. Registro de Tiempos de Espera en Búsqueda ========================================== -Esta es la configuración de registro para cuando se excede el tiempo de espera durante las búsquedas. +Indica si se registran las búsquedas cuyos resultados están incompletos porque se agotó el tiempo de espera de la consulta o falló un shard. +Si está activada, se escribe una línea de registro de nivel WARN en los siguientes casos: + +- ``[SEARCH TIMEOUT]``: se agotó el tiempo de espera de la consulta (``query.timeout``) y el motor de búsqueda dejó de recopilar resultados. +- ``[SEARCH SHARD FAILURE]``: fallaron uno o más shards. + +Si ocurren ambos casos, se escriben ambas líneas. +Cada línea contiene ``exec_time`` (milisegundos), la solicitud y la respuesta completa. +En caso de fallo de un shard, el motivo se encuentra en ``_shards.failures`` de esa respuesta; el propio motor de búsqueda solo lo registra en el nivel DEBUG. El valor predeterminado es ``true`` (activado). :: diff --git a/fr/15.9/api/api-search.rst b/fr/15.9/api/api-search.rst index 689505f7a..0bef76544 100644 --- a/fr/15.9/api/api-search.rst +++ b/fr/15.9/api/api-search.rst @@ -96,6 +96,8 @@ En cas de succès (200), les champs suivants sont retournés directement sous `` "end_record_number": 20, "page_numbers": ["1", "2", "3"], "partial": false, + "timed_out": false, + "shard_failed": false, "search_query": "title:Fess OR content:Fess", "requested_time": 1717142400000, "related_query": ["enterprise search"], @@ -159,7 +161,11 @@ Les détails de chaque champ sont les suivants. * - ``page_numbers`` - Tableau des numéros de page à afficher dans le paginateur (chaînes de caractères). * - ``partial`` - - Indique si les résultats sont partiels (bool). + - Indique si les résultats peuvent être partiels (bool). Vaut toujours ``true`` lorsque ``timed_out`` ou ``shard_failed`` vaut ``true`` ; peut aussi valoir ``true`` sans que ce soit le cas de l'un ou l'autre, par exemple lorsque la recherche n'a pas pu être exécutée. + * - ``timed_out`` + - Indique si le délai d'expiration de la requête (``query.timeout``) a été dépassé et si le moteur de recherche a cessé de collecter les résultats (bool). + * - ``shard_failed`` + - Indique si un ou plusieurs shards ont échoué (bool). * - ``search_query`` - Requête de recherche réellement exécutée. * - ``requested_time`` diff --git a/fr/15.9/config/properties.po b/fr/15.9/config/properties.po index df1b64150..b97f2b179 100644 --- a/fr/15.9/config/properties.po +++ b/fr/15.9/config/properties.po @@ -789,7 +789,7 @@ msgstr "" msgid "Timeout (ms) for search queries." msgstr "" -msgid "Whether to enable logging for query timeouts." +msgid "Whether to log searches whose results are incomplete because the query timed out or a shard failed." msgstr "" msgid "Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused." diff --git a/fr/15.9/config/properties.rst b/fr/15.9/config/properties.rst index 89f83201c..aa528d427 100644 --- a/fr/15.9/config/properties.rst +++ b/fr/15.9/config/properties.rst @@ -1042,7 +1042,7 @@ Index - Timeout (ms) for search queries. - ``10000`` * - query.timeout.logging - - Whether to enable logging for query timeouts. + - Whether to log searches whose results are incomplete because the query timed out or a shard failed. - ``true`` * - query.track.total.hits - Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused. diff --git a/fr/15.9/config/search-advanced.rst b/fr/15.9/config/search-advanced.rst index 5fb3d0738..3954c6a94 100644 --- a/fr/15.9/config/search-advanced.rst +++ b/fr/15.9/config/search-advanced.rst @@ -38,7 +38,15 @@ La valeur initiale est de 1000 caractères. Journalisation du délai d'expiration lors de la recherche ========================================================== -Paramètre de journalisation en cas de délai d'expiration lors de la recherche. +Indique si les recherches dont les résultats sont incomplets, parce que le délai d'expiration de la requête a été dépassé ou qu'un shard a échoué, sont journalisées. +Lorsque ce paramètre est activé, une ligne de journal de niveau WARN est écrite dans les cas suivants : + +- ``[SEARCH TIMEOUT]`` : le délai d'expiration de la requête (``query.timeout``) a été dépassé et le moteur de recherche a cessé de collecter les résultats. +- ``[SEARCH SHARD FAILURE]`` : un ou plusieurs shards ont échoué. + +Si les deux se produisent, les deux lignes sont écrites. +Chaque ligne contient ``exec_time`` (millisecondes), la requête et la réponse complète. +En cas d'échec d'un shard, la cause figure dans ``_shards.failures`` de cette réponse ; le moteur de recherche lui-même ne la journalise qu'au niveau DEBUG. La valeur initiale est ``true`` (activé). :: diff --git a/ja/15.9/api/api-search.rst b/ja/15.9/api/api-search.rst index a5bc24af5..1b993f562 100644 --- a/ja/15.9/api/api-search.rst +++ b/ja/15.9/api/api-search.rst @@ -96,6 +96,8 @@ HTTPメソッド GET "end_record_number": 20, "page_numbers": ["1", "2", "3"], "partial": false, + "timed_out": false, + "shard_failed": false, "search_query": "title:Fess OR content:Fess", "requested_time": 1717142400000, "related_query": ["enterprise search"], @@ -159,7 +161,11 @@ HTTPメソッド GET * - ``page_numbers`` - ページャーに表示するページ番号の配列（文字列）。 * - ``partial`` - - 結果が部分的かどうか（bool）。 + - 結果が部分的である可能性があるかどうか（bool）。 ``timed_out`` または ``shard_failed`` が ``true`` のときは常に ``true`` になります。どちらも ``false`` でも、検索を実行できなかった場合などに ``true`` になることがあります。 + * - ``timed_out`` + - 検索時のタイムアウト値 ``query.timeout`` を超え、検索エンジンが結果の収集を打ち切ったかどうか（bool）。 + * - ``shard_failed`` + - 1つ以上のシャードで検索が失敗したかどうか（bool）。 * - ``search_query`` - 実際に実行された検索クエリ。 * - ``requested_time`` diff --git a/ja/15.9/config/properties.po b/ja/15.9/config/properties.po index df1b64150..b97f2b179 100644 --- a/ja/15.9/config/properties.po +++ b/ja/15.9/config/properties.po @@ -789,7 +789,7 @@ msgstr "" msgid "Timeout (ms) for search queries." msgstr "" -msgid "Whether to enable logging for query timeouts." +msgid "Whether to log searches whose results are incomplete because the query timed out or a shard failed." msgstr "" msgid "Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused." diff --git a/ja/15.9/config/properties.rst b/ja/15.9/config/properties.rst index 89f83201c..aa528d427 100644 --- a/ja/15.9/config/properties.rst +++ b/ja/15.9/config/properties.rst @@ -1042,7 +1042,7 @@ Index - Timeout (ms) for search queries. - ``10000`` * - query.timeout.logging - - Whether to enable logging for query timeouts. + - Whether to log searches whose results are incomplete because the query timed out or a shard failed. - ``true`` * - query.track.total.hits - Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused. diff --git a/ja/15.9/config/search-advanced.rst b/ja/15.9/config/search-advanced.rst index a1dfdc0b1..607159050 100644 --- a/ja/15.9/config/search-advanced.rst +++ b/ja/15.9/config/search-advanced.rst @@ -38,7 +38,15 @@ 検索時のタイムアウトのログ出力 ======================= -検索時、タイムアウトした場合のログ出力設定です。 +クエリのタイムアウトやシャードの失敗により結果が不完全になった検索を、ログに出力するかどうかの設定です。 +有効な場合、以下のときに WARN レベルのログを出力します。 + +- ``[SEARCH TIMEOUT]`` : 検索時のタイムアウト値 ``query.timeout`` を超え、検索エンジンが結果の収集を打ち切った場合 +- ``[SEARCH SHARD FAILURE]`` : 1つ以上のシャードで検索が失敗した場合 + +両方が発生した場合は、両方のログを出力します。 +各ログには ``exec_time`` （ミリ秒）、リクエスト、およびレスポンス全体が含まれます。 +シャードの失敗理由は、そのレスポンスの ``_shards.failures`` に記録されています。検索エンジン自体はこの理由を DEBUG レベルでしかログに出力しません。 初期値は ``true`` (有効)です。 :: diff --git a/ko/15.9/api/api-search.rst b/ko/15.9/api/api-search.rst index c4c4d71a1..d806973a9 100644 --- a/ko/15.9/api/api-search.rst +++ b/ko/15.9/api/api-search.rst @@ -96,6 +96,8 @@ HTTP 메서드 GET "end_record_number": 20, "page_numbers": ["1", "2", "3"], "partial": false, + "timed_out": false, + "shard_failed": false, "search_query": "title:Fess OR content:Fess", "requested_time": 1717142400000, "related_query": ["enterprise search"], @@ -159,7 +161,11 @@ HTTP 메서드 GET * - ``page_numbers`` - 페이지네이션에 표시할 페이지 번호 배열 (문자열). * - ``partial`` - - 결과가 부분적인지 여부 (bool). + - 결과가 부분적일 수 있는지 여부 (bool). ``timed_out`` 또는 ``shard_failed`` 가 ``true`` 이면 항상 ``true`` 입니다. 둘 다 ``false`` 여도 검색을 실행할 수 없었던 경우 등에는 ``true`` 가 될 수 있습니다. + * - ``timed_out`` + - 검색 시 타임아웃 값 ``query.timeout`` 을 초과하여 검색 엔진이 결과 수집을 중단했는지 여부 (bool). + * - ``shard_failed`` + - 하나 이상의 샤드에서 검색이 실패했는지 여부 (bool). * - ``search_query`` - 실제로 실행된 검색 쿼리. * - ``requested_time`` diff --git a/ko/15.9/config/properties.po b/ko/15.9/config/properties.po index df1b64150..b97f2b179 100644 --- a/ko/15.9/config/properties.po +++ b/ko/15.9/config/properties.po @@ -789,7 +789,7 @@ msgstr "" msgid "Timeout (ms) for search queries." msgstr "" -msgid "Whether to enable logging for query timeouts." +msgid "Whether to log searches whose results are incomplete because the query timed out or a shard failed." msgstr "" msgid "Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused." diff --git a/ko/15.9/config/properties.rst b/ko/15.9/config/properties.rst index 89f83201c..aa528d427 100644 --- a/ko/15.9/config/properties.rst +++ b/ko/15.9/config/properties.rst @@ -1042,7 +1042,7 @@ Index - Timeout (ms) for search queries. - ``10000`` * - query.timeout.logging - - Whether to enable logging for query timeouts. + - Whether to log searches whose results are incomplete because the query timed out or a shard failed. - ``true`` * - query.track.total.hits - Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused. diff --git a/ko/15.9/config/search-advanced.rst b/ko/15.9/config/search-advanced.rst index d45c9f38f..87438ea17 100644 --- a/ko/15.9/config/search-advanced.rst +++ b/ko/15.9/config/search-advanced.rst @@ -38,7 +38,15 @@ 검색 시 타임아웃 로그 출력 ======================= -검색 시 타임아웃된 경우의 로그 출력 설정입니다. +쿼리 타임아웃이나 샤드 실패로 인해 결과가 불완전해진 검색을 로그에 출력할지 여부를 설정합니다. +활성화된 경우 다음과 같은 때에 WARN 레벨의 로그를 출력합니다. + +- ``[SEARCH TIMEOUT]`` : 검색 시 타임아웃 값 ``query.timeout`` 을 초과하여 검색 엔진이 결과 수집을 중단한 경우 +- ``[SEARCH SHARD FAILURE]`` : 하나 이상의 샤드에서 검색이 실패한 경우 + +둘 다 발생한 경우에는 두 로그를 모두 출력합니다. +각 로그에는 ``exec_time`` (밀리초), 요청 및 전체 응답이 포함됩니다. +샤드 실패 원인은 해당 응답의 ``_shards.failures`` 에 기록됩니다. 검색 엔진 자체는 이 원인을 DEBUG 레벨로만 로그에 출력합니다. 기본값은 ``true`` (활성화)입니다. :: diff --git a/zh-cn/15.9/api/api-search.rst b/zh-cn/15.9/api/api-search.rst index 776305021..2edd1c300 100644 --- a/zh-cn/15.9/api/api-search.rst +++ b/zh-cn/15.9/api/api-search.rst @@ -96,6 +96,8 @@ HTTP 方法 GET "end_record_number": 20, "page_numbers": ["1", "2", "3"], "partial": false, + "timed_out": false, + "shard_failed": false, "search_query": "title:Fess OR content:Fess", "requested_time": 1717142400000, "related_query": ["enterprise search"], @@ -159,7 +161,11 @@ HTTP 方法 GET * - ``page_numbers`` - 分页器中显示的页码数组（字符串）。 * - ``partial`` - - 结果是否为部分结果（bool）。 + - 结果是否可能不完整（bool）。\ ``timed_out`` 或 ``shard_failed`` 为 ``true`` 时始终为 ``true``\ ；两者均为 ``false`` 时，也可能因无法执行搜索等原因而为 ``true``\ 。 + * - ``timed_out`` + - 是否超过了搜索超时值 ``query.timeout``\ ，导致搜索引擎停止收集结果（bool）。 + * - ``shard_failed`` + - 是否有一个或多个分片搜索失败（bool）。 * - ``search_query`` - 实际执行的搜索查询。 * - ``requested_time`` diff --git a/zh-cn/15.9/config/properties.po b/zh-cn/15.9/config/properties.po index df1b64150..b97f2b179 100644 --- a/zh-cn/15.9/config/properties.po +++ b/zh-cn/15.9/config/properties.po @@ -789,7 +789,7 @@ msgstr "" msgid "Timeout (ms) for search queries." msgstr "" -msgid "Whether to enable logging for query timeouts." +msgid "Whether to log searches whose results are incomplete because the query timed out or a shard failed." msgstr "" msgid "Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused." diff --git a/zh-cn/15.9/config/properties.rst b/zh-cn/15.9/config/properties.rst index 89f83201c..aa528d427 100644 --- a/zh-cn/15.9/config/properties.rst +++ b/zh-cn/15.9/config/properties.rst @@ -1042,7 +1042,7 @@ Index - Timeout (ms) for search queries. - ``10000`` * - query.timeout.logging - - Whether to enable logging for query timeouts. + - Whether to log searches whose results are incomplete because the query timed out or a shard failed. - ``true`` * - query.track.total.hits - Maximum number of total hits to track in queries. Only a positive number or true is supported: false leaves the response without a hit count, and a search that asks for it, here or as a search parameter, is refused. diff --git a/zh-cn/15.9/config/search-advanced.rst b/zh-cn/15.9/config/search-advanced.rst index 5f8189a81..1cafc668b 100644 --- a/zh-cn/15.9/config/search-advanced.rst +++ b/zh-cn/15.9/config/search-advanced.rst @@ -38,7 +38,15 @@ 搜索超时日志输出 ================ -搜索时超时情况下的日志输出配置。 +设置是否将因查询超时或分片失败而导致结果不完整的搜索输出到日志。 +启用时，在以下情况下输出 WARN 级别的日志。 + +- ``[SEARCH TIMEOUT]``\ ：超过搜索超时值 ``query.timeout``\ ，搜索引擎停止收集结果时 +- ``[SEARCH SHARD FAILURE]``\ ：一个或多个分片搜索失败时 + +两者同时发生时，会输出两条日志。 +每条日志包含 ``exec_time``\ （毫秒）、请求以及完整的响应。 +分片失败的原因记录在该响应的 ``_shards.failures`` 中。搜索引擎本身仅在 DEBUG 级别记录该原因。 初始值为 ``true``\ （启用）。 ::