| import{_ as n,r,o as s,c as l,b as e,d as t,a as o,e as i}from"./app-Bp5kEZWW.js";const d={},c=i('<h1 id="monitoring-board-install-and-deploy" tabindex="-1"><a class="header-anchor" href="#monitoring-board-install-and-deploy"><span>Monitoring Board Install and Deploy</span></a></h1><p>From the Apache IoTDB 1.0 version, we introduced the system monitoring module, you can complete the Apache IoTDB important operational indicators for monitoring, this article describes how to open the system monitoring module in the Apache IoTDB distribution, and the use of Prometheus + Grafana way to complete the visualisation of the system monitoring indicators.</p><h2 id="pre-preparation" tabindex="-1"><a class="header-anchor" href="#pre-preparation"><span>pre-preparation</span></a></h2><h3 id="software-requirement" tabindex="-1"><a class="header-anchor" href="#software-requirement"><span>software requirement</span></a></h3>',4),h={href:"https://iotdb.apache.org/Download/",target:"_blank",rel:"noopener noreferrer"},g={href:"https://prometheus.io/download/",target:"_blank",rel:"noopener noreferrer"},m={href:"https://grafana.com/grafana/download",target:"_blank",rel:"noopener noreferrer"},p=e("li",null,"IoTDB-Grafana installer: Grafana Dashboards is an TimechoDB(Enterprise Edition based on IoTDB) tool, and you may contact your sales for the relevant installer.",-1),u=i(`<h3 id="cluster-requirement" tabindex="-1"><a class="header-anchor" href="#cluster-requirement"><span>cluster requirement</span></a></h3><p>Make sure that the IoTDB cluster is started before doing the following.</p><h3 id="clarification" tabindex="-1"><a class="header-anchor" href="#clarification"><span>clarification</span></a></h3><p>This doc will build the monitoring dashboard on one machine (1 ConfigNode and 1 DataNode) environment, other cluster configurations are similar, users can adjust the configuration according to their own cluster situation (the number of ConfigNode and DataNode). The basic configuration information of the cluster built in this paper is shown in the table below.</p><table><thead><tr><th>NODETYPE</th><th>NODEIP</th><th>Monitor Pusher</th><th>Monitor Level</th><th>Monitor Port</th></tr></thead><tbody><tr><td>ConfigNode</td><td>127.0.0.1</td><td>PROMETHEUS</td><td>IMPORTANT</td><td>9091</td></tr><tr><td>DataNode</td><td>127.0.0.1</td><td>PROMETHEUS</td><td>IMPORTANT</td><td>9093</td></tr></tbody></table><h2 id="configure-prometheus-capture-monitoring-metrics" tabindex="-1"><a class="header-anchor" href="#configure-prometheus-capture-monitoring-metrics"><span>configure Prometheus capture monitoring metrics</span></a></h2><ol><li>Download the installation package. Download the Prometheus binary package locally, unzip it and go to the corresponding folder:</li></ol><div class="language-Shell line-numbers-mode" data-ext="Shell" data-title="Shell"><pre class="language-Shell"><code>tar xvfz prometheus-*.tar.gz |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div>`,7),y={start:"3"},w={href:"http://localhost:3000",target:"_blank",rel:"noopener noreferrer"},D=e("li",null,"First we configure the Data Source in Configuration to be Prometheus.",-1),_=i('<figure><img src="https://alioss.timecho.com/docs/img/3a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="5"><li>When configuring the Data Source, pay attention to the URL where Prometheus is located, and click Save & Test after configuration, the Data source is working prompt appears, then the configuration is successful.</li></ol><figure><img src="https://alioss.timecho.com/docs/img/4a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><h3 id="step2-use-the-official-grafana-dashboard-provided-by-iotdb" tabindex="-1"><a class="header-anchor" href="#step2-use-the-official-grafana-dashboard-provided-by-iotdb"><span>Step2：Use the official Grafana dashboard provided by IoTDB</span></a></h3><ol><li>Enter Grafana，click Browse of Dashboards</li></ol><figure><img src="https://alioss.timecho.com/docs/img/5a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="2"><li>Click the Import button on the right</li></ol><figure><img src="https://alioss.timecho.com/docs/img/6a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="3"><li>Select a way to import Dashboard<br> a. Upload the Json file of the downloaded Dashboard locally<br> b. Enter the URL or ID of the Dashboard obtained from the Grafana website<br> c. Paste the contents of the Dashboard's Json file</li></ol><figure><img src="https://alioss.timecho.com/docs/img/7a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="4"><li>Select Prometheus in the Dashboard as the Data Source you just configured and click Import</li></ol><figure><img src="https://alioss.timecho.com/docs/img/8a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="5"><li>Then enter Dashboard，select job to be ConfigNode，then following monitoring dashboard will be seen:</li></ol><figure><img src="https://alioss.timecho.com/docs/img/9a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="6"><li>Similarly, we can import the Apache DataNode Dashboard, select job as DataNode,then following monitoring dashboard will be seen:</li></ol><figure><img src="https://alioss.timecho.com/docs/img/10a.pngA" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><h3 id="step3-creating-a-new-dashboard-for-data-visualisation" tabindex="-1"><a class="header-anchor" href="#step3-creating-a-new-dashboard-for-data-visualisation"><span>Step3：Creating a new Dashboard for data visualisation</span></a></h3><ol><li>First create the Dashboard, then create the Panel.</li></ol><figure><img src="https://alioss.timecho.com/docs/img/11a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="2"><li>After that, you can visualize the monitoring-related data in the panel according to your needs (all relevant monitoring metrics can be filtered by selecting confignode/datanode in the job first).</li></ol><figure><img src="https://alioss.timecho.com/docs/img/12a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><ol start="3"><li>Once the visualisation of the monitoring metrics selected for attention is complete, we get a panel like this:</li></ol><figure><img src="https://alioss.timecho.com/docs/img/13a.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure>',23);function x(S,k){const a=r("ExternalLinkIcon");return s(),l("div",null,[c,e("ol",null,[e("li",null,[t("Apache IoTDB: version 1.0 and above, download from the official website: "),e("a",h,[t("https://iotdb.apache.org/Download/"),o(a)])]),e("li",null,[t("Prometheus: version 2.30.3 and above, download from the official website: "),e("a",g,[t("https://prometheus.io/download/"),o(a)])]),e("li",null,[t("Grafana: version 8.4.2 and above, download from the official website: "),e("a",m,[t("https://grafana.com/grafana/download"),o(a)])]),p]),u,e("ol",f,[e("li",null,[t("Confirm the startup is successful. Enter "),e("a",b,[t("http://localhost:9090"),o(a)]),t(" in the browser to enter Prometheus, click to enter the Target interface under Status (Figure 1 below), when you see State are Up, it means the configuration is successful and connected (Figure 2 below), click the link on the left side to jump to the webpage monitoring.")])]),v,e("ol",y,[e("li",null,[t("Enter "),e("a",w,[t("http://localhost:3000"),o(a)]),t(" in your browser to access Grafana, the default initial username and password are both admin.")]),D]),_])}const T=n(d,[["render",x],["__file","Monitoring-Board-Install-and-Deploy.html.vue"]]),M=JSON.parse('{"path":"/UserGuide/V1.2.x/Deployment-and-Maintenance/Monitoring-Board-Install-and-Deploy.html","title":"Monitoring Board Install and Deploy","lang":"en-US","frontmatter":{"description":"Monitoring Board Install and Deploy From the Apache IoTDB 1.0 version, we introduced the system monitoring module, you can complete the Apache IoTDB important operational indica...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://iotdb.apache.org/zh/UserGuide/V1.2.x/Deployment-and-Maintenance/Monitoring-Board-Install-and-Deploy.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/UserGuide/V1.2.x/Deployment-and-Maintenance/Monitoring-Board-Install-and-Deploy.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"Monitoring Board Install and Deploy"}],["meta",{"property":"og:description","content":"Monitoring Board Install and Deploy From the Apache IoTDB 1.0 version, we introduced the system monitoring module, you can complete the Apache IoTDB important operational indica..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://alioss.timecho.com/docs/img/1a.PNG"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2024-01-12T08:18:47.000Z"}],["meta",{"property":"article:modified_time","content":"2024-01-12T08:18:47.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Monitoring Board Install and Deploy\\",\\"image\\":[\\"https://alioss.timecho.com/docs/img/1a.PNG\\",\\"https://alioss.timecho.com/docs/img/2a.PNG\\",\\"https://alioss.timecho.com/docs/img/3a.png\\",\\"https://alioss.timecho.com/docs/img/4a.png\\",\\"https://alioss.timecho.com/docs/img/5a.png\\",\\"https://alioss.timecho.com/docs/img/6a.png\\",\\"https://alioss.timecho.com/docs/img/7a.png\\",\\"https://alioss.timecho.com/docs/img/8a.png\\",\\"https://alioss.timecho.com/docs/img/9a.png\\",\\"https://alioss.timecho.com/docs/img/10a.pngA\\",\\"https://alioss.timecho.com/docs/img/11a.png\\",\\"https://alioss.timecho.com/docs/img/12a.png\\",\\"https://alioss.timecho.com/docs/img/13a.png\\"],\\"dateModified\\":\\"2024-01-12T08:18:47.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"pre-preparation","slug":"pre-preparation","link":"#pre-preparation","children":[{"level":3,"title":"software requirement","slug":"software-requirement","link":"#software-requirement","children":[]},{"level":3,"title":"cluster requirement","slug":"cluster-requirement","link":"#cluster-requirement","children":[]},{"level":3,"title":"clarification","slug":"clarification","link":"#clarification","children":[]}]},{"level":2,"title":"configure Prometheus capture monitoring metrics","slug":"configure-prometheus-capture-monitoring-metrics","link":"#configure-prometheus-capture-monitoring-metrics","children":[]},{"level":2,"title":"Using Grafana to View Monitoring Data","slug":"using-grafana-to-view-monitoring-data","link":"#using-grafana-to-view-monitoring-data","children":[{"level":3,"title":"Step1：Grafana Installation, Configuration and Startup","slug":"step1-grafana-installation-configuration-and-startup","link":"#step1-grafana-installation-configuration-and-startup","children":[]},{"level":3,"title":"Step2：Use the official Grafana dashboard provided by IoTDB","slug":"step2-use-the-official-grafana-dashboard-provided-by-iotdb","link":"#step2-use-the-official-grafana-dashboard-provided-by-iotdb","children":[]},{"level":3,"title":"Step3：Creating a new Dashboard for data visualisation","slug":"step3-creating-a-new-dashboard-for-data-visualisation","link":"#step3-creating-a-new-dashboard-for-data-visualisation","children":[]}]}],"git":{"createdTime":1692104943000,"updatedTime":1705047527000,"contributors":[{"name":"CritasWang","email":"critas@outlook.com","commits":1},{"name":"wanghui42","email":"105700158+wanghui42@users.noreply.github.com","commits":1}]},"readingTime":{"minutes":2.84,"words":852},"filePathRelative":"UserGuide/V1.2.x/Deployment-and-Maintenance/Monitoring-Board-Install-and-Deploy.md","localizedDate":"August 15, 2023","autoDesc":true}');export{T as comp,M as data}; |
