Skip to content

Commit 0877744

Browse files
Restore troubleshooting content (#2727) (#2728)
Co-authored-by: Marci W <[email protected]>
1 parent 71fe13f commit 0877744

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

Diff for: docs/reference/timeout-best-practices.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/timeout-best-practices.html
4+
---
5+
6+
# Timeout best practices [timeout-best-practices]
7+
8+
Starting in 9.0.0, this client is configured to not time out any HTTP request by default. {{es}} will always eventually respond to any request, even if it takes several minutes. Reissuing a request that it has not responded to yet can cause performance side effects. See the [official {{es}} recommendations for HTTP clients](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration) for more information.
9+
10+
Prior to 9.0, this client was configured by default to operate like many HTTP client libraries do, by using a relatively short (30 second) timeout on all requests sent to {{es}}, raising a `TimeoutError` when that time period elapsed without receiving a response.
11+
12+
If you need to set timeouts on Elasticsearch requests, setting the `requestTimeout` value to a millisecond value will cause this client to operate as it did prior to 9.0.
13+

Diff for: docs/reference/toc.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,5 @@ toc:
3131
- file: update_examples.md
3232
- file: update_by_query_examples.md
3333
- file: reindex_examples.md
34-
- file: client-helpers.md
34+
- file: client-helpers.md
35+
- file: timeout-best-practices.md

0 commit comments

Comments
 (0)