Add memory tracker params (#1866)

* add-memory-tracker-params * Update 4.storage-config.md * Update 4.storage-config.md * Update 3.graph-config.md * set memory_tracker_detail_log to false * Update docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md Co-authored-by: randomJoe211 <[email protected]> * Update docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md Co-authored-by: randomJoe211 <[email protected]> * Update docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md Co-authored-by: randomJoe211 <[email protected]> * Update 3.graph-config.md Co-authored-by: randomJoe211 <[email protected]>
vesoft-inc · Jan 11, 2023 · 8ae2e06 · 8ae2e06
1 parent 0581776
commit 8ae2e06
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 3 deletions.
diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md
@@ -132,18 +132,32 @@ For more information about audit log, see [Audit log](../2.log-management/audit-
 |`enable_experimental_feature`|`false`| Specifies the experimental feature. Optional values are `true` and `false`. For currently supported experimental features, see below.|
 |`enable_data_balance`|`true`|Whether to enable the [BALANCE DATA](../../8.service-tuning/load-balance.md) feature. Only works when `enable_experimental_feature` is `true`. |
 
+
 {{ ent.ent_begin }}
+
 ## Black box configurations
 
 !!! enterpriseonly
 
     The Nebula-BBox configurations are for the Enterprise Edition only.
 
-| Name                 | Predefined Value                    | Description                              |
+| Name                 | Predefined value                    | Description                              |
 | :------------------- | :------------------------ | :------------------------------------------ |
 |`ng_black_box_switch`    |`true`                     |Whether to enable the [Nebula-BBox](../../6.monitor-and-metrics/3.bbox/3.1.bbox.md) feature.|
 |`ng_black_box_home`      |`black_box`                     |The name of the directory to store Nebula-BBox file data.|
 |`ng_black_box_dump_period_seconds`    |`5`                     |The time interval for Nebula-BBox to collect metric data. Unit: Second.|
 |`ng_black_box_file_lifetime_seconds`    |`1800`                     |Storage time for Nebula-BBox files generated after collecting metric data. Unit: Second.|
 
-{{ ent.ent_end }}
+{{ ent.ent_end }}
+
+
+## memory tracker configurations
+
+| Name                 | Predefined value                   | Description                               |
+| :------------------- | :------------------------ | :------------------------------------------ |
+|`memory_tracker_limit_ratio`    |`0.8`  | The percentage of free memory. When the free memory is lower than this value, NebulaGraph stops accepting queries. <br/> Calculated as follows: <br/> `Free memory / (Total memory - Reserved memory)` <br/> **Note**: For clusters with a mixed-used environment, the value of `memory_tracker_limit_ratio` should be set to a **lower** value. For example, when Graphd is expected to occupy only 50% of memory, the value can be set to less than `0.5`.|
+|`memory_tracker_untracked_reserved_memory_mb`    |`50`| The reserved memory that is not tracked by the memory tracker. Unit: MB.|
+|`memory_tracker_detail_log`    |`false` | Whether to enable the memory tracker log. When the value is `true`, the memory tracker log is generated.|
+|`memory_tracker_detail_log_interval_ms`    |`60000`| The time interval for generating the memory tracker log. Unit: Millisecond. `memory_tracker_detail_log` is `true` when this parameter takes effect.|
+|`memory_purge_enabled`    |`true` |Whether to enable the memory purge feature. When the value is `true`, the memory purge feature is enabled.|
+|`memory_purge_interval_seconds`    |`10` |The time interval for the memory purge feature to purge memory. Unit: Second. This parameter only takes effect if `memory_purge_enabled` is set to true.|
diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md
@@ -172,6 +172,7 @@ Supported options of `rocksdb_db_options` and `rocksdb_column_family_options` ar
 For more information, see [RocksDB official documentation](https://rocksdb.org/).
 
 {{ ent.ent_begin }}
+
 ## Storage cache configurations
 
 !!! enterpriseonly
@@ -196,7 +197,7 @@ For more information, see [RocksDB official documentation](https://rocksdb.org/)
 
     The Nebula-BBox configurations are for the Enterprise Edition only.
 
-| Name                 | Predefined Value                    | Description                              |
+| Name                 | Predefined value                    | Description                              |
 | :------------------- | :------------------------ | :------------------------------------------ |
 |`ng_black_box_switch`    |`true`                     |Whether to enable the [Nebula-BBox](../../6.monitor-and-metrics/3.bbox/3.1.bbox.md) feature.|
 |`ng_black_box_home`      |`black_box`                     |The name of the directory to store Nebula-BBox file data.|
@@ -205,6 +206,17 @@ For more information, see [RocksDB official documentation](https://rocksdb.org/)
 
 {{ ent.ent_end }}
 
+## memory tracker configurations
+
+| Name                 | Predefined value                   | Description                               |
+| :------------------- | :------------------------ | :------------------------------------------ |
+|`memory_tracker_limit_ratio`    |`0.8`  | The percentage of free memory. When the free memory is lower than this value, NebulaGraph stops accepting queries. <br/> Calculated as follows: <br/> `Free memory / (Total memory - Reserved memory)` <br/> **Note**: For clusters with a mixed-used environment, the value of `memory_tracker_limit_ratio` should be set to a **lower** value. For example, when Graphd is expected to occupy only 50% of memory, the value can be set to less than `0.5`.|
+|`memory_tracker_untracked_reserved_memory_mb`    |`50`| The reserved memory that is not tracked by the memory tracker. Unit: MB.|
+|`memory_tracker_detail_log`    |`false` | Whether to enable the memory tracker log. When the value is `true`, the memory tracker log is generated.|
+|`memory_tracker_detail_log_interval_ms`    |`60000`| The time interval for generating the memory tracker log. Unit: Millisecond. `memory_tracker_detail_log` is `true` when this parameter takes effect.|
+|`memory_purge_enabled`    |`true` |Whether to enable the memory purge feature. When the value is `true`, the memory purge feature is enabled.|
+|`memory_purge_interval_seconds`    |`10` |The time interval for the memory purge feature to purge memory. Unit: Second. This parameter only takes effect if `memory_purge_enabled` is set to true.|
+
 ## For super-Large vertices
 
 When the query starting from each vertex gets an edge, truncate it directly to avoid too many neighboring edges on the super-large vertex, because a single query occupies too much hard disk and memory. Or you can truncate a certain number of edges specified in the `Max_edge_returned_per_vertex` parameter. Excess edges will not be returned. This parameter applies to all spaces.