Skip to content

Commit d5f714b

Browse files
DOC-12152
waitUntilReady
1 parent bd3811e commit d5f714b

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

modules/ref/pages/client-settings.adoc

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,27 @@ Full details can be found in https://docs.couchbase.com/sdk-api/couchbase-node-c
1616

1717
// section on wide area network support
1818

19-
include::{version-common}@sdk:shared:partial$client-settings-wide-network.adoc[]
19+
== Commonly Used Options
20+
21+
The defaults above have been carefully considered and in general it is not recommended to make changes without expert guidance or careful testing of the change.
22+
Some options may be commonly used together in certain envionments or to achieve certain effects.
23+
24+
=== Constrained Network Environments
25+
26+
Though xref:project-docs:compatibility.adoc#network-requirements[wide area network] (WAN) connections are not directly supported, some development and non-critical operations activities across a WAN are convenient.
27+
Most likely for connecting to Couchbase Capella, or Server running in your own cloud account, whilst developing from a laptop or other machine not located in the same data center.
28+
These settings are some you may want to consider adjusting:
29+
30+
* Connect Timeout to 30s
31+
* Key-Value Timeout to 5s
32+
* Config Poll Interval to 10s
33+
* Circuit Breaker ErrorThresholdPercentage to 75
34+
35+
NOTE: As of SDK API 3.4 you can also use a *Configuration Profile*, which allows you to quickly configure your environment for common use-cases.
36+
See the <<configuration-profiles>> section for more details.
37+
38+
// the below is the above with WaitUntilReady added - which is not in the Node.js SDK.
39+
// include::{version-common}@sdk:shared:partial$client-settings-wide-network.adoc[]
2040

2141
== Configuration Profiles
2242

0 commit comments

Comments
 (0)