byteayan commented on code in PR #535:
URL: https://github.com/apache/hugegraph-doc/pull/535#discussion_r4314822295
##########
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md:
##########
@@ -209,8 +210,8 @@ This file contains only `rocksdb` and Actuator exposure
settings.
| Key | Master distribution value | Code default | Meaning |
|-----|---------|--------------|---------|
-| `rocksdb.total_memory_size` | `32000000000` | `51539607552` | Memory budget
shared by all RocksDB instances on this node. When absent or `0`, the node uses
the JVM max heap instead. |
-| `rocksdb.write_buffer_size` | `32000000` | `33554432` | Memtable size in
bytes. When absent or `0`, the node uses `total_memory_size / 1000`. |
+| `rocksdb.total_memory_size` | `0` | Auto-sized, see Meaning | Memory budget
in bytes shared by all RocksDB instances on this node, split into the write
cache and the block cache by `write_buffer_ratio`. Both caches are off-heap, so
`-Xmx` does not limit them, and a fixed 1 GiB Raft log cache comes on top. When
absent or `0`, the node uses half of the memory left after the JVM max heap,
`MaxDirectMemorySize` (counted as the heap size when unset;
`bin/start-hugegraph-store.sh` sets it to the heap it picks unless `-j` sets
`-Xmx`, `-XX:MaxHeapSize` or the cap itself) and a 1.5 GiB reserve, clamped to
256 MiB to 32 GB. In a container the starting point is the cgroup memory limit
when one is set, including a limit set only on a parent cgroup the Store can
see; otherwise it is the host's memory. An `application-pd.yml` kept from an
earlier release still sets `32000000000`; set it to `0` to auto-size. A
positive value is used as given and must be plain bytes, at least `1048576` (1
MiB);
a smaller value or one such as `4GB` stops startup. |
Review Comment:
Added in a451d1da, EN and CN: if neither the JVM nor the cgroup files report
a usable memory size, the budget falls back to the JVM max heap, clamped to the
same 256 MiB to 32 GB (`RocksdbMemoryBudget.auto()`).
##########
content/en/docs/guides/hugegraph-docker-cluster.md:
##########
@@ -196,10 +196,13 @@ The following tables describe current master entrypoints
and Compose files, not
| `HG_STORE_GRPC_PORT` | No | `8500` | `grpc.port` |
| `HG_STORE_REST_PORT` | No | `8520` | `server.port` |
| `HG_STORE_DATA_PATH` | No | `/hugegraph-store/storage` | `app.data-path` |
+| `HG_STORE_ROCKSDB_TOTAL_MEMORY_SIZE` | No | None |
`rocksdb.total_memory_size`, in bytes |
{.td-table--wide}
> **Deprecated aliases**: `PD_ADDRESS` → `HG_STORE_PD_ADDRESS`, `GRPC_HOST` →
> `HG_STORE_GRPC_HOST`, `RAFT_ADDRESS` → `HG_STORE_RAFT_ADDRESS`.
+RocksDB caches live outside the Java heap. Leave
`HG_STORE_ROCKSDB_TOTAL_MEMORY_SIZE` unset to size them from the container
memory limit, or from the memory of the Docker host (the Docker Desktop VM)
when the container has no limit. The Compose files above set no limit, so each
Store sizes its budget from the whole host; set a memory limit on the Store
services, or set this variable to a plain number of bytes, when several Stores
share one host. See `rocksdb.total_memory_size` in the [HStore configuration
reference](/docs/quickstart/hugegraph/hugegraph-hstore/).
Review Comment:
Agreed, qualified in a451d1da, EN and CN. The paragraph now says a container
limit bounds only the RocksDB budget. The launcher still picks `-Xmx` from the
host's free memory, up to 2 GiB, and sets direct memory to the same size. It
tells operators to size both through `JAVA_OPTS` (passed to the launcher as
`-j`), for example `JAVA_OPTS="-Xmx1g -XX:MaxDirectMemorySize=512m"` for a 4
GiB limit, and notes that the defaults already exceed a 2 GiB limit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
