Skip to content

Commit 158942b

Browse files
arangodb-docs-automation[bot]CircleCI JobSimran-B
authored
[CircleCI Generated] generate-scheduled-9401 (#506)
* [skip ci] Automatic commit of generated files from CircleCI * Release notes for new cluster health metric * Revert changes to arangod.json --------- Co-authored-by: CircleCI Job <[email protected]> Co-authored-by: Simran Spiller <[email protected]>
1 parent d9ea21f commit 158942b

File tree

13 files changed

+73
-32
lines changed

13 files changed

+73
-32
lines changed

site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,6 +1061,16 @@ small requests.
10611061
Compression for all Agency traffic is disabled regardless of the settings
10621062
of these options.
10631063

1064+
### Read-only shards metric
1065+
1066+
<small>Introduced in: v3.12.1</small>
1067+
1068+
The following cluster health metric has been added:
1069+
1070+
| Label | Description |
1071+
|:------|:------------|
1072+
| `arangodb_vocbase_shards_read_only_by_write_concern` | Number of shards that are read-only due to an undercut of the write concern. |
1073+
10641074
## Client tools
10651075

10661076
### Protocol aliases for endpoints

site/content/3.13/release-notes/version-3.12/whats-new-in-3-12.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,6 +1061,16 @@ small requests.
10611061
Compression for all Agency traffic is disabled regardless of the settings
10621062
of these options.
10631063

1064+
### Read-only shards metric
1065+
1066+
<small>Introduced in: v3.12.1</small>
1067+
1068+
The following cluster health metric has been added:
1069+
1070+
| Label | Description |
1071+
|:------|:------------|
1072+
| `arangodb_vocbase_shards_read_only_by_write_concern` | Number of shards that are read-only due to an undercut of the write concern. |
1073+
10641074
## Client tools
10651075

10661076
### Protocol aliases for endpoints

site/data/3.11/arangod.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1400,7 +1400,7 @@
14001400
"agent",
14011401
"single"
14021402
],
1403-
"default" : 7739682816,
1403+
"default" : 7739683840,
14041404
"deprecatedIn" : null,
14051405
"description" : "The global size limit for all caches (in bytes).",
14061406
"dynamic" : true,
@@ -7518,15 +7518,15 @@
75187518
"type" : "boolean"
75197519
},
75207520
"query.global-memory-limit" : {
7521-
"base" : 33106214912,
7521+
"base" : 33106219008,
75227522
"category" : "option",
75237523
"component" : [
75247524
"coordinator",
75257525
"dbserver",
75267526
"agent",
75277527
"single"
75287528
],
7529-
"default" : 26816034078,
7529+
"default" : 26816037397,
75307530
"deprecatedIn" : null,
75317531
"description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).",
75327532
"dynamic" : true,
@@ -7816,15 +7816,15 @@
78167816
"type" : "double"
78177817
},
78187818
"query.memory-limit" : {
7819-
"base" : 33106214912,
7819+
"base" : 33106219008,
78207820
"category" : "option",
78217821
"component" : [
78227822
"coordinator",
78237823
"dbserver",
78247824
"agent",
78257825
"single"
78267826
],
7827-
"default" : 19863728947,
7827+
"default" : 19863731405,
78287828
"deprecatedIn" : null,
78297829
"description" : "The memory threshold per AQL query (in bytes, 0 = no limit).",
78307830
"dynamic" : true,
@@ -9059,7 +9059,7 @@
90599059
"agent",
90609060
"single"
90619061
],
9062-
"default" : 9287619379,
9062+
"default" : 9287620608,
90639063
"deprecatedIn" : null,
90649064
"description" : "The size of block cache (in bytes).",
90659065
"dynamic" : true,
@@ -11640,7 +11640,7 @@
1164011640
"agent",
1164111641
"single"
1164211642
],
11643-
"default" : 12383492505,
11643+
"default" : 12383494144,
1164411644
"deprecatedIn" : null,
1164511645
"description" : "The maximum total size of in-memory write buffers (0 = unbounded).",
1164611646
"dynamic" : true,

site/data/3.12/allMetrics.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5928,6 +5928,29 @@
59285928
by a server option. V8 contexts are created and destroyed as needed
59295929
but there are never fewer than the limit shown in this metric.
59305930
5931+
- name: arangodb_vocbase_shards_read_only_by_write_concern
5932+
introducedIn: "3.12.1"
5933+
help: |
5934+
Number of shards that are read-only due to an undercut of the write concern.
5935+
unit: number
5936+
type: gauge
5937+
category: Replication
5938+
complexity: simple
5939+
exposedBy:
5940+
- dbserver
5941+
description: |
5942+
Number of shards that are in read-only mode because there are not at least write concern many in-sync replicas.
5943+
troubleshoot: |
5944+
If this metrics has a value greater than 0, then some
5945+
action is indicated. During an upgrade or when some DB-Server was
5946+
restarted, it can happen that shard followers are out of sync and thus
5947+
the write concern is undercut. Normally, shards should get in sync on
5948+
their own, so observation and waiting is a good measure at first.
5949+
However, if the situation persists, something is wrong, potentially
5950+
some constant server crash (maybe out of memory crashes?) or another
5951+
situation preventing shards to get in sync.
5952+
Contact ArangoDB customer support in this case.
5953+
59315954
- name: rocksdb_actual_delayed_write_rate
59325955
introducedIn: "3.6.1"
59335956
help: |

site/data/3.12/arangobackup.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,7 +1036,7 @@
10361036
},
10371037
"server.authentication" : {
10381038
"category" : "option",
1039-
"default" : false,
1039+
"default" : true,
10401040
"deprecatedIn" : null,
10411041
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
10421042
"dynamic" : false,
@@ -1100,7 +1100,7 @@
11001100
"server.endpoint" : {
11011101
"category" : "option",
11021102
"default" : [
1103-
"http+tcp://127.0.0.1:8529"
1103+
"tcp://127.0.0.1:8529"
11041104
],
11051105
"deprecatedIn" : null,
11061106
"description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://",

site/data/3.12/arangobench.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1341,7 +1341,7 @@
13411341
},
13421342
"server.authentication" : {
13431343
"category" : "option",
1344-
"default" : false,
1344+
"default" : true,
13451345
"deprecatedIn" : null,
13461346
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
13471347
"dynamic" : false,
@@ -1405,7 +1405,7 @@
14051405
"server.endpoint" : {
14061406
"category" : "option",
14071407
"default" : [
1408-
"http+tcp://127.0.0.1:8529"
1408+
"tcp://127.0.0.1:8529"
14091409
],
14101410
"deprecatedIn" : null,
14111411
"description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://",

site/data/3.12/arangod.json

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2280,7 +2280,7 @@
22802280
"agent",
22812281
"single"
22822282
],
2283-
"default" : "",
2283+
"default" : "/var/lib/arangodb3",
22842284
"deprecatedIn" : null,
22852285
"description" : "The path to the database directory.",
22862286
"dynamic" : false,
@@ -3435,7 +3435,7 @@
34353435
"coordinator",
34363436
"single"
34373437
],
3438-
"default" : "./js/apps",
3438+
"default" : "/var/lib/arangodb3-apps",
34393439
"deprecatedIn" : null,
34403440
"description" : "The directory for Foxx applications.",
34413441
"dynamic" : false,
@@ -3710,7 +3710,6 @@
37103710
"single"
37113711
],
37123712
"default" : [
3713-
"./enterprise/js"
37143713
],
37153714
"deprecatedIn" : null,
37163715
"description" : "Additional paths containing JavaScript modules.",
@@ -3786,7 +3785,7 @@
37863785
"coordinator",
37873786
"single"
37883787
],
3789-
"default" : "./js",
3788+
"default" : "/usr/share/arangodb3/js",
37903789
"deprecatedIn" : null,
37913790
"description" : "A path to the directory containing the JavaScript startup scripts.",
37923791
"dynamic" : false,
@@ -4249,7 +4248,7 @@
42494248
"agent",
42504249
"single"
42514250
],
4252-
"default" : "",
4251+
"default" : "-",
42534252
"deprecatedIn" : null,
42544253
"description" : "shortcut for '--log.output file://<filename>'",
42554254
"dynamic" : false,

site/data/3.12/arangodump.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1390,7 +1390,7 @@
13901390
},
13911391
"server.authentication" : {
13921392
"category" : "option",
1393-
"default" : false,
1393+
"default" : true,
13941394
"deprecatedIn" : null,
13951395
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
13961396
"dynamic" : false,
@@ -1454,7 +1454,7 @@
14541454
"server.endpoint" : {
14551455
"category" : "option",
14561456
"default" : [
1457-
"http+tcp://127.0.0.1:8529"
1457+
"tcp://127.0.0.1:8529"
14581458
],
14591459
"deprecatedIn" : null,
14601460
"description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://",

site/data/3.12/arangoexport.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1126,7 +1126,7 @@
11261126
},
11271127
"server.authentication" : {
11281128
"category" : "option",
1129-
"default" : false,
1129+
"default" : true,
11301130
"deprecatedIn" : null,
11311131
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
11321132
"dynamic" : false,
@@ -1190,7 +1190,7 @@
11901190
"server.endpoint" : {
11911191
"category" : "option",
11921192
"default" : [
1193-
"http+tcp://127.0.0.1:8529"
1193+
"tcp://127.0.0.1:8529"
11941194
],
11951195
"deprecatedIn" : null,
11961196
"description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://",

site/data/3.12/arangoimport.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1325,7 +1325,7 @@
13251325
},
13261326
"server.authentication" : {
13271327
"category" : "option",
1328-
"default" : false,
1328+
"default" : true,
13291329
"deprecatedIn" : null,
13301330
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
13311331
"dynamic" : false,
@@ -1389,7 +1389,7 @@
13891389
"server.endpoint" : {
13901390
"category" : "option",
13911391
"default" : [
1392-
"http+tcp://127.0.0.1:8529"
1392+
"tcp://127.0.0.1:8529"
13931393
],
13941394
"deprecatedIn" : null,
13951395
"description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://",

0 commit comments

Comments
 (0)