| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.14" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.52" /> |
| <style> |
| html { |
| background: var(--bg-color, #fff); |
| } |
| |
| html[data-theme="dark"] { |
| background: var(--bg-color, #1d1e1f); |
| } |
| |
| body { |
| background: var(--bg-color); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment.html"><meta property="og:url" content="https://iotdb.apache.org/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="Workbench Deployment"><meta property="og:description" content="Workbench Deployment The visualization console is one of the supporting tools for IoTDB. It is an official application tool system used in various stages of database deployment,..."><meta property="og:type" content="article"><meta property="og:image" content="https://alioss.timecho.com/docs/img/%E5%90%AF%E5%8A%A8.PNG"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2024-09-29T06:52:57.000Z"><meta property="article:modified_time" content="2024-09-29T06:52:57.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Workbench Deployment","image":["https://alioss.timecho.com/docs/img/%E5%90%AF%E5%8A%A8.PNG","https://alioss.timecho.com/docs/img/workbench-conf-1.png","https://alioss.timecho.com/docs/img/windows-jps.png","https://alioss.timecho.com/docs/img/workbench-en.png","https://alioss.timecho.com/docs/img/workbench-conf-1.png","https://alioss.timecho.com/docs/img/linux-jps.png","https://alioss.timecho.com/docs/img/workbench-en.png","https://alioss.timecho.com/docs/img/workbench-en-1.jpeg","https://alioss.timecho.com/docs/img/workbench-en-2.png"],"dateModified":"2024-09-29T06:52:57.000Z","author":[]}</script><link rel="icon" href="/favicon.ico"><meta name="Description" content="Apache IoTDB: Time Series Database for IoT"><meta name="Keywords" content="TSDB, time series, time series database, IoTDB, IoT database, IoT data management,时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"><meta name="baidu-site-verification" content="wfKETzB3OT"><meta name="google-site-verification" content="mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"><script type="text/javascript"> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '56']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>Workbench Deployment | IoTDB Website</title><meta name="description" content="Workbench Deployment The visualization console is one of the supporting tools for IoTDB. It is an official application tool system used in various stages of database deployment,..."> |
| <link rel="preload" href="/assets/style-Bg55snry.css" as="style"><link rel="stylesheet" href="/assets/style-Bg55snry.css"> |
| <link rel="modulepreload" href="/assets/app-W3EENNaa.js"><link rel="modulepreload" href="/assets/workbench-deployment.html-5-Ahb5Ko.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container external-link-icon pure has-toc"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!----><!--[--><a class="route-link vp-brand" href="/"><img class="vp-nav-logo" src="/logo.png" alt><!----><span class="vp-site-name hide-in-pad">IoTDB Website</span></a><!--]--><!----></div><div class="vp-navbar-center"><!----><!--[--><!--]--><!----></div><div class="vp-navbar-end"><!----><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"><svg width="15" height="15" class="DocSearch-Control-Key-Icon"><path d="M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953" stroke-width="1.2" stroke="currentColor" fill="none" stroke-linecap="square"></path></svg></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v1.3.0/1/2"><!---->v1.3.0/1/2<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.1.x/QuickStart/QuickStart.html" aria-label="v1.1.x"><!---->v1.1.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.0.x/QuickStart/QuickStart.html" aria-label="v1.0.x"><!---->v1.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank"><!---->Design<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Commiters.html" aria-label="Commiters"><!---->Commiters<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" rel="noopener noreferrer" target="_blank"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" rel="noopener noreferrer" target="_blank"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" rel="noopener noreferrer" target="_blank"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment.html" aria-label="English"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment.html" aria-label="简体中文"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/iotdb" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><!----><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar"><!----><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB User Guide (V1.3.0/1/2)</span><!----></p><ul class="vp-sidebar-links"></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">About IoTDB</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="Quick Start"><!---->Quick Start<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Basic Concept</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Deployment & Maintenance</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">User Manual</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Tools System</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">API</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Ecosystem Integration</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">SQL Manual</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">FAQ</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Reference</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!----></aside><!--[--><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Workbench Deployment</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="Writing Date"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span><!----></span><meta property="datePublished" content="2024-07-01T09:27:42.000Z"></span><!----><span class="page-reading-time-info" aria-label="Reading Time"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon" name="timer"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>About 6 min</span><meta property="timeRequired" content="PT6M"></span><!----><!----></div><hr></div><div class="vp-toc-placeholder"><aside id="toc"><!----><div class="vp-toc-header">On This Page<button type="button" class="print-button" title="Print"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon" name="print"><path d="M819.2 364.8h-44.8V128c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v236.8h-44.8C145.067 364.8 96 413.867 96 473.6v192c0 59.733 49.067 108.8 108.8 108.8h44.8V896c0 17.067 14.933 32 32 32h460.8c17.067 0 32-14.933 32-32V774.4h44.8c59.733 0 108.8-49.067 108.8-108.8v-192c0-59.733-49.067-108.8-108.8-108.8zM313.6 160h396.8v204.8H313.6V160zm396.8 704H313.6V620.8h396.8V864zM864 665.6c0 25.6-19.2 44.8-44.8 44.8h-44.8V588.8c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v121.6h-44.8c-25.6 0-44.8-19.2-44.8-44.8v-192c0-25.6 19.2-44.8 44.8-44.8h614.4c25.6 0 44.8 19.2 44.8 44.8v192z"></path></svg></button><div class="arrow end"></div></div><div class="vp-toc-wrapper"><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#installation-preparation">Installation Preparation</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#installation-steps">Installation Steps</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#step-1-iotdb-enables-monitoring-indicator-collection">Step 1: IoTDB enables monitoring indicator collection</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#step-2-install-and-configure-prometheus">Step 2: Install and configure Prometheus</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#step-3-install-workbench">Step 3: Install Workbench</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#step-4-configure-instance-information">Step 4: Configure Instance Information</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#appendix-iotdb-and-workbench-version-comparison-table">Appendix: IoTDB and Workbench Version Comparison Table</a></li><!----><!--]--></ul><div class="vp-toc-marker" style="top:-1.7rem;"></div></div><!----></aside></div><!----><div class="theme-hope-content"><h1 id="workbench-deployment" tabindex="-1"><a class="header-anchor" href="#workbench-deployment"><span>Workbench Deployment</span></a></h1><p>The visualization console is one of the supporting tools for IoTDB. It is an official application tool system used in various stages of database deployment, operation and maintenance management, and application development, making the use, operation and management of databases simpler and more efficient, truly achieving low-cost management and operation of databases. This document will help you install Workbench.</p><div style="display:flex;justify-content:space-between;"><img src="https://alioss.timecho.com/docs/img/workbench-en-pklh.png" alt=" " style="width:50%;"><img src="https://alioss.timecho.com/docs/img/workbench-en-bxzk.png" alt=" " style="width:50%;"></div><h2 id="installation-preparation" tabindex="-1"><a class="header-anchor" href="#installation-preparation"><span>Installation Preparation</span></a></h2><table><thead><tr><th style="text-align:center;">Preparation Content</th><th style="text-align:center;">Name</th><th style="text-align:center;">Version Requirements</th><th style="text-align:center;">Link</th></tr></thead><tbody><tr><td style="text-align:center;">Operating System</td><td style="text-align:center;">Windows or Linux</td><td style="text-align:center;">-</td><td style="text-align:center;">-</td></tr><tr><td style="text-align:center;">Installation Environment</td><td style="text-align:center;">JDK</td><td style="text-align:center;">Need>=V1.8.0_162 (recommended to use 11 or 17, please choose ARM or x64 installation package according to machine configuration when downloading)</td><td style="text-align:center;"><a href="https://www.oracle.com/java/technologies/downloads/" target="_blank" rel="noopener noreferrer">https://www.oracle.com/java/technologies/downloads/</a></td></tr><tr><td style="text-align:center;">Related Software</td><td style="text-align:center;">Prometheus</td><td style="text-align:center;">Requires installation of V2.30.3 and above.</td><td style="text-align:center;"><a href="https://prometheus.io/download/" target="_blank" rel="noopener noreferrer">https://prometheus.io/download/</a></td></tr><tr><td style="text-align:center;">Database</td><td style="text-align:center;">IoTDB</td><td style="text-align:center;">Requires V1.2.0 Enterprise Edition and above</td><td style="text-align:center;">You can contact business or technical support to obtain</td></tr><tr><td style="text-align:center;">Console</td><td style="text-align:center;">IoTDB-Workbench-<code><version></code></td><td style="text-align:center;">-</td><td style="text-align:center;">You can choose according to the appendix version comparison table and contact business or technical support to obtain it</td></tr></tbody></table><h2 id="installation-steps" tabindex="-1"><a class="header-anchor" href="#installation-steps"><span>Installation Steps</span></a></h2><h3 id="step-1-iotdb-enables-monitoring-indicator-collection" tabindex="-1"><a class="header-anchor" href="#step-1-iotdb-enables-monitoring-indicator-collection"><span>Step 1: IoTDB enables monitoring indicator collection</span></a></h3><ol><li><p>Open the monitoring configuration item. The configuration items related to monitoring in IoTDB are disabled by default. Before deploying the monitoring panel, you need to open the relevant configuration items (note that the service needs to be restarted after enabling monitoring configuration).</p><table><tr><th>Configuration</th><th>Located in the configuration file</th><th>Description</th></tr><tr><td>cn_metric_reporter_list</td><td rowspan="3">conf/iotdb-confignode.properties</td><td>Uncomment the configuration item and set the value to PROMETHEUS</td></tr><tr><td>cn_metric_level</td><td>Uncomment the configuration item and set the value to IMPORTANT</td></tr><tr><td>cn_metric_prometheus_reporter_port</td><td>Uncomment the configuration item to maintain the default setting of 9091. If other ports are set, they will not conflict with each other</td></tr><tr><td>dn_metric_reporter_list</td><td rowspan="4">conf/iotdb-datanode.properties</td><td>Uncomment the configuration item and set the value to PROMETHEUS</td></tr><tr><td>dn_metric_level</td><td>Uncomment the configuration item and set the value to IMPORTANT</td></tr><tr><td>dn_metric_prometheus_reporter_port</td><td>Uncomment the configuration item and set it to 9092 by default. If other ports are set, they will not conflict with each other</td></tr><tr><td>dn_metric_internal_reporter_type</td><td>Uncomment the configuration item and set the value to IOTDB</td></tr><tr><td>enable_audit_log</td><td rowspan="3">conf/iotdb-common.properties</td><td>Uncomment the configuration item and set the value to true</td></tr><tr><td>audit_log_storage</td><td>Uncomment configuration items</td></tr><tr><td>audit_log_operation</td><td>Uncomment configuration items</td></tr></table></li><li><p>Restart all nodes. After modifying the monitoring indicator configuration of three nodes, the confignode and datanode services of all nodes can be restarted:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line">./sbin/stop-standalone.sh <span class="token comment">#Stop confignode and datanode first</span></span> |
| <span class="line">./sbin/start-confignode.sh <span class="token parameter variable">-d</span> <span class="token comment">#Start confignode</span></span> |
| <span class="line">./sbin/start-datanode.sh <span class="token parameter variable">-d</span> <span class="token comment">#Start datanode </span></span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>After restarting, confirm the running status of each node through the client. If the status is Running, it indicates successful configuration:</p><figure><img src="https://alioss.timecho.com/docs/img/启动.PNG" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li></ol><h3 id="step-2-install-and-configure-prometheus" tabindex="-1"><a class="header-anchor" href="#step-2-install-and-configure-prometheus"><span>Step 2: Install and configure Prometheus</span></a></h3><ol><li><p>Download the Prometheus installation package, which requires installation of V2.30.3 and above. You can go to the Prometheus official website to download it (<a href="https://prometheus.io/docs/introduction/first_steps/" target="_blank" rel="noopener noreferrer">https://prometheus.io/docs/introduction/first_steps/</a>)</p></li><li><p>Unzip the installation package and enter the unzipped folder:</p><div class="language-Shell line-numbers-mode" data-highlighter="prismjs" data-ext="Shell" data-title="Shell"><pre><code><span class="line">tar xvfz prometheus-*.tar.gz</span> |
| <span class="line">cd prometheus-*</span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>Modify the configuration. Modify the configuration file prometheus.yml as follows</p><ol><li>Add configNode task to collect monitoring data for ConfigNode</li><li>Add a datanode task to collect monitoring data for DataNodes</li></ol><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line">global:</span> |
| <span class="line">scrape_interval: 15s </span> |
| <span class="line">evaluation_interval: 15s </span> |
| <span class="line">scrape_configs:</span> |
| <span class="line">- job_name: <span class="token string">"prometheus"</span></span> |
| <span class="line"> static_configs:</span> |
| <span class="line"> - targets: <span class="token punctuation">[</span><span class="token string">"localhost:9090"</span><span class="token punctuation">]</span></span> |
| <span class="line">- job_name: <span class="token string">"confignode"</span></span> |
| <span class="line"> static_configs:</span> |
| <span class="line"> - targets: <span class="token punctuation">[</span><span class="token string">"iotdb-1:9091"</span>,<span class="token string">"iotdb-2:9091"</span>,<span class="token string">"iotdb-3:9091"</span><span class="token punctuation">]</span></span> |
| <span class="line"> honor_labels: <span class="token boolean">true</span></span> |
| <span class="line">- job_name: <span class="token string">"datanode"</span></span> |
| <span class="line"> static_configs:</span> |
| <span class="line"> - targets: <span class="token punctuation">[</span><span class="token string">"iotdb-1:9092"</span>,<span class="token string">"iotdb-2:9092"</span>,<span class="token string">"iotdb-3:9092"</span><span class="token punctuation">]</span></span> |
| <span class="line"> honor_labels: <span class="token boolean">true</span></span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>Start Prometheus. The default expiration time for Prometheus monitoring data is 15 days. In production environments, it is recommended to adjust it to 180 days or more to track historical monitoring data for a longer period of time. The startup command is as follows:</p><div class="language-Shell line-numbers-mode" data-highlighter="prismjs" data-ext="Shell" data-title="Shell"><pre><code><span class="line">./prometheus --config.file=prometheus.yml --storage.tsdb.retention.time=180d</span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>Confirm successful startup. Enter in browser <code>http://IP:port</code> Go to Prometheus and click on the Target interface under Status. When you see that all States are Up, it indicates successful configuration and connectivity.</p><div style="display:flex;justify-content:space-between;"><img src="https://alioss.timecho.com/docs/img/启动_1.png" alt="" style="width:50%;"><img src="https://alioss.timecho.com/docs/img/启动_2.png" alt="" style="width:48%;"></div></li></ol><h3 id="step-3-install-workbench" tabindex="-1"><a class="header-anchor" href="#step-3-install-workbench"><span>Step 3: Install Workbench</span></a></h3><h4 id="windows" tabindex="-1"><a class="header-anchor" href="#windows"><span>Windows：</span></a></h4><ol><li><p>Enter the config directory of iotdb Workbench -<code><version></code></p></li><li><p>Modify Workbench configuration file: Go to the <code>config</code> folder and modify the configuration file <code>application-prod.properties</code>. If you are installing it locally, there is no need to modify it. If you are deploying it on a server, you need to modify the IP address</p><blockquote><p>Workbench can be deployed on a local or cloud server as long as it can connect to IoTDB</p></blockquote><table><thead><tr><th>Configuration</th><th>Before Modification</th><th>After modification</th></tr></thead><tbody><tr><td>pipe.callbackUrl</td><td>pipe.callbackUrl=<code>http://127.0.0.1</code></td><td>pipe.callbackUrl=<code>http://<Workbench's IP address></code></td></tr></tbody></table><figure><img src="https://alioss.timecho.com/docs/img/workbench-conf-1.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li><li><p>Startup program: Please execute the startup command in the sbin folder of IoTDB Workbench -<code><version></code></p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token comment"># Start Workbench in the background</span></span> |
| <span class="line">start.bat <span class="token parameter variable">-d</span></span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>You can use the <code>jps</code> command to check if the startup was successful, as shown in the figure:</p><figure><img src="https://alioss.timecho.com/docs/img/windows-jps.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li><li><p>Verification successful: Open "<code>http://Server IP: Port in configuration file</code>" in the browser to access, for example:"<code>http://127.0.0.1:9190</code>" When the login interface appears, it is considered successful</p><figure><img src="https://alioss.timecho.com/docs/img/workbench-en.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li></ol><h4 id="linux" tabindex="-1"><a class="header-anchor" href="#linux"><span>Linux：</span></a></h4><ol><li><p>Enter the IoTDB Workbench -<code><version></code> directory</p></li><li><p>Modify Workbench configuration: Go to the <code>config</code> folder and modify the configuration file <code>application-prod.properties</code>. If you are installing it locally, there is no need to modify it. If you are deploying it on a server, you need to modify the IP address</p><blockquote><p>Workbench can be deployed on a local or cloud server as long as it can connect to IoTDB</p></blockquote><table><thead><tr><th>Configuration</th><th>Before Modification</th><th>After modification</th></tr></thead><tbody><tr><td>pipe.callbackUrl</td><td>pipe.callbackUrl=<code>http://127.0.0.1</code></td><td>pipe.callbackUrl=<code>http://<Workbench's IP address></code></td></tr></tbody></table><figure><img src="https://alioss.timecho.com/docs/img/workbench-conf-1.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li><li><p>Startup program: Please execute the startup command in the sbin folder of IoTDB Workbench -<code><version></code></p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token comment"># Start Workbench in the background</span></span> |
| <span class="line">./start.sh <span class="token parameter variable">-d</span></span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>You can use the <code>jps</code> command to check if the startup was successful, as shown in the figure:</p><figure><img src="https://alioss.timecho.com/docs/img/linux-jps.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li><li><p>Verification successful: Open "<code>http://Server IP: Port in configuration file</code>" in the browser to access, for example:"<code>http://127.0.0.1:9190</code>" When the login interface appears, it is considered successful</p><figure><img src="https://alioss.timecho.com/docs/img/workbench-en.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li></ol><h3 id="step-4-configure-instance-information" tabindex="-1"><a class="header-anchor" href="#step-4-configure-instance-information"><span>Step 4: Configure Instance Information</span></a></h3><ol><li><p>Configure instance information: You only need to fill in the following information to connect to the instance</p><figure><img src="https://alioss.timecho.com/docs/img/workbench-en-1.jpeg" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><table><thead><tr><th>Field Name</th><th>Is It A Required Field</th><th>Field Meaning</th><th>Default Value</th></tr></thead><tbody><tr><td>Connection Type</td><td></td><td>The content filled in for different connection types varies, and supports selecting "single machine, cluster, dual active"</td><td>-</td></tr><tr><td>Instance Name</td><td>Yes</td><td>You can distinguish different instances based on their names, with a maximum input of 50 characters</td><td>-</td></tr><tr><td>Instance</td><td>Yes</td><td>Fill in the database address (<code>dn_rpc_address</code> field in the <code>iotdb/conf/iotdb-datanode.properties</code> file) and port number (<code>dn_rpc_port</code> field). Note: For clusters and dual active devices, clicking the "+" button supports entering multiple instance information</td><td>-</td></tr><tr><td>Prometheus</td><td>No</td><td>Fill in <code>http://<Prometheus IP address>:<Prometheus port number>/app/v1/query</code> to view some monitoring information on the homepage. We recommend that you configure and use it</td><td>-</td></tr><tr><td>Username</td><td>Yes</td><td>Fill in the username for IoTDB, supporting input of 4 to 32 characters, including uppercase and lowercase letters, numbers, and special characters (! @ # $% ^&* () _+-=)</td><td>root</td></tr><tr><td>Enter Password</td><td>No</td><td>Fill in the password for IoTDB. To ensure the security of the database, we will not save the password. Please fill in the password yourself every time you connect to the instance or test</td><td>root</td></tr></tbody></table></li><li><p>Test the accuracy of the information filled in: You can perform a connection test on the instance information by clicking the "Test" button</p><figure><img src="https://alioss.timecho.com/docs/img/workbench-en-2.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure></li></ol><h2 id="appendix-iotdb-and-workbench-version-comparison-table" tabindex="-1"><a class="header-anchor" href="#appendix-iotdb-and-workbench-version-comparison-table"><span>Appendix: IoTDB and Workbench Version Comparison Table</span></a></h2><table><thead><tr><th style="text-align:center;">Workbench Version Number</th><th style="text-align:center;">Release Note</th><th style="text-align:center;">Supports IoTDB Versions</th></tr></thead><tbody><tr><td style="text-align:center;">V1.4.0</td><td style="text-align:center;">New tree model display and internationalization</td><td style="text-align:center;">V1.3.2 and above versions</td></tr><tr><td style="text-align:center;">V1.3.1</td><td style="text-align:center;">New analysis methods have been added to the analysis function, and functions such as optimizing import templates have been optimized</td><td style="text-align:center;">V1.3.2 and above versions</td></tr><tr><td style="text-align:center;">V1.3.0</td><td style="text-align:center;">Add database configuration function</td><td style="text-align:center;">V1.3.2 and above versions</td></tr><tr><td style="text-align:center;">V1.2.6</td><td style="text-align:center;">Optimize the permission control function of each module</td><td style="text-align:center;">V1.3.1 and above versions</td></tr><tr><td style="text-align:center;">V1.2.5</td><td style="text-align:center;">The visualization function has added the concept of "commonly used templates", and all interface optimization and page caching functions have been supplemented</td><td style="text-align:center;">V1.3.0 and above versions</td></tr><tr><td style="text-align:center;">V1.2.4</td><td style="text-align:center;">The calculation function has added the "import and export" function, and the measurement point list has added the "time alignment" field</td><td style="text-align:center;">V1.2.2 and above versions</td></tr><tr><td style="text-align:center;">V1.2.3</td><td style="text-align:center;">New "activation details" and analysis functions added to the homepage</td><td style="text-align:center;">V1.2.2 and above versions</td></tr><tr><td style="text-align:center;">V1.2.2</td><td style="text-align:center;">Optimize the display content and other functions of "measurement point description"</td><td style="text-align:center;">V1.2.2 and above versions</td></tr><tr><td style="text-align:center;">V1.2.1</td><td style="text-align:center;">New "Monitoring Panel" added to the data synchronization interface to optimize Prometheus prompt information</td><td style="text-align:center;">V1.2.2 and above versions</td></tr><tr><td style="text-align:center;">V1.2.0</td><td style="text-align:center;">New Workbench version upgrade</td><td style="text-align:center;">V1.2.0 and above versions</td></tr></tbody></table></div><!----><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment.md" aria-label="Found Error? Edit this page on GitHub" rel="noopener noreferrer" target="_blank"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last update: </span><!----></div><!----></div></footer><!----><!----><!----><!--]--></main><!--]--><!--]--><footer style="padding-bottom:2rem;"><span id="doc-version" style="display:none;">latest</span><p style="text-align:center;color:#909399;font-size:12px;margin:0 30px;">Copyright © 2024 The Apache Software Foundation.<br> Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Have a question?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a> now.</p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-W3EENNaa.js" defer></script> |
| </body> |
| </html> |
