Skip to content

Commit 78d33e9

Browse files
committed
Merge branch 'link-fixes' of https://github.com/arangodb/docs-hugo into link-fixes
2 parents 55041e7 + 018cebf commit 78d33e9

38 files changed

+591
-118
lines changed

site/config/_default/config.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,13 @@ outputFormats:
3232
baseName: nav
3333
isHTML: true
3434
mediaType: text/html
35+
notfound:
36+
baseName: notfound
37+
isHTML: true
38+
mediaType: text/html
3539

3640
outputs:
37-
home: ["HTML", "navigation"]
41+
home: ["HTML", "navigation", "notfound"]
3842

3943
enableRobotsTXT: true
4044

site/content/3.10/release-notes/version-3.10/whats-new-in-3-10.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1406,6 +1406,30 @@ The caching subsystem now provides the following 3 additional metrics:
14061406
so they can be recycled quickly. The overall amount of inactive tables is
14071407
limited, so not much memory will be used here.
14081408

1409+
### Observability of in-memory cache subsystem
1410+
1411+
<small>Introduced in: v3.10.11</small>
1412+
1413+
The following metrics have been added to improve the observability of in-memory
1414+
cache subsystem:
1415+
- `rocksdb_cache_free_memory_tasks_total`: Total number of free memory tasks
1416+
that were scheduled by the in-memory edge cache subsystem. This metric will
1417+
be increased whenever the cache subsystem schedules a task to free up memory
1418+
in one of the managed in-memory caches. It is expected to see this metric
1419+
rising when the cache subsystem hits its global memory budget.
1420+
- `rocksdb_cache_free_memory_tasks_duration_total`: Total amount of time spent
1421+
inside the free memory tasks of the in-memory cache subsystem. Free memory
1422+
tasks are scheduled by the cache subsystem to free up memory in existing cache
1423+
hash tables.
1424+
- `rocksdb_cache_migrate_tasks_total`: Total number of migrate tasks that were
1425+
scheduled by the in-memory edge cache subsystem. This metric will be increased
1426+
whenever the cache subsystem schedules a task to migrate an existing cache hash
1427+
table to a bigger or smaller size.
1428+
- `rocksdb_cache_migrate_tasks_duration_total`: Total amount of time spent inside
1429+
the migrate tasks of the in-memory cache subsystem. Migrate tasks are scheduled
1430+
by the cache subsystem to migrate existing cache hash tables to a bigger or
1431+
smaller table.
1432+
14091433
### Replication improvements
14101434

14111435
For synchronous replication of document operations in the cluster, the follower

site/content/3.11/release-notes/version-3.10/whats-new-in-3-10.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1406,6 +1406,30 @@ The caching subsystem now provides the following 3 additional metrics:
14061406
so they can be recycled quickly. The overall amount of inactive tables is
14071407
limited, so not much memory will be used here.
14081408

1409+
### Observability of in-memory cache subsystem
1410+
1411+
<small>Introduced in: v3.10.11</small>
1412+
1413+
The following metrics have been added to improve the observability of in-memory
1414+
cache subsystem:
1415+
- `rocksdb_cache_free_memory_tasks_total`: Total number of free memory tasks
1416+
that were scheduled by the in-memory edge cache subsystem. This metric will
1417+
be increased whenever the cache subsystem schedules a task to free up memory
1418+
in one of the managed in-memory caches. It is expected to see this metric
1419+
rising when the cache subsystem hits its global memory budget.
1420+
- `rocksdb_cache_free_memory_tasks_duration_total`: Total amount of time spent
1421+
inside the free memory tasks of the in-memory cache subsystem. Free memory
1422+
tasks are scheduled by the cache subsystem to free up memory in existing cache
1423+
hash tables.
1424+
- `rocksdb_cache_migrate_tasks_total`: Total number of migrate tasks that were
1425+
scheduled by the in-memory edge cache subsystem. This metric will be increased
1426+
whenever the cache subsystem schedules a task to migrate an existing cache hash
1427+
table to a bigger or smaller size.
1428+
- `rocksdb_cache_migrate_tasks_duration_total`: Total amount of time spent inside
1429+
the migrate tasks of the in-memory cache subsystem. Migrate tasks are scheduled
1430+
by the cache subsystem to migrate existing cache hash tables to a bigger or
1431+
smaller table.
1432+
14091433
### Replication improvements
14101434

14111435
For synchronous replication of document operations in the cluster, the follower

site/content/3.11/release-notes/version-3.11/whats-new-in-3-11.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,6 +1217,30 @@ The following metrics have been added:
12171217
| `rocksdb_cache_edge_empty_inserts_total` | Total number of insertions into the in-memory edge cache for non-connected edges. |
12181218
| `rocksdb_cache_edge_inserts_total` | Total number of insertions into the in-memory edge cache. |
12191219

1220+
### Observability of in-memory cache subsystem
1221+
1222+
<small>Introduced in: v3.10.11, v.3.11.4</small>
1223+
1224+
The following metrics have been added to improve the observability of in-memory
1225+
cache subsystem:
1226+
- `rocksdb_cache_free_memory_tasks_total`: Total number of free memory tasks
1227+
that were scheduled by the in-memory edge cache subsystem. This metric will
1228+
be increased whenever the cache subsystem schedules a task to free up memory
1229+
in one of the managed in-memory caches. It is expected to see this metric
1230+
rising when the cache subsystem hits its global memory budget.
1231+
- `rocksdb_cache_free_memory_tasks_duration_total`: Total amount of time spent
1232+
inside the free memory tasks of the in-memory cache subsystem. Free memory
1233+
tasks are scheduled by the cache subsystem to free up memory in existing cache
1234+
hash tables.
1235+
- `rocksdb_cache_migrate_tasks_total`: Total number of migrate tasks that were
1236+
scheduled by the in-memory edge cache subsystem. This metric will be increased
1237+
whenever the cache subsystem schedules a task to migrate an existing cache hash
1238+
table to a bigger or smaller size.
1239+
- `rocksdb_cache_migrate_tasks_duration_total`: Total amount of time spent inside
1240+
the migrate tasks of the in-memory cache subsystem. Migrate tasks are scheduled
1241+
by the cache subsystem to migrate existing cache hash tables to a bigger or
1242+
smaller table.
1243+
12201244
## Client tools
12211245

12221246
### arangodump

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1406,6 +1406,30 @@ The caching subsystem now provides the following 3 additional metrics:
14061406
so they can be recycled quickly. The overall amount of inactive tables is
14071407
limited, so not much memory will be used here.
14081408

1409+
### Observability of in-memory cache subsystem
1410+
1411+
<small>Introduced in: v3.10.11</small>
1412+
1413+
The following metrics have been added to improve the observability of in-memory
1414+
cache subsystem:
1415+
- `rocksdb_cache_free_memory_tasks_total`: Total number of free memory tasks
1416+
that were scheduled by the in-memory edge cache subsystem. This metric will
1417+
be increased whenever the cache subsystem schedules a task to free up memory
1418+
in one of the managed in-memory caches. It is expected to see this metric
1419+
rising when the cache subsystem hits its global memory budget.
1420+
- `rocksdb_cache_free_memory_tasks_duration_total`: Total amount of time spent
1421+
inside the free memory tasks of the in-memory cache subsystem. Free memory
1422+
tasks are scheduled by the cache subsystem to free up memory in existing cache
1423+
hash tables.
1424+
- `rocksdb_cache_migrate_tasks_total`: Total number of migrate tasks that were
1425+
scheduled by the in-memory edge cache subsystem. This metric will be increased
1426+
whenever the cache subsystem schedules a task to migrate an existing cache hash
1427+
table to a bigger or smaller size.
1428+
- `rocksdb_cache_migrate_tasks_duration_total`: Total amount of time spent inside
1429+
the migrate tasks of the in-memory cache subsystem. Migrate tasks are scheduled
1430+
by the cache subsystem to migrate existing cache hash tables to a bigger or
1431+
smaller table.
1432+
14091433
### Replication improvements
14101434

14111435
For synchronous replication of document operations in the cluster, the follower

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,6 +1217,30 @@ The following metrics have been added:
12171217
| `rocksdb_cache_edge_empty_inserts_total` | Total number of insertions into the in-memory edge cache for non-connected edges. |
12181218
| `rocksdb_cache_edge_inserts_total` | Total number of insertions into the in-memory edge cache. |
12191219

1220+
### Observability of in-memory cache subsystem
1221+
1222+
<small>Introduced in: v3.10.11, v.3.11.4</small>
1223+
1224+
The following metrics have been added to improve the observability of in-memory
1225+
cache subsystem:
1226+
- `rocksdb_cache_free_memory_tasks_total`: Total number of free memory tasks
1227+
that were scheduled by the in-memory edge cache subsystem. This metric will
1228+
be increased whenever the cache subsystem schedules a task to free up memory
1229+
in one of the managed in-memory caches. It is expected to see this metric
1230+
rising when the cache subsystem hits its global memory budget.
1231+
- `rocksdb_cache_free_memory_tasks_duration_total`: Total amount of time spent
1232+
inside the free memory tasks of the in-memory cache subsystem. Free memory
1233+
tasks are scheduled by the cache subsystem to free up memory in existing cache
1234+
hash tables.
1235+
- `rocksdb_cache_migrate_tasks_total`: Total number of migrate tasks that were
1236+
scheduled by the in-memory edge cache subsystem. This metric will be increased
1237+
whenever the cache subsystem schedules a task to migrate an existing cache hash
1238+
table to a bigger or smaller size.
1239+
- `rocksdb_cache_migrate_tasks_duration_total`: Total amount of time spent inside
1240+
the migrate tasks of the in-memory cache subsystem. Migrate tasks are scheduled
1241+
by the cache subsystem to migrate existing cache hash tables to a bigger or
1242+
smaller table.
1243+
12201244
## Client tools
12211245

12221246
### arangodump

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,30 @@ The following metrics have been added:
137137
| `rocksdb_cache_edge_empty_inserts_total` | Total number of insertions into the in-memory edge cache for non-connected edges. |
138138
| `rocksdb_cache_edge_inserts_total` | Total number of insertions into the in-memory edge cache. |
139139

140+
### Observability of in-memory cache subsystem
141+
142+
<small>Introduced in: v3.10.11, v.3.11.4, v.3.12.0</small>
143+
144+
The following metrics have been added to improve the observability of in-memory
145+
cache subsystem:
146+
- `rocksdb_cache_free_memory_tasks_total`: Total number of free memory tasks
147+
that were scheduled by the in-memory edge cache subsystem. This metric will
148+
be increased whenever the cache subsystem schedules a task to free up memory
149+
in one of the managed in-memory caches. It is expected to see this metric
150+
rising when the cache subsystem hits its global memory budget.
151+
- `rocksdb_cache_free_memory_tasks_duration_total`: Total amount of time spent
152+
inside the free memory tasks of the in-memory cache subsystem. Free memory
153+
tasks are scheduled by the cache subsystem to free up memory in existing cache
154+
hash tables.
155+
- `rocksdb_cache_migrate_tasks_total`: Total number of migrate tasks that were
156+
scheduled by the in-memory edge cache subsystem. This metric will be increased
157+
whenever the cache subsystem schedules a task to migrate an existing cache hash
158+
table to a bigger or smaller size.
159+
- `rocksdb_cache_migrate_tasks_duration_total`: Total amount of time spent inside
160+
the migrate tasks of the in-memory cache subsystem. Migrate tasks are scheduled
161+
by the cache subsystem to migrate existing cache hash tables to a bigger or
162+
smaller table.
163+
140164
### RocksDB .sst file partitioning (experimental)
141165

142166
The following experimental startup options for RockDB .sst file partitioning

site/data/3.10/allMetrics.yaml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4991,6 +4991,45 @@
49914991
startup option is enabled.
49924992
On Agents and Coordinators, the values reported by this metric are always zero.
49934993
4994+
- name: rocksdb_cache_free_memory_tasks_duration_total
4995+
introducedIn: "3.10.11"
4996+
help: |
4997+
Total amount of time spent in 'free memory' tasks of the in-memory
4998+
cache subsystem.
4999+
unit: us
5000+
type: counter
5001+
category: Statistics
5002+
complexity: advanced
5003+
exposedBy:
5004+
- dbserver
5005+
- agent
5006+
- single
5007+
description: |
5008+
Total amount of time spent inside 'free memory' tasks of the in-memory
5009+
cache subsystem. 'free memory' tasks are scheduled by the cache subsystem
5010+
to free up memory in existing cache hash tables.
5011+
5012+
- name: rocksdb_cache_free_memory_tasks_total
5013+
introducedIn: "3.10.11"
5014+
help: |
5015+
Total number of 'free memory' tasks scheduled by the in-memory
5016+
cache subsystem.
5017+
unit: number
5018+
type: counter
5019+
category: Statistics
5020+
complexity: advanced
5021+
exposedBy:
5022+
- dbserver
5023+
- agent
5024+
- single
5025+
description: |
5026+
Total number of 'free memory' tasks that were scheduled by the
5027+
in-memory edge cache subsystem. This metric will be increased
5028+
whenever the cache subsystem schedules a task to free up memory
5029+
in one of the managed in-memory caches. It is expected to see
5030+
this metric rising when the cache subsystem hits its global
5031+
memory budget.
5032+
49945033
- name: rocksdb_cache_full_index_refills_total
49955034
introducedIn: "3.10.2"
49965035
help: |
@@ -5069,6 +5108,43 @@
50695108
edge cache counts towards this allocation. This global limit can
50705109
be controlled with the `--cache.size` startup option.
50715110
5111+
- name: rocksdb_cache_migrate_tasks_duration_total
5112+
introducedIn: "3.10.11"
5113+
help: |
5114+
Total amount of time spent in 'migrate' tasks of the in-memory
5115+
cache subsystem.
5116+
unit: us
5117+
type: counter
5118+
category: Statistics
5119+
complexity: advanced
5120+
exposedBy:
5121+
- dbserver
5122+
- agent
5123+
- single
5124+
description: |
5125+
Total amount of time spent inside 'migrate' tasks of the in-memory
5126+
cache subsystem. 'migrate' tasks are scheduled by the cache subsystem
5127+
to migrate existing cache hash tables to a bigger or smaller table.
5128+
5129+
- name: rocksdb_cache_migrate_tasks_total
5130+
introducedIn: "3.10.11"
5131+
help: |
5132+
Total number of 'migrate' tasks scheduled by the in-memory
5133+
cache subsystem.
5134+
unit: number
5135+
type: counter
5136+
category: Statistics
5137+
complexity: advanced
5138+
exposedBy:
5139+
- dbserver
5140+
- agent
5141+
- single
5142+
description: |
5143+
Total number of 'migrate' tasks that were scheduled by the
5144+
in-memory edge cache subsystem. This metric will be increased
5145+
whenever the cache subsystem schedules a task to migrate an
5146+
existing cache hash table to a bigger or smaller size.
5147+
50725148
- name: rocksdb_cache_peak_allocated
50735149
introducedIn: "3.10.7"
50745150
help: |

site/data/3.11/allMetrics.yaml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5537,6 +5537,45 @@
55375537
the cache had no memory left). The metric is not decreased when data gets
55385538
evicted from the cache.
55395539
5540+
- name: rocksdb_cache_free_memory_tasks_duration_total
5541+
introducedIn: "3.10.11"
5542+
help: |
5543+
Total amount of time spent in 'free memory' tasks of the in-memory
5544+
cache subsystem.
5545+
unit: us
5546+
type: counter
5547+
category: Statistics
5548+
complexity: advanced
5549+
exposedBy:
5550+
- dbserver
5551+
- agent
5552+
- single
5553+
description: |
5554+
Total amount of time spent inside 'free memory' tasks of the in-memory
5555+
cache subsystem. 'free memory' tasks are scheduled by the cache subsystem
5556+
to free up memory in existing cache hash tables.
5557+
5558+
- name: rocksdb_cache_free_memory_tasks_total
5559+
introducedIn: "3.10.11"
5560+
help: |
5561+
Total number of 'free memory' tasks scheduled by the in-memory
5562+
cache subsystem.
5563+
unit: number
5564+
type: counter
5565+
category: Statistics
5566+
complexity: advanced
5567+
exposedBy:
5568+
- dbserver
5569+
- agent
5570+
- single
5571+
description: |
5572+
Total number of 'free memory' tasks that were scheduled by the
5573+
in-memory edge cache subsystem. This metric will be increased
5574+
whenever the cache subsystem schedules a task to free up memory
5575+
in one of the managed in-memory caches. It is expected to see
5576+
this metric rising when the cache subsystem hits its global
5577+
memory budget.
5578+
55405579
- name: rocksdb_cache_full_index_refills_total
55415580
introducedIn: "3.10.2"
55425581
help: |
@@ -5616,6 +5655,43 @@
56165655
edge cache counts towards this allocation. This global limit can
56175656
be controlled with the `--cache.size` startup option.
56185657
5658+
- name: rocksdb_cache_migrate_tasks_duration_total
5659+
introducedIn: "3.10.11"
5660+
help: |
5661+
Total amount of time spent in 'migrate' tasks of the in-memory
5662+
cache subsystem.
5663+
unit: us
5664+
type: counter
5665+
category: Statistics
5666+
complexity: advanced
5667+
exposedBy:
5668+
- dbserver
5669+
- agent
5670+
- single
5671+
description: |
5672+
Total amount of time spent inside 'migrate' tasks of the in-memory
5673+
cache subsystem. 'migrate' tasks are scheduled by the cache subsystem
5674+
to migrate existing cache hash tables to a bigger or smaller table.
5675+
5676+
- name: rocksdb_cache_migrate_tasks_total
5677+
introducedIn: "3.10.11"
5678+
help: |
5679+
Total number of 'migrate' tasks scheduled by the in-memory
5680+
cache subsystem.
5681+
unit: number
5682+
type: counter
5683+
category: Statistics
5684+
complexity: advanced
5685+
exposedBy:
5686+
- dbserver
5687+
- agent
5688+
- single
5689+
description: |
5690+
Total number of 'migrate' tasks that were scheduled by the
5691+
in-memory edge cache subsystem. This metric will be increased
5692+
whenever the cache subsystem schedules a task to migrate an
5693+
existing cache hash table to a bigger or smaller size.
5694+
56195695
- name: rocksdb_cache_peak_allocated
56205696
introducedIn: "3.10.7"
56215697
help: |

0 commit comments

Comments
 (0)