Skip to content

Commit 64d1a8d

Browse files
authored
Add known issue: Partitioning RocksDB files for documents can create many small files (#852)
* Add known issue: Partitioning RocksDB files for documents can create many small files * Update version info and add remark to incompatible changes
1 parent 34d0a76 commit 64d1a8d

File tree

4 files changed

+30
-2
lines changed

4 files changed

+30
-2
lines changed

site/content/arangodb/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -920,8 +920,21 @@ RocksDB-related startup options have been changed:
920920

921921
- `--rocksdb.pending-compactions-slowdown-trigger` has been changed from 128 KiB to 1 GiB.
922922
- `--rocksdb.pending-compactions-stop-trigger` has been changed from 16 GiB to 32 GiB.
923-
- `--rocksdb.partition-files-for-documents` has been changed from false to true.
924923
- `--rocksdb.throttle-slow-down-writes-trigger` has been obsoleted.
924+
- `--rocksdb.partition-files-for-documents` has been changed from false to true.
925+
926+
{{< warning >}}
927+
If the `--rocksdb.partition-files-for-documents` startup option is enabled, it
928+
causes RocksDB to use separate `.sst` files for every collection/shard to store
929+
document data. This can create a very large number of files and use the same
930+
amount of file descriptors for deployments with many collections/shards and a
931+
high write load.
932+
933+
It is recommended to disable the feature explicitly with
934+
`--rocksdb.partition-files-for-documents false` in versions from 3.12.6 through
935+
3.12.7 where it is enabled by default. From 3.12.7-1 and 3.12.8 onward, it is
936+
again disabled by default.
937+
{{< /warning >}}
925938

926939
## Optional elevation for GeoJSON Points
927940

site/content/arangodb/3.12/release-notes/version-3.12/known-issues-in-3-12.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,4 @@ Note that this page does not list all open issues.
5252
| **Date Added:** 2025-01-30 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If the invariant is violated that ArangoDB's data is not modified while a server is down, manually as well as automatically triggered operations such as moving shards can make a DB-Server the leader (again) even though it may not have the correct data. ArangoDB does currently not protect against certain cases like bringing a DB-Server back without data (by accident or on purpose), which can lead to this empty state getting replicated across the cluster and thus causing data loss. <br> **Affected Versions:** 3.11.x, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
5353
| **Date Added:** 2025-06-25 <br> **Component:** Web interface <br> **Deployment Mode:** All <br> **Description:** Specifying an `X-Script-Name` HTTP header in requests to the web interface (`/_admin/aardvark`) to add a path prefix is non-functional. The feature was originally added in version 3.0 for basic proxy setups but doesn't adequately handle the requests of certain internal services. <br> **Affected Versions:** 3.11.x, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
5454
| **Date Added:** 2025-12-09 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** When rapidly changing the `replicationFactor` of a collection, the server may unexpectedly reply a `Precondition Failed` error with code `412`. <br> **Affected Versions:** 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** [BTS-2279](https://arangodb.atlassian.net/browse/BTS-2279) (internal) |
55+
| **Date Added:** 2025-12-11 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** The storage engine-related `--rocksdb.partition-files-for-documents` startup option has a default of `true` since v3.12.6, causing RocksDB to use separate `.sst` files for every collection/shard to store document data. This can create a very large number of files and use the same amount of file descriptors for deployments with many collections/shards and a high write load. It is recommended to disable the feature with `--rocksdb.partition-files-for-documents false` in versions where it is enabled by default. <br> **Affected Versions:** 3.12.6 - 3.12.7 <br> **Fixed in Versions:** 3.12.7-1, 3.12.8 <br> **Reference:** [arangodb/arangodb#22181](https://github.com/arangodb/arangodb/pull/22181) |

site/content/arangodb/4.0/release-notes/version-3.12/incompatible-changes-in-3-12.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -920,8 +920,21 @@ RocksDB-related startup options have been changed:
920920

921921
- `--rocksdb.pending-compactions-slowdown-trigger` has been changed from 128 KiB to 1 GiB.
922922
- `--rocksdb.pending-compactions-stop-trigger` has been changed from 16 GiB to 32 GiB.
923-
- `--rocksdb.partition-files-for-documents` has been changed from false to true.
924923
- `--rocksdb.throttle-slow-down-writes-trigger` has been obsoleted.
924+
- `--rocksdb.partition-files-for-documents` has been changed from false to true.
925+
926+
{{< warning >}}
927+
If the `--rocksdb.partition-files-for-documents` startup option is enabled, it
928+
causes RocksDB to use separate `.sst` files for every collection/shard to store
929+
document data. This can create a very large number of files and use the same
930+
amount of file descriptors for deployments with many collections/shards and a
931+
high write load.
932+
933+
It is recommended to disable the feature explicitly with
934+
`--rocksdb.partition-files-for-documents false` in versions from 3.12.6 through
935+
3.12.7 where it is enabled by default. From 3.12.7-1 and 3.12.8 onward, it is
936+
again disabled by default.
937+
{{< /warning >}}
925938

926939
## Optional elevation for GeoJSON Points
927940

site/content/arangodb/4.0/release-notes/version-3.12/known-issues-in-3-12.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,4 @@ Note that this page does not list all open issues.
5252
| **Date Added:** 2025-01-30 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If the invariant is violated that ArangoDB's data is not modified while a server is down, manually as well as automatically triggered operations such as moving shards can make a DB-Server the leader (again) even though it may not have the correct data. ArangoDB does currently not protect against certain cases like bringing a DB-Server back without data (by accident or on purpose), which can lead to this empty state getting replicated across the cluster and thus causing data loss. <br> **Affected Versions:** 3.11.x, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
5353
| **Date Added:** 2025-06-25 <br> **Component:** Web interface <br> **Deployment Mode:** All <br> **Description:** Specifying an `X-Script-Name` HTTP header in requests to the web interface (`/_admin/aardvark`) to add a path prefix is non-functional. The feature was originally added in version 3.0 for basic proxy setups but doesn't adequately handle the requests of certain internal services. <br> **Affected Versions:** 3.11.x, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
5454
| **Date Added:** 2025-12-09 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** When rapidly changing the `replicationFactor` of a collection, the server may unexpectedly reply a `Precondition Failed` error with code `412`. <br> **Affected Versions:** 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** [BTS-2279](https://arangodb.atlassian.net/browse/BTS-2279) (internal) |
55+
| **Date Added:** 2025-12-11 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** The storage engine-related `--rocksdb.partition-files-for-documents` startup option has a default of `true` since v3.12.6, causing RocksDB to use separate `.sst` files for every collection/shard to store document data. This can create a very large number of files and use the same amount of file descriptors for deployments with many collections/shards and a high write load. It is recommended to disable the feature with `--rocksdb.partition-files-for-documents false` in versions where it is enabled by default. <br> **Affected Versions:** 3.12.6 - 3.12.7 <br> **Fixed in Versions:** 3.12.7-1, 3.12.8 <br> **Reference:** [arangodb/arangodb#22181](https://github.com/arangodb/arangodb/pull/22181) |

0 commit comments

Comments
 (0)