| import{_ as l,r as d,o as i,c as n,b as o,d as e,a as s,w as r,e as t}from"./app-Bx8hKGcu.js";const c={},p=t('<h2 id="node-工具" tabindex="-1"><a class="header-anchor" href="#node-工具"><span>Node 工具</span></a></h2><h3 id="工具介绍" tabindex="-1"><a class="header-anchor" href="#工具介绍"><span>工具介绍</span></a></h3><p>IoTDB 集群版为您提供了 NodeTool Shell 工具用于监控指定集群的工作状态，您可以通过运行多种指令获取集群各项状态。</p><p>下面具体介绍每个指令的使用方式及示例，其中 $IOTDB_CLUSTER_HOME 表示 IoTDB 分布式的安装目录所在路径。</p><h3 id="前提条件" tabindex="-1"><a class="header-anchor" href="#前提条件"><span>前提条件</span></a></h3>',5),u=t(`<h3 id="使用说明" tabindex="-1"><a class="header-anchor" href="#使用说明"><span>使用说明</span></a></h3><h4 id="运行方式" tabindex="-1"><a class="header-anchor" href="#运行方式"><span>运行方式</span></a></h4><p>NodeTool Shell 工具启动脚本位于 $IOTDB_CLUSTER_HOME/sbin 文件夹下，启动时可以指定集群运行的 IP 和 PORT。<br> 其中 IP 为您期望连接的节点的 IP，PORT 为 IoTDB 集群启动时指定的 JMX 服务端口号，分别默认为<code>127.0.0.1</code>和<code>31999</code>。</p><p>如果您需要监控远程集群或修改了 JMX 服务端口号，请通过启动参数<code>-h</code>和<code>-p</code>项来使用实际的 IP 和 PORT。</p><p>对于开启了 JMX 鉴权服务的，启动时候需要指定 JMX 服务的用户名和密码，默认分别为<code>iotdb</code>和<code>passw!d</code>，请通过启动参数<code>-u</code> 和<code>-pw</code><br> 项来指定 JMX 服务的用户名和密码。</p><h4 id="指令说明" tabindex="-1"><a class="header-anchor" href="#指令说明"><span>指令说明</span></a></h4><p>在分布式系统中，一个节点由节点 IP，元数据端口，数据端口和服务端口来标识，即 Node<IP:METAPORT:DATAPORT:CLUSTERPORT>。</p><h5 id="展示节点环" tabindex="-1"><a class="header-anchor" href="#展示节点环"><span>展示节点环</span></a></h5><p>IoTDB 集群版采用一致性哈希的方式实现数据分布，用户可以通过打印哈希环信息了解每个节点在环中的位置。</p><ol><li>输入</li></ol><blockquote><p>打印哈希环的指令为 ring</p></blockquote><ol start="2"><li>输出</li></ol><blockquote><p>输出为多行字符串，每行字符串为一个键值对，其中键表示节点标识，值表示节点 (IP:METAPORT:DATAPORT:CLUSTERPORT)，格式为、<key -> value>。</p></blockquote><ol start="3"><li>示例</li></ol><blockquote><p>假设当前集群运行在 127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668 和 127.0.0.1:9007:40014:6669 三个节点上。<br> 不同系统的输入指令示例如下：</p></blockquote><p>Linux 系统与 MacOS 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > ./sbin/nodetool.sh -h 127.0.0.1 -p 31999 ring |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Windows 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > .\\sbin\\nodetool.bat -h 127.0.0.1 -p 31999 ring |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>回车后即可执行指令。示例指令的输出如下：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Node Identifier Node |
| 330411070 -> 127.0.0.1:9003:40010:6667 |
| 330454032 -> 127.0.0.1:9005:40012:6668 |
| 330496472 -> 127.0.0.1:9007:40014:6669 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>上述输出表示当前集群共有 3 个节点，按照节点标识从小到大输出结果。</p><h5 id="查询数据分区和元数据分区" tabindex="-1"><a class="header-anchor" href="#查询数据分区和元数据分区"><span>查询数据分区和元数据分区</span></a></h5><p>IoTDB 集群版的时间序列元数据按照存储组分给多个数据组，其中存储组和数据组为多对一的关系，<br> 即同一个存储组的时间序列元数据只存在于同一个数据组，一个数据组可能包含多个存储组的时间序列元数据；</p><p>数据按照存储组和其时间戳分给不同数据组，时间分区粒度默认为一天。</p><p>数据组由多个节点组成，节点数量为副本数，保证数据高可用，其中某一个节点担任 Leader 的角色。</p><p>通过该指令，用户可以获知某个路径下的元数据或数据具体存储在哪些节点下。</p><ol><li>输入</li></ol><blockquote><p>查询数据分区信息的指令为 partition，参数具体说明如下：</p></blockquote><table><thead><tr><th>参数名</th><th>参数说明</th><th>示例</th></tr></thead><tbody><tr><td>-m</td><td>--metadata 查询元数据分区，默认为查询数据分区</td><td>-m</td></tr><tr><td>-path</td><td>--path 必要参数，需要查询的路径，若该路径无对应的存储组，则查询失败</td><td>-path root.guangzhou.d1</td></tr><tr><td>-st</td><td>--StartTime 查询数据分区时使用，起始时间，默认为系统当前时间</td><td>-st 1576724778159</td></tr><tr><td>-et</td><td>--EndTime 查询数据分区时使用，终止时间，默认为系统当前时间。若终止时间小于起始时间，则终止时间默认为起始时间</td><td>-et 1576724778159</td></tr></tbody></table><ol start="2"><li>输出</li></ol><blockquote><p>输出为多行字符串，每行字符串为一个键值对，其中键表示分区，值表示数据组，格式为、<key -> value>。</p></blockquote><ol start="3"><li>示例</li></ol><blockquote><p>假设当前集群运行在 127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668 和 127.0.0.1:9007:40014:6669 三个节点上。<br> 副本数为 2，共有 3 个存储组：{root.beijing、root.shanghai、root.guangzhou}。</p></blockquote><ul><li>查询数据的分区（默认时间范围，时间按天分区）</li></ul><p>不同系统的输入指令示例如下：</p><p>Linux 系统与 MacOS 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > ./sbin/nodetool.sh -h 127.0.0.1 -p 31999 partition -path root.guangzhou.d1 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Windows 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > .\\sbin\\nodetool.bat -h 127.0.0.1 -p 31999 partition -path root.guangzhou.d1 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>回车后即可执行指令。示例指令的输出如下：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>DATA<root.guangzhou.d1, 1576723735188, 1576723735188> -> [127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668] |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>查询数据的分区（指定时间范围，时间按天分区）</li></ul><p>不同系统的输入指令示例如下：</p><p>Linux 系统与 MacOS 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > ./sbin/nodetool.sh -h 127.0.0.1 -p 31999 partition -path root.guangzhou.d1 -st 1576624778159 -et 1576724778159 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Windows 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > .\\sbin\\nodetool.bat -h 127.0.0.1 -p 31999 partition -path root.guangzhou.d1 -st 1576624778159 -et 1576724778159 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>回车后即可执行指令。示例指令的输出如下：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>DATA<root.guangzhou.d1, 1576627200000, 1576713599999> -> [127.0.0.1:9007:40014:6669, 127.0.0.1:9003:40010:6667] |
| DATA<root.guangzhou.d1, 1576713600000, 1576724778159> -> [127.0.0.1:9003:40010:6668, 127.0.0.1:9005:40012:6668] |
| DATA<root.guangzhou.d1, 1576624778159, 1576627199999> -> [127.0.0.1:9005:40012:6667, 127.0.0.1:9007:40014:6669] |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>查询元数据分区</li></ul><p>不同系统的输入指令示例如下：</p><p>Linux 系统与 MacOS 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > ./sbin/nodetool.sh -h 127.0.0.1 -p 31999 partition -path root.guangzhou.d1 -m |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Windows 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > .\\sbin\\nodetool.bat -h 127.0.0.1 -p 31999 partition -path root.guangzhou.d1 -m |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>回车后即可执行指令。示例指令的输出如下：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>DATA<root.guangzhou.d1, 1576723735188, 1576723735188> -> [127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668] |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>上述输出表示 root.t1.d1 所属的数据分区包含 2 个节点，其中 127.0.0.1:9003:40010:6667 为 header 节点。</p><h5 id="查询节点管理的槽数" tabindex="-1"><a class="header-anchor" href="#查询节点管理的槽数"><span>查询节点管理的槽数</span></a></h5><p>IoTDB 集群版将哈希环划分为固定数量（默认 10000) 个槽，并由集群管理组（元数据组）的 leader 将槽划分各个数据组。通过该指令，用户可以获知数据组管理的槽数。</p><ol><li>输入</li></ol><blockquote><p>查询节点对应数据分区信息的指令为 host，参数具体说明如下：</p></blockquote><table><thead><tr><th>参数名</th><th>参数说明</th><th>示例</th></tr></thead><tbody><tr><td>-a --all</td><td>查询所有数据组管理的槽数，默认为查询的节点所在的数据组</td><td>-a</td></tr></tbody></table><ol start="2"><li>输出</li></ol><blockquote><p>输出为多行字符串，其中每行字符串为一个键值对，其中键表示数据组，值表示管理的槽数，格式为、<key -> value>。</p></blockquote><ol start="3"><li>示例</li></ol><blockquote><p>假设当前集群运行在 127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668 和 127.0.0.1:9007:40014:6669 三个节点上，副本数为 2。</p></blockquote><ul><li>默认节点所在分区</li></ul><p>不同系统的输入指令示例如下：</p><p>Linux 系统与 MacOS 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > ./sbin/nodetool.sh -h 127.0.0.1 -p 31999 host |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Windows 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > .\\sbin\\nodetool.bat -h 127.0.0.1 -p 31999 host |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>回车后即可执行指令。示例指令的输出如下：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Raft group Slot Number |
| (127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668) -> 3333 |
| (127.0.0.1:9007:40014:6669, 127.0.0.1:9003:40010:6667) -> 3334 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>所有分区</li></ul><p>不同系统的输入指令示例如下：</p><p>Linux 系统与 MacOS 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > ./sbin/nodetool.sh -h 127.0.0.1 -p 31999 host -a |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Windows 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > .\\sbin\\nodetool.bat -h 127.0.0.1 -p 31999 host -a |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>回车后即可执行指令。示例指令的输出如下：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Raft group Slot Number |
| (127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668) -> 3333 |
| (127.0.0.1:9005:40012:6668, 127.0.0.1:9007:40014:6669) -> 3333 |
| (127.0.0.1:9007:40014:6669, 127.0.0.1:9003:40010:6667) -> 3334 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="查询节点状态" tabindex="-1"><a class="header-anchor" href="#查询节点状态"><span>查询节点状态</span></a></h5><p>IoTDB 集群版包含多个节点，对于任意节点都存在因为网络、硬件等问题导致无法正常提供服务的可能。</p><p>通过该指令，用户即可获知集群中所有节点当前的状态。</p><ol><li>输入</li></ol><blockquote><p>查询节点状态的指令为 status，无其他参数。</p></blockquote><ol start="2"><li>输出</li></ol><blockquote><p>输出为多行字符串，其中每行字符串为一个键值对，其中键表示节点 (IP:METAPORT:DATAPORT)，<br> 值表示该节点的状态，“on”为正常，“off”为不正常，格式为、<key -> value>。</p></blockquote><ol start="3"><li>示例</li></ol><blockquote><p>假设当前集群运行在 127.0.0.1:9003:40010:6667, 127.0.0.1:9005:40012:6668 和 127.0.0.1:9007:40014:6669 三个节点上，副本数为 2。</p></blockquote><p>不同系统的输入指令示例如下：</p><p>Linux 系统与 MacOS 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > ./sbin/nodetool.sh -h 127.0.0.1 -p 31999 status |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Windows 系统：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Shell > .\\sbin\\nodetool.bat -h 127.0.0.1 -p 31999 status |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>回车后即可执行指令。示例指令的输出如下：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Node Status |
| 127.0.0.1:9003:40010:6667 -> on |
| 127.0.0.1:9005:40012:6668 -> off |
| 127.0.0.1:9007:40014:6669 -> on |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>上述输出表示 127.0.0.1:9003:40010:6667 节点和 127.0.0.1:9007:40014:6669 节点状态正常，127.0.0.1:9005:40012:6668 节点无法提供服务。</p>`,101);function h(g,v){const a=d("RouteLink");return i(),n("div",null,[p,o("p",null,[e("使用 NodeTool 需要开启 JMX 服务，具体请参考 "),s(a,{to:"/zh/UserGuide/V0.13.x/Maintenance-Tools/JMX-Tool.html"},{default:r(()=>[e("JMX Tool")]),_:1}),e("。")]),u])}const m=l(c,[["render",h],["__file","NodeTool.html.vue"]]),x=JSON.parse('{"path":"/zh/UserGuide/V0.13.x/Maintenance-Tools/NodeTool.html","title":"","lang":"zh-CN","frontmatter":{"description":"Node 工具 工具介绍 IoTDB 集群版为您提供了 NodeTool Shell 工具用于监控指定集群的工作状态，您可以通过运行多种指令获取集群各项状态。 下面具体介绍每个指令的使用方式及示例，其中 $IOTDB_CLUSTER_HOME 表示 IoTDB 分布式的安装目录所在路径。 前提条件 使用 NodeTool 需要开启 JMX 服务，具体请...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://iotdb.apache.org/UserGuide/V0.13.x/Maintenance-Tools/NodeTool.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/NodeTool.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:description","content":"Node 工具 工具介绍 IoTDB 集群版为您提供了 NodeTool Shell 工具用于监控指定集群的工作状态，您可以通过运行多种指令获取集群各项状态。 下面具体介绍每个指令的使用方式及示例，其中 $IOTDB_CLUSTER_HOME 表示 IoTDB 分布式的安装目录所在路径。 前提条件 使用 NodeTool 需要开启 JMX 服务，具体请..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2023-07-10T03:11:17.000Z"}],["meta",{"property":"article:modified_time","content":"2023-07-10T03:11:17.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-07-10T03:11:17.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Node 工具","slug":"node-工具","link":"#node-工具","children":[{"level":3,"title":"工具介绍","slug":"工具介绍","link":"#工具介绍","children":[]},{"level":3,"title":"前提条件","slug":"前提条件","link":"#前提条件","children":[]},{"level":3,"title":"使用说明","slug":"使用说明","link":"#使用说明","children":[]}]}],"git":{"createdTime":1688958677000,"updatedTime":1688958677000,"contributors":[{"name":"CritasWang","email":"critas@outlook.com","commits":1}]},"readingTime":{"minutes":7.16,"words":2148},"filePathRelative":"zh/UserGuide/V0.13.x/Maintenance-Tools/NodeTool.md","localizedDate":"2023年7月10日","autoDesc":true}');export{m as comp,x as data}; |
