Skip to content

Commit 2622e92

Browse files
authored
Add bolt configs (neo4j#1474)
1 parent a805184 commit 2622e92

File tree

1 file changed

+163
-2
lines changed

1 file changed

+163
-2
lines changed

modules/ROOT/pages/configuration/configuration-settings.adoc

Lines changed: 163 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ m|+++LIST+++
414414
|Description
415415
a|Minimum number of machines initially required to form a clustered DBMS. The cluster is considered formed when at least this many members have discovered each other, bound together and bootstrapped a highly available system database. As a result, at least this many of the cluster's initial machines must have `<<config_server.cluster.system_database_mode,server.cluster.system_database_mode>>` set to 'PRIMARY'.NOTE: If `<<config_dbms.cluster.discovery.resolver_type,dbms.cluster.discovery.resolver_type>>` is set to 'LIST' and `<<config_dbms.cluster.discovery.endpoints,dbms.cluster.discovery.endpoints>>` is empty then the user is assumed to be deploying a standalone DBMS, and the value of this setting is ignored.
416416
|Valid values
417-
a|An integer that is minimum `2`.
417+
a|An integer that is minimum `1`.
418418
|Default value
419419
m|+++3+++
420420
|===
@@ -1197,8 +1197,66 @@ a|A boolean.
11971197
m|+++false+++
11981198
|===
11991199

1200+
[role=label--new-5.18]
1201+
[[config_server.bolt.enable_network_error_accounting]]
1202+
=== `server.bolt.enable_network_error_accounting`
12001203

1201-
[[config_server.bolt.thread_pool_keep_alive]]
1204+
.server.bolt.enable_network_error_accounting
1205+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1206+
|===
1207+
|Description
1208+
a|Enables accounting based reporting of benign errors within the Bolt stack (when enabled, benign errors are reported only when such events occur with unusual frequency.
1209+
Otherwise, all benign network errors will be reported
1210+
|Valid values
1211+
a|A boolean.
1212+
|Default value
1213+
m|+++true+++
1214+
|===
1215+
1216+
[role=label--new-5.18]
1217+
[[config_server.bolt.network_abort_clear_window_duration]]
1218+
=== `server.bolt.network_abort_clear_window_duration`
1219+
1220+
.server.bolt.network_abort_clear_window_duration
1221+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1222+
|===
1223+
|Description
1224+
a|The duration for which network related connection aborts need to remain at a reasonable level before the error is cleared
1225+
|Valid values
1226+
a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s) that is minimum `1s`.
1227+
|Default value
1228+
m|+++10m+++
1229+
|===
1230+
1231+
[role=label--new-5.18]
1232+
[[config_server.bolt.network_abort_warn_threshold]]
1233+
=== `server.bolt.network_abort_warn_threshold`
1234+
1235+
.server.bolt.network_abort_warn_threshold
1236+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1237+
|===
1238+
|Description
1239+
a|The maximum amount of network related connection aborts permitted within a given window before emitting log messages (a value of zero reverts to legacy warning behavior)
1240+
|Valid values
1241+
a|A long that is minimum `1`.
1242+
|Default value
1243+
m|+++2+++
1244+
|===
1245+
1246+
[role=label--new-5.18]
1247+
[[config_server.bolt.network_abort_warn_window_duration]]
1248+
=== `server.bolt.network_abort_warn_window_duration`
1249+
1250+
.server.bolt.network_abort_warn_window_duration
1251+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1252+
|===
1253+
|Description
1254+
a|The duration of the window in which network related connection aborts are sampled
1255+
|Valid values
1256+
a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s) that is minimum `1s`.
1257+
|Default value
1258+
m|+++10m+++
1259+
|===
12021260

12031261

12041262
[[config_server.bolt.thread_pool_keep_alive]]
@@ -1245,6 +1303,50 @@ a|An integer.
12451303
m|+++5+++
12461304
|===
12471305

1306+
[role=label--new-5.18]
1307+
[[config_server.bolt.thread_starvation_clear_window_duration]]
1308+
=== `server.bolt.thread_starvation_clear_window_duration`
1309+
1310+
.server.bolt.thread_starvation_clear_window_duration
1311+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1312+
|===
1313+
|Description
1314+
a|The duration for which unscheduled requests need to remain at a reasonable level before the error is cleared
1315+
|Valid values
1316+
a| A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s) that is minimum `1s`.
1317+
|Default value
1318+
m|+++10m+++
1319+
|===
1320+
1321+
[role=label--new-5.18]
1322+
[[config_server.bolt.thread_starvation_warn_threshold]]
1323+
=== `server.bolt.thread_starvation_warn_threshold`
1324+
1325+
.server.bolt.thread_starvation_warn_threshold
1326+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1327+
|===
1328+
|Description
1329+
a|The maximum amount of unscheduled requests permitted during thread starvation events within a given window before emitting log messages
1330+
|Valid values
1331+
a|A long that is minimum `1`.
1332+
|Default value
1333+
m|+++2+++
1334+
|===
1335+
1336+
[role=label--new-5.18]
1337+
[[config_server.bolt.thread_starvation_warn_window_duration]]
1338+
=== `server.bolt.thread_starvation_warn_window_duration`
1339+
1340+
.server.bolt.thread_starvation_warn_window_duration
1341+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1342+
|===
1343+
|Description
1344+
a|The duration of the window in which unscheduled requests are sampled
1345+
|Valid values
1346+
a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s) that is minimum `1s`.
1347+
|Default value
1348+
m|+++10m+++
1349+
|===
12481350

12491351
[[config_server.bolt.tls_level]]
12501352
=== `server.bolt.tls_level`
@@ -1260,6 +1362,65 @@ a|One of [REQUIRED, OPTIONAL, DISABLED].
12601362
m|+++DISABLED+++
12611363
|===
12621364

1365+
[role=label--new-5.18]
1366+
[[config_server.bolt.traffic_accounting_check_period]]
1367+
=== `server.bolt.traffic_accounting_check_period`
1368+
1369+
.server.bolt.traffic_accounting_check_period
1370+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1371+
|===
1372+
|Description
1373+
a|Amount of time spent between samples of current traffic usage (lower values result in more accurate reporting while incurring a higher performance penalty; a value of zero disables traffic accounting)
1374+
|Valid values
1375+
a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s) that is 0s or is minimum `1m`.
1376+
|Default value
1377+
m|+++5m+++
1378+
|===
1379+
1380+
[role=label--new-5.18]
1381+
[[config_server.bolt.traffic_accounting_clear_duration]]
1382+
=== `server.bolt.traffic_accounting_clear_duration`
1383+
1384+
.server.bolt.traffic_accounting_clear_duration
1385+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1386+
|===
1387+
|Description
1388+
a|Time required to be spent below the configured traffic threshold in order to clear traffic warnings
1389+
|Valid values
1390+
a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s) that is minimum `1m`.
1391+
|Default value
1392+
m|+++10m+++
1393+
|===
1394+
1395+
[role=label--new-5.18]
1396+
[[server.bolt.traffic_accounting_incoming_threshold_mbps]]
1397+
=== `server.bolt.traffic_accounting_incoming_threshold_mbps`
1398+
1399+
.server.bolt.traffic_accounting_incoming_threshold_mbps
1400+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1401+
|===
1402+
|Description
1403+
a|Maximum permitted incoming traffic within a configured accounting check window before emitting a warning (in Mbps)
1404+
|Valid values
1405+
a|A long that is minimum `1`.
1406+
|Default value
1407+
m|+++950+++
1408+
|===
1409+
1410+
[role=label--new-5.18]
1411+
[[server.bolt.traffic_accounting_outgoing_threshold_mbps]]
1412+
=== `server.bolt.traffic_accounting_outgoing_threshold_mbps`
1413+
1414+
.server.bolt.traffic_accounting_outgoing_threshold_mbps
1415+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1416+
|===
1417+
|Description
1418+
a|Maximum permitted outgoing traffic within a configured accounting check window before emitting a warning (in Mbps)
1419+
|Valid values
1420+
a|A long that is minimum `1`.
1421+
|Default value
1422+
m|+++950+++
1423+
|===
12631424

12641425
[[config_server.http.advertised_address]]
12651426
=== `server.http.advertised_address`

0 commit comments

Comments
 (0)