Skip to content

Commit 19f41fe

Browse files
arangodb-docs-automation[bot]CircleCI JobSimran-B
authored
[CircleCI Generated] generate-scheduled-14477 (#847)
* [skip ci] Automatic commit of generated files from CircleCI * Patch introducedIn version of arangodb_server_statistics_cpu_cgroup_version metric --------- Co-authored-by: CircleCI Job <simran@arango.ai> Co-authored-by: Simran Spiller <simran@arangodb.com>
1 parent c648838 commit 19f41fe

23 files changed

+710
-70
lines changed

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" : 7735569408,
1403+
"default" : 7735567360,
14041404
"deprecatedIn" : null,
14051405
"description" : "The global size limit for all caches (in bytes).",
14061406
"dynamic" : true,
@@ -7575,15 +7575,15 @@
75757575
"type" : "boolean"
75767576
},
75777577
"query.global-memory-limit" : {
7578-
"base" : 33089761280,
7578+
"base" : 33089753088,
75797579
"category" : "option",
75807580
"component" : [
75817581
"coordinator",
75827582
"dbserver",
75837583
"agent",
75847584
"single"
75857585
],
7586-
"default" : 26802706636,
7586+
"default" : 26802700002,
75877587
"deprecatedIn" : null,
75887588
"description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).",
75897589
"dynamic" : true,
@@ -7873,15 +7873,15 @@
78737873
"type" : "double"
78747874
},
78757875
"query.memory-limit" : {
7876-
"base" : 33089761280,
7876+
"base" : 33089753088,
78777877
"category" : "option",
78787878
"component" : [
78797879
"coordinator",
78807880
"dbserver",
78817881
"agent",
78827882
"single"
78837883
],
7884-
"default" : 19853856768,
7884+
"default" : 19853851853,
78857885
"deprecatedIn" : null,
78867886
"description" : "The memory threshold per AQL query (in bytes, 0 = no limit).",
78877887
"dynamic" : true,
@@ -9116,7 +9116,7 @@
91169116
"agent",
91179117
"single"
91189118
],
9119-
"default" : 9282683289,
9119+
"default" : 9282680832,
91209120
"deprecatedIn" : null,
91219121
"description" : "The size of block cache (in bytes).",
91229122
"dynamic" : true,
@@ -11725,7 +11725,7 @@
1172511725
"agent",
1172611726
"single"
1172711727
],
11728-
"default" : 12376911052,
11728+
"default" : 12376907776,
1172911729
"deprecatedIn" : null,
1173011730
"description" : "The maximum total size of in-memory write buffers (0 = unbounded).",
1173111731
"dynamic" : true,

site/data/3.12/allMetrics.yaml

Lines changed: 194 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2689,6 +2689,105 @@
26892689
This metric tracks the runtime of phase2 of an Agency sync. Phase2 calculates
26902690
what actions to execute given the difference of the local and target state.
26912691
2692+
- name: arangodb_metadata_number_of_collections
2693+
introducedIn: "3.12.7"
2694+
help: |
2695+
Global number of collections.
2696+
unit: number
2697+
type: gauge
2698+
category: Statistics
2699+
complexity: simple
2700+
exposedBy:
2701+
- coordinator
2702+
- single
2703+
description: |
2704+
Total number of collections in the deployment (cluster or single server).
2705+
This includes system collections.
2706+
troubleshoot: |
2707+
**Configuration:**
2708+
- No global limit on collection count
2709+
- Query limit: `--query.max-collections-per-query` (default: 2048)
2710+
- Queries exceeding this fail with "too many collections/shards" error
2711+
2712+
**Impact:**
2713+
- High counts affect startup/shutdown times, memory, and file descriptors
2714+
- Each collection consumes memory for indexes and metadata
2715+
- Impacts backup and restore operations
2716+
2717+
**Recommendations:**
2718+
- Remove unused or temporary collections regularly
2719+
- Consider consolidating related collections
2720+
- Review schema design to reduce collection proliferation
2721+
2722+
**See also:**
2723+
- Query limits: https://github.com/arangodb/arangodb/issues/10787
2724+
- Operational factors: https://docs.arango.ai/arangodb/stable/develop/operational-factors/
2725+
2726+
- name: arangodb_metadata_number_of_databases
2727+
introducedIn: "3.12.7"
2728+
help: |
2729+
Global number of databases.
2730+
unit: number
2731+
type: gauge
2732+
category: Statistics
2733+
complexity: simple
2734+
exposedBy:
2735+
- coordinator
2736+
- single
2737+
description: |
2738+
Total number of databases in the deployment (cluster or single server).
2739+
troubleshoot: |
2740+
**Configuration:**
2741+
- Maximum controlled by `--database.max-databases` (default: unlimited)
2742+
- Exceeding limit returns `TRI_ERROR_RESOURCE_LIMIT`
2743+
2744+
**Impact:**
2745+
- High counts affect startup time, memory usage, and file descriptors
2746+
- Each database adds operational overhead
2747+
2748+
**Recommendations:**
2749+
- Remove unused databases
2750+
2751+
**See also:**
2752+
- Operational factors: https://docs.arango.ai/arangodb/stable/develop/operational-factors/
2753+
2754+
- name: arangodb_metadata_number_of_shards
2755+
introducedIn: "3.12.7"
2756+
help: |
2757+
Global number of shards.
2758+
unit: number
2759+
type: gauge
2760+
category: Statistics
2761+
complexity: simple
2762+
exposedBy:
2763+
- coordinator
2764+
description: |
2765+
Total number of shards in the deployment. In a cluster,
2766+
this is the number of shards across all collections.
2767+
troubleshoot: |
2768+
**Configuration:**
2769+
- Max per collection: `--cluster.max-number-of-shards` (default: 1000)
2770+
- Exceeding limit returns `TRI_ERROR_CLUSTER_TOO_MANY_SHARDS`
2771+
- Query limit: `--query.max-collections-per-query` affects total shards in queries
2772+
- Queries exceeding this fail with "too many collections/shards" error
2773+
- Practical cluster limit: ~50,000 total shards across all collections
2774+
2775+
**Impact:**
2776+
- High shard counts increase cluster coordination overhead
2777+
- Affects query performance, memory usage, leader election, and rebalancing
2778+
2779+
**Recommendations:**
2780+
- Choose shard count based on data volume, query patterns, and DB-Server count
2781+
- Use rebalancing to ensure even distribution
2782+
2783+
**Note:**
2784+
- Approaching 50k shards may cause performance degradation
2785+
2786+
**See also:**
2787+
- Cluster limitations: https://docs.arango.ai/arangodb/stable/deploy/cluster/limitations/
2788+
- Query limits: https://github.com/arangodb/arangodb/issues/10787
2789+
- Operational factors: https://docs.arango.ai/arangodb/stable/develop/operational-factors/
2790+
26922791
- name: arangodb_network_connectivity_failures_coordinators_total
26932792
introducedIn: "3.11.4"
26942793
help: |
@@ -5500,6 +5599,30 @@
55005599
Amount of memory in bytes that is used for writing to an inverted index of
55015600
a collection or index of a View (`arangosearch` View link).
55025601
5602+
- name: arangodb_server_statistics_cpu_cgroup_version
5603+
introducedIn: "3.12.7"
5604+
help: |
5605+
CGroup version detected on the system (0=none, 1=v1, 2=v2).
5606+
unit: number
5607+
type: gauge
5608+
category: Statistics
5609+
complexity: simple
5610+
exposedBy:
5611+
- coordinator
5612+
- dbserver
5613+
- agent
5614+
- single
5615+
description: |
5616+
Indicates which cgroup version was detected on the system at startup:
5617+
- 0: No cgroup support detected
5618+
- 1: cgroup v1 (legacy) detected
5619+
- 2: cgroup v2 (unified hierarchy) detected
5620+
5621+
This metric is useful for understanding whether container resource limits
5622+
(CPU quotas) can be detected by ArangoDB. Systems with cgroup support
5623+
typically report more accurate CPU core counts when running in containers.
5624+
5625+
55035626
- name: arangodb_server_statistics_cpu_cores
55045627
introducedIn: "3.8.0"
55055628
help: |
@@ -5518,6 +5641,74 @@
55185641
environment variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES`
55195642
is set. In that case, the environment variable's value is reported.
55205643
5644+
- name: arangodb_server_statistics_effective_cpu_cores
5645+
introducedIn: "3.12.7"
5646+
help: |
5647+
Number of effective CPU cores available to the arangod process.
5648+
unit: number
5649+
type: gauge
5650+
category: Statistics
5651+
complexity: simple
5652+
exposedBy:
5653+
- coordinator
5654+
- dbserver
5655+
- agent
5656+
- single
5657+
description: |
5658+
Number of effective CPU cores available to the arangod process, taking into
5659+
account container CPU limits when running in containerized environments.
5660+
5661+
This value is determined by:
5662+
- **cgroup v1**: Reading `/sys/fs/cgroup/cpu/cpu.cfs_quota_us` and
5663+
`/sys/fs/cgroup/cpu/cpu.cfs_period_us` to calculate CPU quota
5664+
- **cgroup v2**: Reading `/sys/fs/cgroup/cpu.max` to get CPU quota
5665+
- **No cgroups**: Falls back to total CPU cores from the system
5666+
5667+
When running in Docker or Kubernetes with CPU limits set (e.g., `--cpus=2`),
5668+
this metric will report the container's CPU limit rather than the host's
5669+
total CPU cores, providing a more accurate view of available CPU resources
5670+
for capacity planning and auto-scaling decisions.
5671+
5672+
If the environment variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES`
5673+
is set, it takes precedence over both cgroup limits and detected CPU cores.
5674+
5675+
This metric includes a `machine_id` label to help identify the physical host
5676+
in containerized environments.
5677+
5678+
5679+
- name: arangodb_server_statistics_effective_physical_memory
5680+
introducedIn: "3.12.7"
5681+
help: |
5682+
Effective physical memory available to the arangod process in bytes.
5683+
unit: bytes
5684+
type: gauge
5685+
category: Statistics
5686+
complexity: simple
5687+
exposedBy:
5688+
- coordinator
5689+
- dbserver
5690+
- agent
5691+
- single
5692+
description: |
5693+
Effective physical memory available to the arangod process in bytes,
5694+
taking into account container memory limits when running in containerized
5695+
environments.
5696+
5697+
This value is determined by:
5698+
- **cgroup v1**: Reading `/sys/fs/cgroup/memory/memory.limit_in_bytes`
5699+
- **cgroup v2**: Reading `/sys/fs/cgroup/memory.max`
5700+
- **No cgroups**: Falls back to total physical memory
5701+
5702+
When running in Docker or Kubernetes with memory limits set, this metric
5703+
will report the container's memory limit rather than the host's total
5704+
physical memory, providing a more accurate view of available memory for
5705+
capacity planning and monitoring.
5706+
5707+
If the environment variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY`
5708+
is set, it takes precedence over both cgroup limits and detected physical
5709+
memory.
5710+
5711+
55215712
- name: arangodb_server_statistics_idle_percent
55225713
introducedIn: "3.8.0"
55235714
help: |
@@ -5638,9 +5829,7 @@
56385829
category: Replication
56395830
complexity: simple
56405831
exposedBy:
5641-
- coordinator
56425832
- dbserver
5643-
- agent
56445833
description: |
56455834
Number of leader shards on this machine. Every shard has a leader and
56465835
potentially multiple followers.
@@ -5668,13 +5857,11 @@
56685857
category: Replication
56695858
complexity: simple
56705859
exposedBy:
5671-
- coordinator
56725860
- dbserver
5673-
- agent
56745861
description: |
56755862
Number of shards not replicated at all. This is counted for all shards
56765863
for which this server is currently the leader. The number is increased
5677-
by one for every shards for which no follower is in sync.
5864+
by one for every shard for which no follower is in sync.
56785865
troubleshoot: |
56795866
Needless to say, such a situation is very bad for resilience, since it
56805867
indicates a single point of failure. So, if this number is greater than 0,
@@ -5722,9 +5909,9 @@
57225909
exposedBy:
57235910
- dbserver
57245911
description: |
5725-
Number of leader shards not fully replicated. This is counted for all
5912+
Number of shards that are not fully replicated. This is counted for all
57265913
shards for which this server is currently the leader. The number is
5727-
increased by one for every shards for which not all followers are in sync.
5914+
increased by one for every shard for which not all followers are in sync.
57285915
troubleshoot: |
57295916
Needless to say, such a situation is not good resilience, since we
57305917
do not have as many copies of the data as the `replicationFactor`

site/data/3.12/arangobackup.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1006,7 +1006,7 @@
10061006
},
10071007
"server.authentication" : {
10081008
"category" : "option",
1009-
"default" : false,
1009+
"default" : true,
10101010
"deprecatedIn" : null,
10111011
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
10121012
"dynamic" : false,
@@ -1067,7 +1067,7 @@
10671067
"server.endpoint" : {
10681068
"category" : "option",
10691069
"default" : [
1070-
"http+tcp://127.0.0.1:8529"
1070+
"tcp://127.0.0.1:8529"
10711071
],
10721072
"deprecatedIn" : null,
10731073
"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
@@ -1275,7 +1275,7 @@
12751275
},
12761276
"server.authentication" : {
12771277
"category" : "option",
1278-
"default" : false,
1278+
"default" : true,
12791279
"deprecatedIn" : null,
12801280
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
12811281
"dynamic" : false,
@@ -1336,7 +1336,7 @@
13361336
"server.endpoint" : {
13371337
"category" : "option",
13381338
"default" : [
1339-
"http+tcp://127.0.0.1:8529"
1339+
"tcp://127.0.0.1:8529"
13401340
],
13411341
"deprecatedIn" : null,
13421342
"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)