This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 3c2c65bb doc: add JVM(in-heap) memory monitor config desc (#376)
3c2c65bb is described below
commit 3c2c65bb2efdaabcf1f95a8b7e188f5d5bb6bd0e
Author: imbajin <[email protected]>
AuthorDate: Fri Nov 1 08:27:37 2024 +0000
doc: add JVM(in-heap) memory monitor config desc (#376)
Related PR: https://github.com/apache/hugegraph/pull/2650
b7d454783ed4946f7426362d8da4360332f9fa05
---
cn/docs/_print/index.html | 52 +++++++++++++++++++++++++---
cn/docs/config/_print/index.html | 52 +++++++++++++++++++++++++---
cn/docs/config/config-guide/index.html | 56 ++++++++++++++++++++++++++----
cn/docs/config/config-option/index.html | 6 ++--
cn/docs/config/index.xml | 60 +++++++++++++++++++++++++++++++--
cn/docs/index.xml | 60 +++++++++++++++++++++++++++++++--
cn/sitemap.xml | 2 +-
docs/_print/index.html | 52 +++++++++++++++++++++++++---
docs/config/_print/index.html | 52 +++++++++++++++++++++++++---
docs/config/config-guide/index.html | 56 ++++++++++++++++++++++++++----
docs/config/config-option/index.html | 6 ++--
docs/config/index.xml | 60 +++++++++++++++++++++++++++++++--
docs/index.xml | 60 +++++++++++++++++++++++++++++++--
en/sitemap.xml | 2 +-
sitemap.xml | 2 +-
15 files changed, 529 insertions(+), 49 deletions(-)
diff --git a/cn/docs/_print/index.html b/cn/docs/_print/index.html
index d8e3e127..803a3ba6 100644
--- a/cn/docs/_print/index.html
+++ b/cn/docs/_print/index.html
@@ -1733,19 +1733,63 @@ HugeGraph Toolchain
版本:toolchain-1.0.0</p></blockquote><p><code>spark-load
推荐使用 HTTP 的通信方式,HugeGraph 的外围组件都是基于 HTTP 实现的;</li></ul><p>默认 GremlinServer
是服务在 localhost:8182,如果需要修改,配置 host、port 即可</p><ul><li>host:部署 GremlinServer
机器的机器名或 IP,目前 HugeGraphServer 不支持分布式部署,且 GremlinServer
不直接暴露给用户;</li><li>port:部署 GremlinServer 机器的端口;</li></ul><p>同时需要在
rest-server.properties 中增加对应的配置项 gremlinserver.url=http://host:port</p><h3
id=3-rest-serverproperties>3
rest-server.properties</h3><p>rest-server.properties 文件的默认内容如下:</p><div
class=highlight><pre tabindex=0 style=backgro [...]
</span></span><span style=display:flex><span># could use '0.0.0.0' or
specified (real)IP to expose external network access
</span></span><span
style=display:flex><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style=display:flex><span>#restserver.enable_graphspaces_filter=false
</span></span><span style=display:flex><span># gremlin server url, need to be
consistent with host and port in gremlin-server.yaml
</span></span><span
style=display:flex><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># graphs list with pair
NAME:CONF_PATH
-</span></span><span
style=display:flex><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span style=display:flex><span>graphs=./conf/graphs
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># authentication
+</span></span><span style=display:flex><span># The maximum thread ratio for
batch writing, only take effect if the batch.max_write_threads is 0
+</span></span><span style=display:flex><span>batch.max_write_ratio=80
+</span></span><span style=display:flex><span>batch.max_write_threads=0
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># configuration of arthas
+</span></span><span style=display:flex><span>arthas.telnet_port=8562
+</span></span><span style=display:flex><span>arthas.http_port=8561
+</span></span><span style=display:flex><span>arthas.ip=127.0.0.1
+</span></span><span style=display:flex><span>arthas.disabled_commands=jad
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># authentication configs
+</span></span><span style=display:flex><span># choose
'org.apache.hugegraph.auth.StandardAuthenticator' or
+</span></span><span style=display:flex><span>#
'org.apache.hugegraph.auth.ConfigAuthenticator'
</span></span><span style=display:flex><span>#auth.authenticator=
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for StandardAuthenticator mode
+</span></span><span style=display:flex><span>#auth.graph_store=hugegraph
+</span></span><span style=display:flex><span># auth client config
+</span></span><span
style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for ConfigAuthenticator mode
</span></span><span style=display:flex><span>#auth.admin_token=
</span></span><span style=display:flex><span>#auth.user_tokens=[]
</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># TODO: Deprecated & removed
later (useless from version 1.5.0)
+</span></span><span style=display:flex><span># rpc server configs for multi
graph-servers or raft-servers
+</span></span><span style=display:flex><span>#rpc.server_host=127.0.0.1
+</span></span><span style=display:flex><span>#rpc.server_port=8091
+</span></span><span style=display:flex><span>#rpc.server_timeout=30
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># rpc client configs (like enable
to keep cache consistency)
+</span></span><span
style=display:flex><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>#rpc.client_connect_timeout=20
+</span></span><span style=display:flex><span>#rpc.client_reconnect_period=10
+</span></span><span style=display:flex><span>#rpc.client_read_timeout=40
+</span></span><span style=display:flex><span>#rpc.client_retries=3
+</span></span><span
style=display:flex><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># raft group initial peers
+</span></span><span
style=display:flex><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># lightweight load balancing
(beta)
</span></span><span style=display:flex><span>server.id=server-1
</span></span><span style=display:flex><span>server.role=master
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># slow query log
+</span></span><span style=display:flex><span>log.slow_query_threshold=1000
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># jvm(in-heap) memory usage
monitor, set 1 to disable it
+</span></span><span style=display:flex><span>memory_monitor.threshold=0.85
+</span></span><span style=display:flex><span>memory_monitor.period=2000
</span></span></code></pre></div><ul><li>restserver.url:RestServer 提供服务的
url,根据实际环境修改。如果其他 IP 地址无法访问,可以尝试修改为特定的地址;或修改为 <code>http://0.0.0.0</code>
来监听来自任何 IP 地址的请求,这种方案较为便捷,但需要留意服务可被访问的网络范围;</li><li>graphs:RestServer
启动时也需要打开图,该项为 map 结构,key 是图的名字,value
是该图的配置文件路径;</li></ul><blockquote><p>注意:gremlin-server.yaml 和
rest-server.properties 都包含 graphs 配置项,而 <code>init-store</code> 命令是根据
gremlin-server.yaml 的 graphs 下的图进行初始化的。</p></blockquote><blockquote><p>配置项
gremlinserver.url 是 GremlinServe [...]
</span></span><span
style=display:flex><span>gremlin.graph=org.apache.hugegraph.HugeFactory
</span></span><span style=display:flex><span>
@@ -1878,7 +1922,7 @@ HugeGraph Toolchain
版本:toolchain-1.0.0</p></blockquote><p><code>spark-load
</span></span></code></pre></div><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-bash data-lang=bash><span style=display:flex><span>curl
http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#ce5c00;font-weight:700>{</span><span
style=color:#4e9a06>"name"</span>:<span
style=color:#4e9a06>"hugegraph_rocksdb"</span>,<span
style=color:#4e9a06>"backend"</span>:<span
style=color:#4e9a06>"rocksdb"</span><span
style=color:#ce5c00;font-weight:700>}</span>
-</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>4.2 -
HugeGraph 配置项</h1><h3 id=gremlin-server-配置项>Gremlin Server
配置项</h3><p>对应配置文件<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td></tr><tr><td>port</td><td>8182</td><td>The
listening port of [...]
+</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>4.2 -
HugeGraph 配置项</h1><h3 id=gremlin-server-配置项>Gremlin Server
配置项</h3><p>对应配置文件<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td></tr><tr><td>port</td><td>8182</td><td>The
listening port of [...]
以及细粒度的权限访问控制,采用基于“用户 - 用户组 - 操作 - 资源”的 4 层设计,灵活控制用户角色与权限 (支持多
GraphServer)</p><p><code>StandardAuthenticator</code>
模式的几个核心设计:</p><ul><li>初始化时创建超级管理员 (<code>admin</code>)
用户,后续通过超级管理员创建其它用户,新创建的用户被分配足够权限后,可以创建或管理更多的用户</li><li>支持动态创建用户、用户组、资源,支持动态分配或取消权限</li><li>用户可以属于一个或多个用户组,每个用户组可以拥有对任意个资源的操作权限,操作类型包括:读、写、删除、执行等种类</li><li>“资源”
描述了图数据库中的数据,比如符合某一类条件的顶点,每一个资源包括
<code>type</code>、<code>label</code>、<code>properties</code>三个要素,共有 18 种类型、任意
label、任意 properties 可组合形成的资源,
一个资源的内部条件 [...]
</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic></span><span
style=color:#000>user</span><span
style=color:#ce5c00;font-weight:700>(</span><span
style=color:#000>name</span><span
style=color:#ce5c00;font-weight:700>=</span><span
style=color:#000>xx</span><span style=color:#ce5c00;font-weight:700>)</span>
<span style=color:#ce5c00;font-weight:700>-</span><span
style=color:#000>belong</span><span
style=color:#ce5c00;font-weight:700>-></spa [...]
</span></span></code></pre></div><h3 id=配置用户认证>配置用户认证</h3><p>HugeGraph
目前默认<strong>未启用</strong>用户认证功能,需通过修改配置文件来启用该功能。(Note: 如果在生产环境/外网使用,
diff --git a/cn/docs/config/_print/index.html b/cn/docs/config/_print/index.html
index f633fd58..87df9ea4 100644
--- a/cn/docs/config/_print/index.html
+++ b/cn/docs/config/_print/index.html
@@ -115,19 +115,63 @@
推荐使用 HTTP 的通信方式,HugeGraph 的外围组件都是基于 HTTP 实现的;</li></ul><p>默认 GremlinServer
是服务在 localhost:8182,如果需要修改,配置 host、port 即可</p><ul><li>host:部署 GremlinServer
机器的机器名或 IP,目前 HugeGraphServer 不支持分布式部署,且 GremlinServer
不直接暴露给用户;</li><li>port:部署 GremlinServer 机器的端口;</li></ul><p>同时需要在
rest-server.properties 中增加对应的配置项 gremlinserver.url=http://host:port</p><h3
id=3-rest-serverproperties>3
rest-server.properties</h3><p>rest-server.properties 文件的默认内容如下:</p><div
class=highlight><pre tabindex=0 style=backgro [...]
</span></span><span style=display:flex><span># could use '0.0.0.0' or
specified (real)IP to expose external network access
</span></span><span
style=display:flex><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style=display:flex><span>#restserver.enable_graphspaces_filter=false
</span></span><span style=display:flex><span># gremlin server url, need to be
consistent with host and port in gremlin-server.yaml
</span></span><span
style=display:flex><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># graphs list with pair
NAME:CONF_PATH
-</span></span><span
style=display:flex><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span style=display:flex><span>graphs=./conf/graphs
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># authentication
+</span></span><span style=display:flex><span># The maximum thread ratio for
batch writing, only take effect if the batch.max_write_threads is 0
+</span></span><span style=display:flex><span>batch.max_write_ratio=80
+</span></span><span style=display:flex><span>batch.max_write_threads=0
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># configuration of arthas
+</span></span><span style=display:flex><span>arthas.telnet_port=8562
+</span></span><span style=display:flex><span>arthas.http_port=8561
+</span></span><span style=display:flex><span>arthas.ip=127.0.0.1
+</span></span><span style=display:flex><span>arthas.disabled_commands=jad
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># authentication configs
+</span></span><span style=display:flex><span># choose
'org.apache.hugegraph.auth.StandardAuthenticator' or
+</span></span><span style=display:flex><span>#
'org.apache.hugegraph.auth.ConfigAuthenticator'
</span></span><span style=display:flex><span>#auth.authenticator=
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for StandardAuthenticator mode
+</span></span><span style=display:flex><span>#auth.graph_store=hugegraph
+</span></span><span style=display:flex><span># auth client config
+</span></span><span
style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for ConfigAuthenticator mode
</span></span><span style=display:flex><span>#auth.admin_token=
</span></span><span style=display:flex><span>#auth.user_tokens=[]
</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># TODO: Deprecated & removed
later (useless from version 1.5.0)
+</span></span><span style=display:flex><span># rpc server configs for multi
graph-servers or raft-servers
+</span></span><span style=display:flex><span>#rpc.server_host=127.0.0.1
+</span></span><span style=display:flex><span>#rpc.server_port=8091
+</span></span><span style=display:flex><span>#rpc.server_timeout=30
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># rpc client configs (like enable
to keep cache consistency)
+</span></span><span
style=display:flex><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>#rpc.client_connect_timeout=20
+</span></span><span style=display:flex><span>#rpc.client_reconnect_period=10
+</span></span><span style=display:flex><span>#rpc.client_read_timeout=40
+</span></span><span style=display:flex><span>#rpc.client_retries=3
+</span></span><span
style=display:flex><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># raft group initial peers
+</span></span><span
style=display:flex><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># lightweight load balancing
(beta)
</span></span><span style=display:flex><span>server.id=server-1
</span></span><span style=display:flex><span>server.role=master
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># slow query log
+</span></span><span style=display:flex><span>log.slow_query_threshold=1000
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># jvm(in-heap) memory usage
monitor, set 1 to disable it
+</span></span><span style=display:flex><span>memory_monitor.threshold=0.85
+</span></span><span style=display:flex><span>memory_monitor.period=2000
</span></span></code></pre></div><ul><li>restserver.url:RestServer 提供服务的
url,根据实际环境修改。如果其他 IP 地址无法访问,可以尝试修改为特定的地址;或修改为 <code>http://0.0.0.0</code>
来监听来自任何 IP 地址的请求,这种方案较为便捷,但需要留意服务可被访问的网络范围;</li><li>graphs:RestServer
启动时也需要打开图,该项为 map 结构,key 是图的名字,value
是该图的配置文件路径;</li></ul><blockquote><p>注意:gremlin-server.yaml 和
rest-server.properties 都包含 graphs 配置项,而 <code>init-store</code> 命令是根据
gremlin-server.yaml 的 graphs 下的图进行初始化的。</p></blockquote><blockquote><p>配置项
gremlinserver.url 是 GremlinServe [...]
</span></span><span
style=display:flex><span>gremlin.graph=org.apache.hugegraph.HugeFactory
</span></span><span style=display:flex><span>
@@ -260,7 +304,7 @@
</span></span></code></pre></div><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-bash data-lang=bash><span style=display:flex><span>curl
http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#ce5c00;font-weight:700>{</span><span
style=color:#4e9a06>"name"</span>:<span
style=color:#4e9a06>"hugegraph_rocksdb"</span>,<span
style=color:#4e9a06>"backend"</span>:<span
style=color:#4e9a06>"rocksdb"</span><span
style=color:#ce5c00;font-weight:700>}</span>
-</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>2 -
HugeGraph 配置项</h1><h3 id=gremlin-server-配置项>Gremlin Server
配置项</h3><p>对应配置文件<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td></tr><tr><td>port</td><td>8182</td><td>The
listening port of G [...]
+</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>2 -
HugeGraph 配置项</h1><h3 id=gremlin-server-配置项>Gremlin Server
配置项</h3><p>对应配置文件<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td></tr><tr><td>port</td><td>8182</td><td>The
listening port of G [...]
以及细粒度的权限访问控制,采用基于“用户 - 用户组 - 操作 - 资源”的 4 层设计,灵活控制用户角色与权限 (支持多
GraphServer)</p><p><code>StandardAuthenticator</code>
模式的几个核心设计:</p><ul><li>初始化时创建超级管理员 (<code>admin</code>)
用户,后续通过超级管理员创建其它用户,新创建的用户被分配足够权限后,可以创建或管理更多的用户</li><li>支持动态创建用户、用户组、资源,支持动态分配或取消权限</li><li>用户可以属于一个或多个用户组,每个用户组可以拥有对任意个资源的操作权限,操作类型包括:读、写、删除、执行等种类</li><li>“资源”
描述了图数据库中的数据,比如符合某一类条件的顶点,每一个资源包括
<code>type</code>、<code>label</code>、<code>properties</code>三个要素,共有 18 种类型、任意
label、任意 properties 可组合形成的资源,
一个资源的内部条件 [...]
</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic></span><span
style=color:#000>user</span><span
style=color:#ce5c00;font-weight:700>(</span><span
style=color:#000>name</span><span
style=color:#ce5c00;font-weight:700>=</span><span
style=color:#000>xx</span><span style=color:#ce5c00;font-weight:700>)</span>
<span style=color:#ce5c00;font-weight:700>-</span><span
style=color:#000>belong</span><span
style=color:#ce5c00;font-weight:700>-></spa [...]
</span></span></code></pre></div><h3 id=配置用户认证>配置用户认证</h3><p>HugeGraph
目前默认<strong>未启用</strong>用户认证功能,需通过修改配置文件来启用该功能。(Note: 如果在生产环境/外网使用,
diff --git a/cn/docs/config/config-guide/index.html
b/cn/docs/config/config-guide/index.html
index a18d4083..934200b9 100644
--- a/cn/docs/config/config-guide/index.html
+++ b/cn/docs/config/config-guide/index.html
@@ -6,12 +6,12 @@ HugeGraphServer …"><meta property="og:title"
content="HugeGraph 配置"><meta
HugeGraphServer 内部集成了 GremlinServer 和 RestServer,而 gremlin-server.yaml 和
rest-server.properties 就是用来配置这两个 Server 的。
GremlinServer:GremlinServer 接受用户的 gremlin 语句,解析后转而调用 Core 的代码。 RestServer:提供
RESTful API,根据不同的 HTTP 请求,调用对应的 Core API,如果用户请求体是 gremlin 语句,则会转发给
GremlinServer,实现对图数据的操作。 下面对这三个配置文件逐一介绍。
2 gremlin-server.yaml gremlin-server.yaml 文件默认的内容如下:
-# host and port of gremlin server, need to be consistent with host and port in
rest-server.properties #host: 127.0.0.1 #port: 8182 # Gremlin 查询中的超时时间(以毫秒为单位)
evaluationTimeout: 30000 channelizer:
org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer #
不要在此处设置图形,此功能将在支持动态添加图形后再进行处理 graphs: { } scriptEngines: { gremlin-groovy: {
staticImports: [ org."><meta property="og:type" content="article"><meta
property="og:url" content="/cn/docs/config/config-guide/"><meta
property="articl [...]
+# host and port of gremlin server, need to be consistent with host and port in
rest-server.properties #host: 127.0.0.1 #port: 8182 # Gremlin 查询中的超时时间(以毫秒为单位)
evaluationTimeout: 30000 channelizer:
org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer #
不要在此处设置图形,此功能将在支持动态添加图形后再进行处理 graphs: { } scriptEngines: { gremlin-groovy: {
staticImports: [ org."><meta property="og:type" content="article"><meta
property="og:url" content="/cn/docs/config/config-guide/"><meta
property="articl [...]
主要的配置文件包括:gremlin-server.yaml、rest-server.properties 和 hugegraph.properties
HugeGraphServer 内部集成了 GremlinServer 和 RestServer,而 gremlin-server.yaml 和
rest-server.properties 就是用来配置这两个 Server 的。
GremlinServer:GremlinServer 接受用户的 gremlin 语句,解析后转而调用 Core 的代码。 RestServer:提供
RESTful API,根据不同的 HTTP 请求,调用对应的 Core API,如果用户请求体是 gremlin 语句,则会转发给
GremlinServer,实现对图数据的操作。 下面对这三个配置文件逐一介绍。
2 gremlin-server.yaml gremlin-server.yaml 文件默认的内容如下:
-# host and port of gremlin server, need to be consistent with host and port in
rest-server.properties #host: 127.0.0.1 #port: 8182 # Gremlin 查询中的超时时间(以毫秒为单位)
evaluationTimeout: 30000 channelizer:
org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer #
不要在此处设置图形,此功能将在支持动态添加图形后再进行处理 graphs: { } scriptEngines: { gremlin-groovy: {
staticImports: [ org."><meta itemprop=dateModified
content="2024-08-02T15:50:42+08:00"><meta itemprop=wordCount
content="753"><meta itemprop=keywords co [...]
+# host and port of gremlin server, need to be consistent with host and port in
rest-server.properties #host: 127.0.0.1 #port: 8182 # Gremlin 查询中的超时时间(以毫秒为单位)
evaluationTimeout: 30000 channelizer:
org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer #
不要在此处设置图形,此功能将在支持动态添加图形后再进行处理 graphs: { } scriptEngines: { gremlin-groovy: {
staticImports: [ org."><meta itemprop=dateModified
content="2024-11-01T16:27:00+08:00"><meta itemprop=wordCount
content="861"><meta itemprop=keywords co [...]
主要的配置文件包括:gremlin-server.yaml、rest-server.properties 和 hugegraph.properties
HugeGraphServer 内部集成了 GremlinServer 和 RestServer,而 gremlin-server.yaml 和
rest-server.properties 就是用来配置这两个 Server 的。
GremlinServer:GremlinServer 接受用户的 gremlin 语句,解析后转而调用 Core 的代码。 RestServer:提供
RESTful API,根据不同的 HTTP 请求,调用对应的 Core API,如果用户请求体是 gremlin 语句,则会转发给
GremlinServer,实现对图数据的操作。 下面对这三个配置文件逐一介绍。
@@ -137,19 +137,63 @@ GremlinServer:GremlinServer 接受用户的 gremlin 语句,解析后转而
推荐使用 HTTP 的通信方式,HugeGraph 的外围组件都是基于 HTTP 实现的;</li></ul><p>默认 GremlinServer
是服务在 localhost:8182,如果需要修改,配置 host、port 即可</p><ul><li>host:部署 GremlinServer
机器的机器名或 IP,目前 HugeGraphServer 不支持分布式部署,且 GremlinServer
不直接暴露给用户;</li><li>port:部署 GremlinServer 机器的端口;</li></ul><p>同时需要在
rest-server.properties 中增加对应的配置项 gremlinserver.url=http://host:port</p><h3
id=3-rest-serverproperties>3
rest-server.properties</h3><p>rest-server.properties 文件的默认内容如下:</p><div
class=highlight><pre tabindex=0 style=backgro [...]
</span></span><span style=display:flex><span># could use '0.0.0.0' or
specified (real)IP to expose external network access
</span></span><span
style=display:flex><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style=display:flex><span>#restserver.enable_graphspaces_filter=false
</span></span><span style=display:flex><span># gremlin server url, need to be
consistent with host and port in gremlin-server.yaml
</span></span><span
style=display:flex><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># graphs list with pair
NAME:CONF_PATH
-</span></span><span
style=display:flex><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span style=display:flex><span>graphs=./conf/graphs
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># authentication
+</span></span><span style=display:flex><span># The maximum thread ratio for
batch writing, only take effect if the batch.max_write_threads is 0
+</span></span><span style=display:flex><span>batch.max_write_ratio=80
+</span></span><span style=display:flex><span>batch.max_write_threads=0
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># configuration of arthas
+</span></span><span style=display:flex><span>arthas.telnet_port=8562
+</span></span><span style=display:flex><span>arthas.http_port=8561
+</span></span><span style=display:flex><span>arthas.ip=127.0.0.1
+</span></span><span style=display:flex><span>arthas.disabled_commands=jad
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># authentication configs
+</span></span><span style=display:flex><span># choose
'org.apache.hugegraph.auth.StandardAuthenticator' or
+</span></span><span style=display:flex><span>#
'org.apache.hugegraph.auth.ConfigAuthenticator'
</span></span><span style=display:flex><span>#auth.authenticator=
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for StandardAuthenticator mode
+</span></span><span style=display:flex><span>#auth.graph_store=hugegraph
+</span></span><span style=display:flex><span># auth client config
+</span></span><span
style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for ConfigAuthenticator mode
</span></span><span style=display:flex><span>#auth.admin_token=
</span></span><span style=display:flex><span>#auth.user_tokens=[]
</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># TODO: Deprecated & removed
later (useless from version 1.5.0)
+</span></span><span style=display:flex><span># rpc server configs for multi
graph-servers or raft-servers
+</span></span><span style=display:flex><span>#rpc.server_host=127.0.0.1
+</span></span><span style=display:flex><span>#rpc.server_port=8091
+</span></span><span style=display:flex><span>#rpc.server_timeout=30
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># rpc client configs (like enable
to keep cache consistency)
+</span></span><span
style=display:flex><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>#rpc.client_connect_timeout=20
+</span></span><span style=display:flex><span>#rpc.client_reconnect_period=10
+</span></span><span style=display:flex><span>#rpc.client_read_timeout=40
+</span></span><span style=display:flex><span>#rpc.client_retries=3
+</span></span><span
style=display:flex><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># raft group initial peers
+</span></span><span
style=display:flex><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># lightweight load balancing
(beta)
</span></span><span style=display:flex><span>server.id=server-1
</span></span><span style=display:flex><span>server.role=master
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># slow query log
+</span></span><span style=display:flex><span>log.slow_query_threshold=1000
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># jvm(in-heap) memory usage
monitor, set 1 to disable it
+</span></span><span style=display:flex><span>memory_monitor.threshold=0.85
+</span></span><span style=display:flex><span>memory_monitor.period=2000
</span></span></code></pre></div><ul><li>restserver.url:RestServer 提供服务的
url,根据实际环境修改。如果其他 IP 地址无法访问,可以尝试修改为特定的地址;或修改为 <code>http://0.0.0.0</code>
来监听来自任何 IP 地址的请求,这种方案较为便捷,但需要留意服务可被访问的网络范围;</li><li>graphs:RestServer
启动时也需要打开图,该项为 map 结构,key 是图的名字,value
是该图的配置文件路径;</li></ul><blockquote><p>注意:gremlin-server.yaml 和
rest-server.properties 都包含 graphs 配置项,而 <code>init-store</code> 命令是根据
gremlin-server.yaml 的 graphs 下的图进行初始化的。</p></blockquote><blockquote><p>配置项
gremlinserver.url 是 GremlinServe [...]
</span></span><span
style=display:flex><span>gremlin.graph=org.apache.hugegraph.HugeFactory
</span></span><span style=display:flex><span>
@@ -282,7 +326,7 @@ GremlinServer:GremlinServer 接受用户的 gremlin 语句,解析后转而
</span></span></code></pre></div><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-bash data-lang=bash><span style=display:flex><span>curl
http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#ce5c00;font-weight:700>{</span><span
style=color:#4e9a06>"name"</span>:<span
style=color:#4e9a06>"hugegraph_rocksdb"</span>,<span
style=color:#4e9a06>"backend"</span>:<span
style=color:#4e9a06>"rocksdb"</span><span
style=color:#ce5c00;font-weight:700>}</span>
-</span></span></code></pre></div><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const
yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--response-yes"),noResponse=document.querySelector(".feedback--response-no"),disableButtons=()=>{yesButt
[...]
+</span></span></code></pre></div><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const
yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--response-yes"),noResponse=document.querySelector(".feedback--response-no"),disableButtons=()=>{yesButt
[...]
<script
src=https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js
integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA=="
crossorigin=anonymous></script>
<script src=/js/tabpane-persist.js></script>
<script
src=/js/main.min.aa9f4c5dae6a98b2c46277f4c56f1673a2b000d1756ce4ffae93784cab25e6d5.js
integrity="sha256-qp9MXa5qmLLEYnf0xW8Wc6KwANF1bOT/rpN4TKsl5tU="
crossorigin=anonymous></script>
diff --git a/cn/docs/config/config-option/index.html
b/cn/docs/config/config-option/index.html
index 34bbadb8..b22bf3e4 100644
--- a/cn/docs/config/config-option/index.html
+++ b/cn/docs/config/config-option/index.html
@@ -16,15 +16,15 @@ The host or ip of Gremlin Server.
port …"><meta property="og:title" content="HugeGraph 配置项"><meta
property="og:description" content="Gremlin Server 配置项 对应配置文件gremlin-server.yaml
-config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
-config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
+config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
+config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
<link rel=stylesheet href=/css/prism.css><script
type=application/javascript>var
doNotTrack=!1;doNotTrack||(window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new
Date,ga("create","UA-00000000-0","auto"),ga("send","pageview"))</script><script
async src=https://www.google-analytics.com/analytics.js></script></head><body
class=td-page><header><nav class="js-navbar-scroll navbar navbar-expand
navbar-dark flex-column flex-md-row td-navbar"><a class=navbar-brand href=/cn/>
[...]
<a
href=https://github.com/apache/incubator-hugegraph-doc/edit/master/content/cn/docs/config/config-option.md
class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit
fa-fw"></i> Edit this page</a>
<a
href="https://github.com/apache/incubator-hugegraph-doc/new/master/content/cn/docs/config/config-option.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+
[...]
<a
href="https://github.com/apache/incubator-hugegraph-doc/issues/new?title=HugeGraph%20%e9%85%8d%e7%bd%ae%e9%a1%b9"
class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github
fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/apache/incubator-hugegraph/issues/new
class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas
fa-tasks fa-fw"></i> Create project issue</a>
-<a id=print href=/cn/docs/config/_print/><i class="fa fa-print fa-fw"></i>
Print entire section</a></div><div class=td-toc><nav
id=TableOfContents><ul><li><ul><li><a href=#gremlin-server-配置项>Gremlin Server
配置项</a></li><li><a href=#rest-server--api-配置项>Rest Server & API
配置项</a></li><li><a href=#基本配置项>基本配置项</a></li><li><a href=#rpc-server-配置>RPC
server 配置</a></li><li><a href=#cassandra-后端配置项>Cassandra 后端配置项</a></li><li><a
href=#scylladb-后端配置项>ScyllaDB 后端配置项</a></li><li><a href=#rocksdb-后端配 [...]
+<a id=print href=/cn/docs/config/_print/><i class="fa fa-print fa-fw"></i>
Print entire section</a></div><div class=td-toc><nav
id=TableOfContents><ul><li><ul><li><a href=#gremlin-server-配置项>Gremlin Server
配置项</a></li><li><a href=#rest-server--api-配置项>Rest Server & API
配置项</a></li><li><a href=#基本配置项>基本配置项</a></li><li><a href=#rpc-server-配置>RPC
server 配置</a></li><li><a href=#cassandra-后端配置项>Cassandra 后端配置项</a></li><li><a
href=#scylladb-后端配置项>ScyllaDB 后端配置项</a></li><li><a href=#rocksdb-后端配 [...]
<script
src=https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js
integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA=="
crossorigin=anonymous></script>
<script src=/js/tabpane-persist.js></script>
<script
src=/js/main.min.aa9f4c5dae6a98b2c46277f4c56f1673a2b000d1756ce4ffae93784cab25e6d5.js
integrity="sha256-qp9MXa5qmLLEYnf0xW8Wc6KwANF1bOT/rpN4TKsl5tU="
crossorigin=anonymous></script>
diff --git a/cn/docs/config/index.xml b/cn/docs/config/index.xml
index 4d5249ee..5cb499b2 100644
--- a/cn/docs/config/index.xml
+++ b/cn/docs/config/index.xml
@@ -138,19 +138,63 @@
<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-fallback" data-lang="fallback"><span
style="display:flex;"><span># bind url
</span></span><span style="display:flex;"><span># could use
&#39;0.0.0.0&#39; or specified (real)IP to expose external network
access
</span></span><span
style="display:flex;"><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style="display:flex;"><span>#restserver.enable_graphspaces_filter=false
</span></span><span style="display:flex;"><span># gremlin server
url, need to be consistent with host and port in gremlin-server.yaml
</span></span><span
style="display:flex;"><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># graphs list with
pair NAME:CONF_PATH
-</span></span><span
style="display:flex;"><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span
style="display:flex;"><span>graphs=./conf/graphs
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># authentication
+</span></span><span style="display:flex;"><span># The maximum
thread ratio for batch writing, only take effect if the batch.max_write_threads
is 0
+</span></span><span
style="display:flex;"><span>batch.max_write_ratio=80
+</span></span><span
style="display:flex;"><span>batch.max_write_threads=0
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># configuration of
arthas
+</span></span><span
style="display:flex;"><span>arthas.telnet_port=8562
+</span></span><span
style="display:flex;"><span>arthas.http_port=8561
+</span></span><span style="display:flex;"><span>arthas.ip=127.0.0.1
+</span></span><span
style="display:flex;"><span>arthas.disabled_commands=jad
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># authentication
configs
+</span></span><span style="display:flex;"><span># choose
&#39;org.apache.hugegraph.auth.StandardAuthenticator&#39; or
+</span></span><span style="display:flex;"><span>#
&#39;org.apache.hugegraph.auth.ConfigAuthenticator&#39;
</span></span><span
style="display:flex;"><span>#auth.authenticator=
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
StandardAuthenticator mode
+</span></span><span
style="display:flex;"><span>#auth.graph_store=hugegraph
+</span></span><span style="display:flex;"><span># auth client
config
+</span></span><span
style="display:flex;"><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
ConfigAuthenticator mode
</span></span><span style="display:flex;"><span>#auth.admin_token=
</span></span><span
style="display:flex;"><span>#auth.user_tokens=[]
</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># TODO: Deprecated
&amp; removed later (useless from version 1.5.0)
+</span></span><span style="display:flex;"><span># rpc server
configs for multi graph-servers or raft-servers
+</span></span><span
style="display:flex;"><span>#rpc.server_host=127.0.0.1
+</span></span><span
style="display:flex;"><span>#rpc.server_port=8091
+</span></span><span
style="display:flex;"><span>#rpc.server_timeout=30
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># rpc client
configs (like enable to keep cache consistency)
+</span></span><span
style="display:flex;"><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span
style="display:flex;"><span>#rpc.client_connect_timeout=20
+</span></span><span
style="display:flex;"><span>#rpc.client_reconnect_period=10
+</span></span><span
style="display:flex;"><span>#rpc.client_read_timeout=40
+</span></span><span
style="display:flex;"><span>#rpc.client_retries=3
+</span></span><span
style="display:flex;"><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># raft group
initial peers
+</span></span><span
style="display:flex;"><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># lightweight load
balancing (beta)
</span></span><span style="display:flex;"><span>server.id=server-1
</span></span><span style="display:flex;"><span>server.role=master
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># slow query log
+</span></span><span
style="display:flex;"><span>log.slow_query_threshold=1000
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># jvm(in-heap)
memory usage monitor, set 1 to disable it
+</span></span><span
style="display:flex;"><span>memory_monitor.threshold=0.85
+</span></span><span
style="display:flex;"><span>memory_monitor.period=2000
</span></span></code></pre></div><ul>
<li>restserver.url:RestServer 提供服务的 url,根据实际环境修改。如果其他 IP
地址无法访问,可以尝试修改为特定的地址;或修改为 <code>http://0.0.0.0</code> 来监听来自任何 IP
地址的请求,这种方案较为便捷,但需要留意服务可被访问的网络范围;</li>
<li>graphs:RestServer 启动时也需要打开图,该项为 map 结构,key 是图的名字,value
是该图的配置文件路径;</li>
@@ -518,6 +562,16 @@
<td>false</td>
<td>Whether to allow exception trace stack.</td>
</tr>
+<tr>
+<td>memory_monitor.threshold</td>
+<td>0.85</td>
+<td>The threshold of JVM(in-heap) memory usage monitoring , 1 means
disabling this function.</td>
+</tr>
+<tr>
+<td>memory_monitor.period</td>
+<td>2000</td>
+<td>The period in ms of JVM(in-heap) memory usage monitoring.</td>
+</tr>
</tbody>
</table>
<h3 id="基本配置项">基本配置项</h3>
diff --git a/cn/docs/index.xml b/cn/docs/index.xml
index c0a3a0e6..3909698b 100644
--- a/cn/docs/index.xml
+++ b/cn/docs/index.xml
@@ -1804,19 +1804,63 @@ HugeGraph 支持多用户并行操作,用户可输入 Gremlin 查询语句,
<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-fallback" data-lang="fallback"><span
style="display:flex;"><span># bind url
</span></span><span style="display:flex;"><span># could use
&#39;0.0.0.0&#39; or specified (real)IP to expose external network
access
</span></span><span
style="display:flex;"><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style="display:flex;"><span>#restserver.enable_graphspaces_filter=false
</span></span><span style="display:flex;"><span># gremlin server
url, need to be consistent with host and port in gremlin-server.yaml
</span></span><span
style="display:flex;"><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># graphs list with
pair NAME:CONF_PATH
-</span></span><span
style="display:flex;"><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span
style="display:flex;"><span>graphs=./conf/graphs
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># authentication
+</span></span><span style="display:flex;"><span># The maximum
thread ratio for batch writing, only take effect if the batch.max_write_threads
is 0
+</span></span><span
style="display:flex;"><span>batch.max_write_ratio=80
+</span></span><span
style="display:flex;"><span>batch.max_write_threads=0
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># configuration of
arthas
+</span></span><span
style="display:flex;"><span>arthas.telnet_port=8562
+</span></span><span
style="display:flex;"><span>arthas.http_port=8561
+</span></span><span style="display:flex;"><span>arthas.ip=127.0.0.1
+</span></span><span
style="display:flex;"><span>arthas.disabled_commands=jad
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># authentication
configs
+</span></span><span style="display:flex;"><span># choose
&#39;org.apache.hugegraph.auth.StandardAuthenticator&#39; or
+</span></span><span style="display:flex;"><span>#
&#39;org.apache.hugegraph.auth.ConfigAuthenticator&#39;
</span></span><span
style="display:flex;"><span>#auth.authenticator=
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
StandardAuthenticator mode
+</span></span><span
style="display:flex;"><span>#auth.graph_store=hugegraph
+</span></span><span style="display:flex;"><span># auth client
config
+</span></span><span
style="display:flex;"><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
ConfigAuthenticator mode
</span></span><span style="display:flex;"><span>#auth.admin_token=
</span></span><span
style="display:flex;"><span>#auth.user_tokens=[]
</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># TODO: Deprecated
&amp; removed later (useless from version 1.5.0)
+</span></span><span style="display:flex;"><span># rpc server
configs for multi graph-servers or raft-servers
+</span></span><span
style="display:flex;"><span>#rpc.server_host=127.0.0.1
+</span></span><span
style="display:flex;"><span>#rpc.server_port=8091
+</span></span><span
style="display:flex;"><span>#rpc.server_timeout=30
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># rpc client
configs (like enable to keep cache consistency)
+</span></span><span
style="display:flex;"><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span
style="display:flex;"><span>#rpc.client_connect_timeout=20
+</span></span><span
style="display:flex;"><span>#rpc.client_reconnect_period=10
+</span></span><span
style="display:flex;"><span>#rpc.client_read_timeout=40
+</span></span><span
style="display:flex;"><span>#rpc.client_retries=3
+</span></span><span
style="display:flex;"><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># raft group
initial peers
+</span></span><span
style="display:flex;"><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># lightweight load
balancing (beta)
</span></span><span style="display:flex;"><span>server.id=server-1
</span></span><span style="display:flex;"><span>server.role=master
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># slow query log
+</span></span><span
style="display:flex;"><span>log.slow_query_threshold=1000
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># jvm(in-heap)
memory usage monitor, set 1 to disable it
+</span></span><span
style="display:flex;"><span>memory_monitor.threshold=0.85
+</span></span><span
style="display:flex;"><span>memory_monitor.period=2000
</span></span></code></pre></div><ul>
<li>restserver.url:RestServer 提供服务的 url,根据实际环境修改。如果其他 IP
地址无法访问,可以尝试修改为特定的地址;或修改为 <code>http://0.0.0.0</code> 来监听来自任何 IP
地址的请求,这种方案较为便捷,但需要留意服务可被访问的网络范围;</li>
<li>graphs:RestServer 启动时也需要打开图,该项为 map 结构,key 是图的名字,value
是该图的配置文件路径;</li>
@@ -5684,6 +5728,16 @@ HugeGraph目前采用EdgeCut的分区方案。</p>
<td>false</td>
<td>Whether to allow exception trace stack.</td>
</tr>
+<tr>
+<td>memory_monitor.threshold</td>
+<td>0.85</td>
+<td>The threshold of JVM(in-heap) memory usage monitoring , 1 means
disabling this function.</td>
+</tr>
+<tr>
+<td>memory_monitor.period</td>
+<td>2000</td>
+<td>The period in ms of JVM(in-heap) memory usage monitoring.</td>
+</tr>
</tbody>
</table>
<h3 id="基本配置项">基本配置项</h3>
diff --git a/cn/sitemap.xml b/cn/sitemap.xml
index c0b8d9be..3e21ad35 100644
--- a/cn/sitemap.xml
+++ b/cn/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/cn/docs/language/hugegraph-gremlin/</loc><lastmod>2023-01-01T16:16:43+08:00</lastmod><xhtml:link
rel="alternate" hreflang="en"
href="/docs/language/hugegraph-gremlin/"/><xhtml:link rel="alternate"
hreflang="cn"
href="/cn/docs/language/hugegraph-gremlin/"/></url><url><loc>/cn/docs/performance/hugegraph-benchmark-0.5.6/</lo
[...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/cn/docs/language/hugegraph-gremlin/</loc><lastmod>2023-01-01T16:16:43+08:00</lastmod><xhtml:link
rel="alternate" hreflang="en"
href="/docs/language/hugegraph-gremlin/"/><xhtml:link rel="alternate"
hreflang="cn"
href="/cn/docs/language/hugegraph-gremlin/"/></url><url><loc>/cn/docs/performance/hugegraph-benchmark-0.5.6/</lo
[...]
\ No newline at end of file
diff --git a/docs/_print/index.html b/docs/_print/index.html
index 32eb1301..756c108d 100644
--- a/docs/_print/index.html
+++ b/docs/_print/index.html
@@ -1747,19 +1747,63 @@ Implement a class inherited from <code>Formatter</code>
in the directory, such a
</span></span></span></code></pre></div><p>There are many configuration
options mentioned above, but for now, let’s focus on the following
options: <code>channelizer</code> and
<code>graphs</code>.</p><ul><li><code>graphs</code>: This option specifies the
graphs that need to be opened when the GremlinServer starts. It is a map
structure where the key is the name of the graph and the value is the
configuration file path for that graph.</li><li><code>channelizer</code>: The
GremlinSe [...]
</span></span><span style=display:flex><span># could use '0.0.0.0' or
specified (real)IP to expose external network access
</span></span><span
style=display:flex><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style=display:flex><span>#restserver.enable_graphspaces_filter=false
</span></span><span style=display:flex><span># gremlin server url, need to be
consistent with host and port in gremlin-server.yaml
</span></span><span
style=display:flex><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># graphs list with pair
NAME:CONF_PATH
-</span></span><span
style=display:flex><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span style=display:flex><span>graphs=./conf/graphs
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># authentication
+</span></span><span style=display:flex><span># The maximum thread ratio for
batch writing, only take effect if the batch.max_write_threads is 0
+</span></span><span style=display:flex><span>batch.max_write_ratio=80
+</span></span><span style=display:flex><span>batch.max_write_threads=0
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># configuration of arthas
+</span></span><span style=display:flex><span>arthas.telnet_port=8562
+</span></span><span style=display:flex><span>arthas.http_port=8561
+</span></span><span style=display:flex><span>arthas.ip=127.0.0.1
+</span></span><span style=display:flex><span>arthas.disabled_commands=jad
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># authentication configs
+</span></span><span style=display:flex><span># choose
'org.apache.hugegraph.auth.StandardAuthenticator' or
+</span></span><span style=display:flex><span>#
'org.apache.hugegraph.auth.ConfigAuthenticator'
</span></span><span style=display:flex><span>#auth.authenticator=
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for StandardAuthenticator mode
+</span></span><span style=display:flex><span>#auth.graph_store=hugegraph
+</span></span><span style=display:flex><span># auth client config
+</span></span><span
style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for ConfigAuthenticator mode
</span></span><span style=display:flex><span>#auth.admin_token=
</span></span><span style=display:flex><span>#auth.user_tokens=[]
</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># TODO: Deprecated & removed
later (useless from version 1.5.0)
+</span></span><span style=display:flex><span># rpc server configs for multi
graph-servers or raft-servers
+</span></span><span style=display:flex><span>#rpc.server_host=127.0.0.1
+</span></span><span style=display:flex><span>#rpc.server_port=8091
+</span></span><span style=display:flex><span>#rpc.server_timeout=30
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># rpc client configs (like enable
to keep cache consistency)
+</span></span><span
style=display:flex><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>#rpc.client_connect_timeout=20
+</span></span><span style=display:flex><span>#rpc.client_reconnect_period=10
+</span></span><span style=display:flex><span>#rpc.client_read_timeout=40
+</span></span><span style=display:flex><span>#rpc.client_retries=3
+</span></span><span
style=display:flex><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># raft group initial peers
+</span></span><span
style=display:flex><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># lightweight load balancing
(beta)
</span></span><span style=display:flex><span>server.id=server-1
</span></span><span style=display:flex><span>server.role=master
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># slow query log
+</span></span><span style=display:flex><span>log.slow_query_threshold=1000
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># jvm(in-heap) memory usage
monitor, set 1 to disable it
+</span></span><span style=display:flex><span>memory_monitor.threshold=0.85
+</span></span><span style=display:flex><span>memory_monitor.period=2000
</span></span></code></pre></div><ul><li><code>restserver.url</code>: The URL
at which the RestServer provides its services. Modify it according to the
actual environment. If you can’t connet to server from other IP address,
try to modify it as specific IP; or modify it as <code>http://0.0.0.0</code> to
listen all network interfaces as a convenient solution, but need to take care
of the network area that might access.</li><li><code>graphs</code>: The
RestServer also needs to open g [...]
</span></span><span
style=display:flex><span>gremlin.graph=org.apache.hugegraph.HugeFactory
</span></span><span style=display:flex><span>
@@ -1892,7 +1936,7 @@ Implement a class inherited from <code>Formatter</code>
in the directory, such a
</span></span></code></pre></div><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-bash data-lang=bash><span style=display:flex><span>curl
http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#ce5c00;font-weight:700>{</span><span
style=color:#4e9a06>"name"</span>:<span
style=color:#4e9a06>"hugegraph_rocksdb"</span>,<span
style=color:#4e9a06>"backend"</span>:<span
style=color:#4e9a06>"rocksdb"</span><span
style=color:#ce5c00;font-weight:700>}</span>
-</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>4.2 -
HugeGraph Config Options</h1><h3 id=gremlin-server-config-options>Gremlin
Server Config Options</h3><p>Corresponding configuration file
<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td> [...]
+</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>4.2 -
HugeGraph Config Options</h1><h3 id=gremlin-server-config-options>Gremlin
Server Config Options</h3><p>Corresponding configuration file
<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td> [...]
which supports multi-user authentication and fine-grained access control. It
adopts a 4-layer design based on
“User-UserGroup-Operation-Resource” to
flexibly control user roles and permissions (supports multiple
GraphServers).</p><p>Some key designs of the <code>StandardAuthenticator</code>
mode include:</p><ul><li>During initialization, a super administrator
(<code>admin</code>) user is created. Subsequently, other users can be created
by the super administrator. Once newly created users are assigned sufficient
permissions, they can create or manage more users.</li><li>It supports dynamic
creation of users, user groups, and resource [...]
</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic></span><span
style=color:#000>user</span><span
style=color:#ce5c00;font-weight:700>(</span><span
style=color:#000>name</span><span
style=color:#ce5c00;font-weight:700>=</span><span
style=color:#000>xx</span><span style=color:#ce5c00;font-weight:700>)</span>
<span style=color:#ce5c00;font-weight:700>-</span><span
style=color:#000>belong</span><span
style=color:#ce5c00;font-weight:700>-></spa [...]
diff --git a/docs/config/_print/index.html b/docs/config/_print/index.html
index 1fd5eb30..64bd3c86 100644
--- a/docs/config/_print/index.html
+++ b/docs/config/_print/index.html
@@ -113,19 +113,63 @@
</span></span></span></code></pre></div><p>There are many configuration
options mentioned above, but for now, let’s focus on the following
options: <code>channelizer</code> and
<code>graphs</code>.</p><ul><li><code>graphs</code>: This option specifies the
graphs that need to be opened when the GremlinServer starts. It is a map
structure where the key is the name of the graph and the value is the
configuration file path for that graph.</li><li><code>channelizer</code>: The
GremlinSe [...]
</span></span><span style=display:flex><span># could use '0.0.0.0' or
specified (real)IP to expose external network access
</span></span><span
style=display:flex><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style=display:flex><span>#restserver.enable_graphspaces_filter=false
</span></span><span style=display:flex><span># gremlin server url, need to be
consistent with host and port in gremlin-server.yaml
</span></span><span
style=display:flex><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># graphs list with pair
NAME:CONF_PATH
-</span></span><span
style=display:flex><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span style=display:flex><span>graphs=./conf/graphs
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># authentication
+</span></span><span style=display:flex><span># The maximum thread ratio for
batch writing, only take effect if the batch.max_write_threads is 0
+</span></span><span style=display:flex><span>batch.max_write_ratio=80
+</span></span><span style=display:flex><span>batch.max_write_threads=0
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># configuration of arthas
+</span></span><span style=display:flex><span>arthas.telnet_port=8562
+</span></span><span style=display:flex><span>arthas.http_port=8561
+</span></span><span style=display:flex><span>arthas.ip=127.0.0.1
+</span></span><span style=display:flex><span>arthas.disabled_commands=jad
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># authentication configs
+</span></span><span style=display:flex><span># choose
'org.apache.hugegraph.auth.StandardAuthenticator' or
+</span></span><span style=display:flex><span>#
'org.apache.hugegraph.auth.ConfigAuthenticator'
</span></span><span style=display:flex><span>#auth.authenticator=
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for StandardAuthenticator mode
+</span></span><span style=display:flex><span>#auth.graph_store=hugegraph
+</span></span><span style=display:flex><span># auth client config
+</span></span><span
style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for ConfigAuthenticator mode
</span></span><span style=display:flex><span>#auth.admin_token=
</span></span><span style=display:flex><span>#auth.user_tokens=[]
</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># TODO: Deprecated & removed
later (useless from version 1.5.0)
+</span></span><span style=display:flex><span># rpc server configs for multi
graph-servers or raft-servers
+</span></span><span style=display:flex><span>#rpc.server_host=127.0.0.1
+</span></span><span style=display:flex><span>#rpc.server_port=8091
+</span></span><span style=display:flex><span>#rpc.server_timeout=30
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># rpc client configs (like enable
to keep cache consistency)
+</span></span><span
style=display:flex><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>#rpc.client_connect_timeout=20
+</span></span><span style=display:flex><span>#rpc.client_reconnect_period=10
+</span></span><span style=display:flex><span>#rpc.client_read_timeout=40
+</span></span><span style=display:flex><span>#rpc.client_retries=3
+</span></span><span
style=display:flex><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># raft group initial peers
+</span></span><span
style=display:flex><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># lightweight load balancing
(beta)
</span></span><span style=display:flex><span>server.id=server-1
</span></span><span style=display:flex><span>server.role=master
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># slow query log
+</span></span><span style=display:flex><span>log.slow_query_threshold=1000
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># jvm(in-heap) memory usage
monitor, set 1 to disable it
+</span></span><span style=display:flex><span>memory_monitor.threshold=0.85
+</span></span><span style=display:flex><span>memory_monitor.period=2000
</span></span></code></pre></div><ul><li><code>restserver.url</code>: The URL
at which the RestServer provides its services. Modify it according to the
actual environment. If you can’t connet to server from other IP address,
try to modify it as specific IP; or modify it as <code>http://0.0.0.0</code> to
listen all network interfaces as a convenient solution, but need to take care
of the network area that might access.</li><li><code>graphs</code>: The
RestServer also needs to open g [...]
</span></span><span
style=display:flex><span>gremlin.graph=org.apache.hugegraph.HugeFactory
</span></span><span style=display:flex><span>
@@ -258,7 +302,7 @@
</span></span></code></pre></div><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-bash data-lang=bash><span style=display:flex><span>curl
http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#ce5c00;font-weight:700>{</span><span
style=color:#4e9a06>"name"</span>:<span
style=color:#4e9a06>"hugegraph_rocksdb"</span>,<span
style=color:#4e9a06>"backend"</span>:<span
style=color:#4e9a06>"rocksdb"</span><span
style=color:#ce5c00;font-weight:700>}</span>
-</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>2 -
HugeGraph Config Options</h1><h3 id=gremlin-server-config-options>Gremlin
Server Config Options</h3><p>Corresponding configuration file
<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td></ [...]
+</span></span></code></pre></div></div><div class=td-content
style=page-break-before:always><h1 id=pg-6bfbb2db4e1f281942d741cef305e724>2 -
HugeGraph Config Options</h1><h3 id=gremlin-server-config-options>Gremlin
Server Config Options</h3><p>Corresponding configuration file
<code>gremlin-server.yaml</code></p><table><thead><tr><th>config
option</th><th>default
value</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>127.0.0.1</td><td>The
host or ip of Gremlin Server.</td></ [...]
which supports multi-user authentication and fine-grained access control. It
adopts a 4-layer design based on
“User-UserGroup-Operation-Resource” to
flexibly control user roles and permissions (supports multiple
GraphServers).</p><p>Some key designs of the <code>StandardAuthenticator</code>
mode include:</p><ul><li>During initialization, a super administrator
(<code>admin</code>) user is created. Subsequently, other users can be created
by the super administrator. Once newly created users are assigned sufficient
permissions, they can create or manage more users.</li><li>It supports dynamic
creation of users, user groups, and resource [...]
</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic></span><span
style=color:#000>user</span><span
style=color:#ce5c00;font-weight:700>(</span><span
style=color:#000>name</span><span
style=color:#ce5c00;font-weight:700>=</span><span
style=color:#000>xx</span><span style=color:#ce5c00;font-weight:700>)</span>
<span style=color:#ce5c00;font-weight:700>-</span><span
style=color:#000>belong</span><span
style=color:#ce5c00;font-weight:700>-></spa [...]
diff --git a/docs/config/config-guide/index.html
b/docs/config/config-guide/index.html
index 018d19fb..d100c8a6 100644
--- a/docs/config/config-guide/index.html
+++ b/docs/config/config-guide/index.html
@@ -2,10 +2,10 @@
The directory for the configuration files is hugegraph-release/conf, and all
the configurations related to the service and the graph itself …"><meta
property="og:title" content="HugeGraph configuration"><meta
property="og:description" content="1 Overview The directory for the
configuration files is hugegraph-release/conf, and all the configurations
related to the service and the graph itself are located in this directory.
The main configuration files include gremlin-server.yaml,
rest-server.properties, and hugegraph.properties.
The HugeGraphServer integrates the GremlinServer and RestServer internally,
and gremlin-server.yaml and rest-server.properties are used to configure these
two servers.
-GremlinServer: GremlinServer accepts Gremlin statements from users, parses
them, and then invokes the Core code. RestServer: It provides a RESTful API
that, based on different HTTP requests, calls the corresponding Core
API."><meta property="og:type" content="article"><meta property="og:url"
content="/docs/config/config-guide/"><meta property="article:section"
content="docs"><meta property="article:modified_time"
content="2024-08-02T15:50:42+08:00"><meta property="og:site_name" content="
[...]
+GremlinServer: GremlinServer accepts Gremlin statements from users, parses
them, and then invokes the Core code. RestServer: It provides a RESTful API
that, based on different HTTP requests, calls the corresponding Core
API."><meta property="og:type" content="article"><meta property="og:url"
content="/docs/config/config-guide/"><meta property="article:section"
content="docs"><meta property="article:modified_time"
content="2024-11-01T16:27:00+08:00"><meta property="og:site_name" content="
[...]
The main configuration files include gremlin-server.yaml,
rest-server.properties, and hugegraph.properties.
The HugeGraphServer integrates the GremlinServer and RestServer internally,
and gremlin-server.yaml and rest-server.properties are used to configure these
two servers.
-GremlinServer: GremlinServer accepts Gremlin statements from users, parses
them, and then invokes the Core code. RestServer: It provides a RESTful API
that, based on different HTTP requests, calls the corresponding Core
API."><meta itemprop=dateModified content="2024-08-02T15:50:42+08:00"><meta
itemprop=wordCount content="1437"><meta itemprop=keywords content><meta
name=twitter:card content="summary"><meta name=twitter:title content="HugeGraph
configuration"><meta name=twitter:descriptio [...]
+GremlinServer: GremlinServer accepts Gremlin statements from users, parses
them, and then invokes the Core code. RestServer: It provides a RESTful API
that, based on different HTTP requests, calls the corresponding Core
API."><meta itemprop=dateModified content="2024-11-01T16:27:00+08:00"><meta
itemprop=wordCount content="1545"><meta itemprop=keywords content><meta
name=twitter:card content="summary"><meta name=twitter:title content="HugeGraph
configuration"><meta name=twitter:descriptio [...]
The main configuration files include gremlin-server.yaml,
rest-server.properties, and hugegraph.properties.
The HugeGraphServer integrates the GremlinServer and RestServer internally,
and gremlin-server.yaml and rest-server.properties are used to configure these
two servers.
GremlinServer: GremlinServer accepts Gremlin statements from users, parses
them, and then invokes the Core code. RestServer: It provides a RESTful API
that, based on different HTTP requests, calls the corresponding Core
API."><link rel=preload
href=/scss/main.min.14ea575cb35d93d46ff8681b2334f40fd46243c100c5c39f5a841b931fae2d40.css
as=style><link
href=/scss/main.min.14ea575cb35d93d46ff8681b2334f40fd46243c100c5c39f5a841b931fae2d40.css
rel=stylesheet integrity><script src=https://code.jquer [...]
@@ -127,19 +127,63 @@ GremlinServer: GremlinServer accepts Gremlin statements
from users, parses them,
</span></span></span></code></pre></div><p>There are many configuration
options mentioned above, but for now, let’s focus on the following
options: <code>channelizer</code> and
<code>graphs</code>.</p><ul><li><code>graphs</code>: This option specifies the
graphs that need to be opened when the GremlinServer starts. It is a map
structure where the key is the name of the graph and the value is the
configuration file path for that graph.</li><li><code>channelizer</code>: The
GremlinSe [...]
</span></span><span style=display:flex><span># could use '0.0.0.0' or
specified (real)IP to expose external network access
</span></span><span
style=display:flex><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style=display:flex><span>#restserver.enable_graphspaces_filter=false
</span></span><span style=display:flex><span># gremlin server url, need to be
consistent with host and port in gremlin-server.yaml
</span></span><span
style=display:flex><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># graphs list with pair
NAME:CONF_PATH
-</span></span><span
style=display:flex><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span style=display:flex><span>graphs=./conf/graphs
</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span># authentication
+</span></span><span style=display:flex><span># The maximum thread ratio for
batch writing, only take effect if the batch.max_write_threads is 0
+</span></span><span style=display:flex><span>batch.max_write_ratio=80
+</span></span><span style=display:flex><span>batch.max_write_threads=0
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># configuration of arthas
+</span></span><span style=display:flex><span>arthas.telnet_port=8562
+</span></span><span style=display:flex><span>arthas.http_port=8561
+</span></span><span style=display:flex><span>arthas.ip=127.0.0.1
+</span></span><span style=display:flex><span>arthas.disabled_commands=jad
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># authentication configs
+</span></span><span style=display:flex><span># choose
'org.apache.hugegraph.auth.StandardAuthenticator' or
+</span></span><span style=display:flex><span>#
'org.apache.hugegraph.auth.ConfigAuthenticator'
</span></span><span style=display:flex><span>#auth.authenticator=
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for StandardAuthenticator mode
+</span></span><span style=display:flex><span>#auth.graph_store=hugegraph
+</span></span><span style=display:flex><span># auth client config
+</span></span><span
style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># for ConfigAuthenticator mode
</span></span><span style=display:flex><span>#auth.admin_token=
</span></span><span style=display:flex><span>#auth.user_tokens=[]
</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># TODO: Deprecated & removed
later (useless from version 1.5.0)
+</span></span><span style=display:flex><span># rpc server configs for multi
graph-servers or raft-servers
+</span></span><span style=display:flex><span>#rpc.server_host=127.0.0.1
+</span></span><span style=display:flex><span>#rpc.server_port=8091
+</span></span><span style=display:flex><span>#rpc.server_timeout=30
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># rpc client configs (like enable
to keep cache consistency)
+</span></span><span
style=display:flex><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>#rpc.client_connect_timeout=20
+</span></span><span style=display:flex><span>#rpc.client_reconnect_period=10
+</span></span><span style=display:flex><span>#rpc.client_read_timeout=40
+</span></span><span style=display:flex><span>#rpc.client_retries=3
+</span></span><span
style=display:flex><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># raft group initial peers
+</span></span><span
style=display:flex><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># lightweight load balancing
(beta)
</span></span><span style=display:flex><span>server.id=server-1
</span></span><span style=display:flex><span>server.role=master
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># slow query log
+</span></span><span style=display:flex><span>log.slow_query_threshold=1000
+</span></span><span style=display:flex><span>
+</span></span><span style=display:flex><span># jvm(in-heap) memory usage
monitor, set 1 to disable it
+</span></span><span style=display:flex><span>memory_monitor.threshold=0.85
+</span></span><span style=display:flex><span>memory_monitor.period=2000
</span></span></code></pre></div><ul><li><code>restserver.url</code>: The URL
at which the RestServer provides its services. Modify it according to the
actual environment. If you can’t connet to server from other IP address,
try to modify it as specific IP; or modify it as <code>http://0.0.0.0</code> to
listen all network interfaces as a convenient solution, but need to take care
of the network area that might access.</li><li><code>graphs</code>: The
RestServer also needs to open g [...]
</span></span><span
style=display:flex><span>gremlin.graph=org.apache.hugegraph.HugeFactory
</span></span><span style=display:flex><span>
@@ -272,7 +316,7 @@ GremlinServer: GremlinServer accepts Gremlin statements
from users, parses them,
</span></span></code></pre></div><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-bash data-lang=bash><span style=display:flex><span>curl
http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#ce5c00;font-weight:700>{</span><span
style=color:#4e9a06>"name"</span>:<span
style=color:#4e9a06>"hugegraph_rocksdb"</span>,<span
style=color:#4e9a06>"backend"</span>:<span
style=color:#4e9a06>"rocksdb"</span><span
style=color:#ce5c00;font-weight:700>}</span>
-</span></span></code></pre></div><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const
yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--response-yes"),noResponse=document.querySelector(".feedback--response-no"),disableButtons=()=>{yesButt
[...]
+</span></span></code></pre></div><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const
yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--response-yes"),noResponse=document.querySelector(".feedback--response-no"),disableButtons=()=>{yesButt
[...]
<script
src=https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js
integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA=="
crossorigin=anonymous></script>
<script src=/js/tabpane-persist.js></script>
<script
src=/js/main.min.aa9f4c5dae6a98b2c46277f4c56f1673a2b000d1756ce4ffae93784cab25e6d5.js
integrity="sha256-qp9MXa5qmLLEYnf0xW8Wc6KwANF1bOT/rpN4TKsl5tU="
crossorigin=anonymous></script>
diff --git a/docs/config/config-option/index.html
b/docs/config/config-option/index.html
index e386dd45..cbc3ffb3 100644
--- a/docs/config/config-option/index.html
+++ b/docs/config/config-option/index.html
@@ -13,15 +13,15 @@ description
host
127.0.0.1
The …"><meta property="og:title" content="HugeGraph Config Options"><meta
property="og:description" content="Gremlin Server Config Options Corresponding
configuration file gremlin-server.yaml
-config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
-config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
+config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
+config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
config option default value description host 127.0.0.1 The host or ip of
Gremlin Server. port 8182 The listening port of Gremlin Server. graphs
hugegraph: conf/hugegraph.properties The map of graphs with name and config
file path. scriptEvaluationTimeout 30000 The timeout for gremlin script
execution(millisecond). channelizer
org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer Indicates the
protocol which the Gremlin Server provides service. authentication
authenticator: org.apac [...]
<link rel=stylesheet href=/css/prism.css><script
type=application/javascript>var
doNotTrack=!1;doNotTrack||(window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new
Date,ga("create","UA-00000000-0","auto"),ga("send","pageview"))</script><script
async src=https://www.google-analytics.com/analytics.js></script></head><body
class=td-page><header><nav class="js-navbar-scroll navbar navbar-expand
navbar-dark flex-column flex-md-row td-navbar"><a class=navbar-brand href=/><sp
[...]
<a
href=https://github.com/apache/incubator-hugegraph-doc/edit/master/content/en/docs/config/config-option.md
class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit
fa-fw"></i> Edit this page</a>
<a
href="https://github.com/apache/incubator-hugegraph-doc/new/master/content/en/docs/config/config-option.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+
[...]
<a
href="https://github.com/apache/incubator-hugegraph-doc/issues/new?title=HugeGraph%20Config%20Options"
class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github
fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/apache/incubator-hugegraph/issues/new
class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas
fa-tasks fa-fw"></i> Create project issue</a>
-<a id=print href=/docs/config/_print/><i class="fa fa-print fa-fw"></i> Print
entire section</a></div><div class=td-toc><nav
id=TableOfContents><ul><li><ul><li><a
href=#gremlin-server-config-options>Gremlin Server Config
Options</a></li><li><a href=#rest-server--api-config-options>Rest Server & API
Config Options</a></li><li><a href=#basic-config-options>Basic Config
Options</a></li><li><a href=#rpc-server-config-options>RPC server Config
Options</a></li><li><a href=#cassandra-backend-co [...]
+<a id=print href=/docs/config/_print/><i class="fa fa-print fa-fw"></i> Print
entire section</a></div><div class=td-toc><nav
id=TableOfContents><ul><li><ul><li><a
href=#gremlin-server-config-options>Gremlin Server Config
Options</a></li><li><a href=#rest-server--api-config-options>Rest Server & API
Config Options</a></li><li><a href=#basic-config-options>Basic Config
Options</a></li><li><a href=#rpc-server-config-options>RPC server Config
Options</a></li><li><a href=#cassandra-backend-co [...]
<script
src=https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js
integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA=="
crossorigin=anonymous></script>
<script src=/js/tabpane-persist.js></script>
<script
src=/js/main.min.aa9f4c5dae6a98b2c46277f4c56f1673a2b000d1756ce4ffae93784cab25e6d5.js
integrity="sha256-qp9MXa5qmLLEYnf0xW8Wc6KwANF1bOT/rpN4TKsl5tU="
crossorigin=anonymous></script>
diff --git a/docs/config/index.xml b/docs/config/index.xml
index 6520baf7..a78dfcbd 100644
--- a/docs/config/index.xml
+++ b/docs/config/index.xml
@@ -136,19 +136,63 @@
<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-fallback" data-lang="fallback"><span
style="display:flex;"><span># bind url
</span></span><span style="display:flex;"><span># could use
&#39;0.0.0.0&#39; or specified (real)IP to expose external network
access
</span></span><span
style="display:flex;"><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style="display:flex;"><span>#restserver.enable_graphspaces_filter=false
</span></span><span style="display:flex;"><span># gremlin server
url, need to be consistent with host and port in gremlin-server.yaml
</span></span><span
style="display:flex;"><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># graphs list with
pair NAME:CONF_PATH
-</span></span><span
style="display:flex;"><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span
style="display:flex;"><span>graphs=./conf/graphs
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># authentication
+</span></span><span style="display:flex;"><span># The maximum
thread ratio for batch writing, only take effect if the batch.max_write_threads
is 0
+</span></span><span
style="display:flex;"><span>batch.max_write_ratio=80
+</span></span><span
style="display:flex;"><span>batch.max_write_threads=0
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># configuration of
arthas
+</span></span><span
style="display:flex;"><span>arthas.telnet_port=8562
+</span></span><span
style="display:flex;"><span>arthas.http_port=8561
+</span></span><span style="display:flex;"><span>arthas.ip=127.0.0.1
+</span></span><span
style="display:flex;"><span>arthas.disabled_commands=jad
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># authentication
configs
+</span></span><span style="display:flex;"><span># choose
&#39;org.apache.hugegraph.auth.StandardAuthenticator&#39; or
+</span></span><span style="display:flex;"><span>#
&#39;org.apache.hugegraph.auth.ConfigAuthenticator&#39;
</span></span><span
style="display:flex;"><span>#auth.authenticator=
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
StandardAuthenticator mode
+</span></span><span
style="display:flex;"><span>#auth.graph_store=hugegraph
+</span></span><span style="display:flex;"><span># auth client
config
+</span></span><span
style="display:flex;"><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
ConfigAuthenticator mode
</span></span><span style="display:flex;"><span>#auth.admin_token=
</span></span><span
style="display:flex;"><span>#auth.user_tokens=[]
</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># TODO: Deprecated
&amp; removed later (useless from version 1.5.0)
+</span></span><span style="display:flex;"><span># rpc server
configs for multi graph-servers or raft-servers
+</span></span><span
style="display:flex;"><span>#rpc.server_host=127.0.0.1
+</span></span><span
style="display:flex;"><span>#rpc.server_port=8091
+</span></span><span
style="display:flex;"><span>#rpc.server_timeout=30
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># rpc client
configs (like enable to keep cache consistency)
+</span></span><span
style="display:flex;"><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span
style="display:flex;"><span>#rpc.client_connect_timeout=20
+</span></span><span
style="display:flex;"><span>#rpc.client_reconnect_period=10
+</span></span><span
style="display:flex;"><span>#rpc.client_read_timeout=40
+</span></span><span
style="display:flex;"><span>#rpc.client_retries=3
+</span></span><span
style="display:flex;"><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># raft group
initial peers
+</span></span><span
style="display:flex;"><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># lightweight load
balancing (beta)
</span></span><span style="display:flex;"><span>server.id=server-1
</span></span><span style="display:flex;"><span>server.role=master
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># slow query log
+</span></span><span
style="display:flex;"><span>log.slow_query_threshold=1000
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># jvm(in-heap)
memory usage monitor, set 1 to disable it
+</span></span><span
style="display:flex;"><span>memory_monitor.threshold=0.85
+</span></span><span
style="display:flex;"><span>memory_monitor.period=2000
</span></span></code></pre></div><ul>
<li><code>restserver.url</code>: The URL at which the RestServer
provides its services. Modify it according to the actual environment. If you
can&rsquo;t connet to server from other IP address, try to modify it as
specific IP; or modify it as <code>http://0.0.0.0</code> to listen all
network interfaces as a convenient solution, but need to take care of the
network area that might access.</li>
<li><code>graphs</code>: The RestServer also needs to open graphs
when it starts. This option is a map structure where the key is the name of the
graph and the value is the configuration file path for that graph.</li>
@@ -516,6 +560,16 @@
<td>false</td>
<td>Whether to allow exception trace stack.</td>
</tr>
+<tr>
+<td>memory_monitor.threshold</td>
+<td>0.85</td>
+<td>The threshold of JVM(in-heap) memory usage monitoring , 1 means
disabling this function.</td>
+</tr>
+<tr>
+<td>memory_monitor.period</td>
+<td>2000</td>
+<td>The period in ms of JVM(in-heap) memory usage monitoring.</td>
+</tr>
</tbody>
</table>
<h3 id="basic-config-options">Basic Config Options</h3>
diff --git a/docs/index.xml b/docs/index.xml
index 3f96d402..a8cce1b6 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -166,19 +166,63 @@
<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-fallback" data-lang="fallback"><span
style="display:flex;"><span># bind url
</span></span><span style="display:flex;"><span># could use
&#39;0.0.0.0&#39; or specified (real)IP to expose external network
access
</span></span><span
style="display:flex;"><span>restserver.url=http://127.0.0.1:8080
+</span></span><span
style="display:flex;"><span>#restserver.enable_graphspaces_filter=false
</span></span><span style="display:flex;"><span># gremlin server
url, need to be consistent with host and port in gremlin-server.yaml
</span></span><span
style="display:flex;"><span>#gremlinserver.url=http://127.0.0.1:8182
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># graphs list with
pair NAME:CONF_PATH
-</span></span><span
style="display:flex;"><span>graphs=[hugegraph:conf/hugegraph.properties]
+</span></span><span
style="display:flex;"><span>graphs=./conf/graphs
</span></span><span style="display:flex;"><span>
-</span></span><span style="display:flex;"><span># authentication
+</span></span><span style="display:flex;"><span># The maximum
thread ratio for batch writing, only take effect if the batch.max_write_threads
is 0
+</span></span><span
style="display:flex;"><span>batch.max_write_ratio=80
+</span></span><span
style="display:flex;"><span>batch.max_write_threads=0
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># configuration of
arthas
+</span></span><span
style="display:flex;"><span>arthas.telnet_port=8562
+</span></span><span
style="display:flex;"><span>arthas.http_port=8561
+</span></span><span style="display:flex;"><span>arthas.ip=127.0.0.1
+</span></span><span
style="display:flex;"><span>arthas.disabled_commands=jad
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># authentication
configs
+</span></span><span style="display:flex;"><span># choose
&#39;org.apache.hugegraph.auth.StandardAuthenticator&#39; or
+</span></span><span style="display:flex;"><span>#
&#39;org.apache.hugegraph.auth.ConfigAuthenticator&#39;
</span></span><span
style="display:flex;"><span>#auth.authenticator=
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
StandardAuthenticator mode
+</span></span><span
style="display:flex;"><span>#auth.graph_store=hugegraph
+</span></span><span style="display:flex;"><span># auth client
config
+</span></span><span
style="display:flex;"><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># for
ConfigAuthenticator mode
</span></span><span style="display:flex;"><span>#auth.admin_token=
</span></span><span
style="display:flex;"><span>#auth.user_tokens=[]
</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># TODO: Deprecated
&amp; removed later (useless from version 1.5.0)
+</span></span><span style="display:flex;"><span># rpc server
configs for multi graph-servers or raft-servers
+</span></span><span
style="display:flex;"><span>#rpc.server_host=127.0.0.1
+</span></span><span
style="display:flex;"><span>#rpc.server_port=8091
+</span></span><span
style="display:flex;"><span>#rpc.server_timeout=30
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># rpc client
configs (like enable to keep cache consistency)
+</span></span><span
style="display:flex;"><span>#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span
style="display:flex;"><span>#rpc.client_connect_timeout=20
+</span></span><span
style="display:flex;"><span>#rpc.client_reconnect_period=10
+</span></span><span
style="display:flex;"><span>#rpc.client_read_timeout=40
+</span></span><span
style="display:flex;"><span>#rpc.client_retries=3
+</span></span><span
style="display:flex;"><span>#rpc.client_load_balancer=consistentHash
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># raft group
initial peers
+</span></span><span
style="display:flex;"><span>#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># lightweight load
balancing (beta)
</span></span><span style="display:flex;"><span>server.id=server-1
</span></span><span style="display:flex;"><span>server.role=master
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># slow query log
+</span></span><span
style="display:flex;"><span>log.slow_query_threshold=1000
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span># jvm(in-heap)
memory usage monitor, set 1 to disable it
+</span></span><span
style="display:flex;"><span>memory_monitor.threshold=0.85
+</span></span><span
style="display:flex;"><span>memory_monitor.period=2000
</span></span></code></pre></div><ul>
<li><code>restserver.url</code>: The URL at which the RestServer
provides its services. Modify it according to the actual environment. If you
can&rsquo;t connet to server from other IP address, try to modify it as
specific IP; or modify it as <code>http://0.0.0.0</code> to listen all
network interfaces as a convenient solution, but need to take care of the
network area that might access.</li>
<li><code>graphs</code>: The RestServer also needs to open graphs
when it starts. This option is a map structure where the key is the name of the
graph and the value is the configuration file path for that graph.</li>
@@ -2617,6 +2661,16 @@ you may wait for the community to update the data with
these enhancements.</p
<td>false</td>
<td>Whether to allow exception trace stack.</td>
</tr>
+<tr>
+<td>memory_monitor.threshold</td>
+<td>0.85</td>
+<td>The threshold of JVM(in-heap) memory usage monitoring , 1 means
disabling this function.</td>
+</tr>
+<tr>
+<td>memory_monitor.period</td>
+<td>2000</td>
+<td>The period in ms of JVM(in-heap) memory usage monitoring.</td>
+</tr>
</tbody>
</table>
<h3 id="basic-config-options">Basic Config Options</h3>
diff --git a/en/sitemap.xml b/en/sitemap.xml
index 4b03f5b3..9b93d6f0 100644
--- a/en/sitemap.xml
+++ b/en/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/docs/guides/architectural/</loc><lastmod>2023-06-25T21:06:07+08:00</lastmod><xhtml:link
rel="alternate" hreflang="cn"
href="/cn/docs/guides/architectural/"/><xhtml:link rel="alternate"
hreflang="en"
href="/docs/guides/architectural/"/></url><url><loc>/docs/config/config-guide/</loc><lastmod>2024-08-02T15:50:42+08:00</last
[...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/docs/guides/architectural/</loc><lastmod>2023-06-25T21:06:07+08:00</lastmod><xhtml:link
rel="alternate" hreflang="cn"
href="/cn/docs/guides/architectural/"/><xhtml:link rel="alternate"
hreflang="en"
href="/docs/guides/architectural/"/></url><url><loc>/docs/config/config-guide/</loc><lastmod>2024-11-01T16:27:00+08:00</last
[...]
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index 7421c7ec..3dd82ed6 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>/en/sitemap.xml</loc><lastmod>2024-09-22T16:29:09+02:00</lastmod></sitemap><sitemap><loc>/cn/sitemap.xml</loc><lastmod>2024-09-22T22:25:27+08:00</lastmod></sitemap></sitemapindex>
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>/en/sitemap.xml</loc><lastmod>2024-11-01T16:27:00+08:00</lastmod></sitemap><sitemap><loc>/cn/sitemap.xml</loc><lastmod>2024-11-01T16:27:00+08:00</lastmod></sitemap></sitemapindex>
\ No newline at end of file