| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-operations/web-console"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v2.4.1"> |
| <title data-rh="true">Web console | Apache® Druid</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://druid.apache.org/img/druid_nav.png"><meta data-rh="true" name="twitter:image" content="https://druid.apache.org/img/druid_nav.png"><meta data-rh="true" property="og:url" content="https://druid.apache.org/docs/latest/operations/web-console"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Web console | Apache® Druid"><meta data-rh="true" name="description" content="<!--"><meta data-rh="true" property="og:description" content="<!--"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://druid.apache.org/docs/latest/operations/web-console"><link data-rh="true" rel="alternate" href="https://druid.apache.org/docs/latest/operations/web-console" hreflang="en"><link data-rh="true" rel="alternate" href="https://druid.apache.org/docs/latest/operations/web-console" hreflang="x-default"><link rel="preconnect" href="https://www.google-analytics.com"> |
| <link rel="preconnect" href="https://www.googletagmanager.com"> |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-131010415-1"></script> |
| <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","UA-131010415-1",{})</script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css"> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js"></script><link rel="stylesheet" href="/assets/css/styles.546f39eb.css"> |
| <link rel="preload" href="/assets/js/runtime~main.4c9a7172.js" as="script"> |
| <link rel="preload" href="/assets/js/main.3a5ab01b.js" as="script"> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top navbar--dark"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/druid_nav.png" alt="Apache® Druid" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/druid_nav.png" alt="Apache® Druid" class="themedImage_ToTc themedImage--dark_i4oU"></div></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/technology">Technology</a><a class="navbar__item navbar__link" href="/use-cases">Use Cases</a><a class="navbar__item navbar__link" href="/druid-powered">Powered By</a><a class="navbar__item navbar__link" href="/docs/latest/design/">Docs</a><a class="navbar__item navbar__link" href="/community/">Community</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Apache®</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://apachecon.com/?ref=druid.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><a class="navbar__item navbar__link" href="/downloads/">Download</a><div class="searchBox_ZlJk"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/design/">Getting started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/tutorials/tutorial-msq-extern">Tutorials</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/design/architecture">Design</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/ingestion/">Ingestion</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/data-management/">Data management</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/querying/sql">Querying</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/api-reference/">API reference</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/configuration/">Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/latest/operations/web-console">Operations</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/latest/operations/web-console">Web console</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/java">Java runtime</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/durable-storage">Durable storage</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/latest/operations/security-overview">Security</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/latest/operations/basic-cluster-tuning">Performance tuning</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/latest/operations/request-logging">Monitoring</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/high-availability">High availability</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/rolling-updates">Rolling updates</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/rule-configuration">Using rules to drop and retain data</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/migrate-from-firehose">Migrate from firehose</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/other-hadoop">Working with different versions of Apache Hadoop</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/latest/operations/dump-segment">Misc</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/development/overview">Development</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/latest/misc/papers-and-talks">Misc</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Operations</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Web console</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Web console</h1></header><p>Druid includes a web console for loading data, managing datasources and tasks, and viewing server status and segment information. |
| You can also run SQL and native Druid queries in the console.</p><p>Enable the following cluster settings to use the web console. Note that these settings are enabled by default.</p><ul><li>Enable the Router's <a href="/docs/latest/design/router#enabling-the-management-proxy">management proxy</a>.</li><li>Enable <a href="/docs/latest/configuration/#sql">Druid SQL</a> for the Broker processes in the cluster.</li></ul><p>The <a href="/docs/latest/design/router">Router</a> service hosts the web console. |
| Access the web console at the following address:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">http://<ROUTER_IP>:<ROUTER_PORT></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><div class="theme-admonition theme-admonition-info alert alert--info admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_S0QG"><p> <strong>Security note:</strong> Without <a href="/docs/latest/operations/security-overview">Druid user permissions</a> configured, any user of the |
| API or web console has effectively the same level of access to local files and network services as the user under which |
| Druid runs. It is a best practice to avoid running Druid as the root user, and to use Druid permissions or network |
| firewalls to restrict which users have access to potentially sensitive resources.</p></div></div><p>This topic presents the high-level features and functionality of the web console.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="home">Home<a href="#home" class="hash-link" aria-label="Direct link to Home" title="Direct link to Home"></a></h2><p>The <strong>Home</strong> view provides a high-level overview of the cluster. |
| Each card is clickable and links to the appropriate view.</p><p>The <strong>Home</strong> view displays the following cards:</p><ul><li><strong>Status</strong>. Click this card for information on the Druid version and any extensions loaded on the cluster.</li><li><a href="#datasources">Datasources</a></li><li><a href="#segments">Segments</a></li><li><a href="#supervisors">Supervisors</a></li><li><a href="#tasks">Tasks</a></li><li><a href="#services">Services</a></li><li><a href="#lookups">Lookups</a></li></ul><p>You can access the <a href="#data-loader">data loader</a> and <a href="#lookups">lookups view</a> from the top-level navigation of the <strong>Home</strong> view.</p><p><img loading="lazy" alt="Web console home view" src="/assets/images/web-console-01-home-view-99f09e8760740e04b982b4d4c56fe6ed.png" title="home view" width="1250" height="840" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="query">Query<a href="#query" class="hash-link" aria-label="Direct link to Query" title="Direct link to Query"></a></h2><p>SQL-based ingestion and the multi-stage query task engine use the <strong>Query</strong> view, which provides you with a UI to edit and use SQL queries. You should see this UI automatically in Druid 24.0 and later since the multi-stage query extension is loaded by default. </p><p>The following screenshot shows a populated enhanced <strong>Query</strong> view along with a description of its parts:</p><p><img loading="lazy" alt="Annotated multi-stage Query view" src="/assets/images/ui-annotated-7932933ce7ad968aa0f5e3ef2aeca5e0.png" width="1250" height="740" class="img_ev3q"></p><ol><li>The multi-stage, tab-enabled, <strong>Query</strong> view is where you can issue queries and see results. |
| All other views are unchanged from the non-enhanced version. You can still access the original <strong>Query</strong> view by navigating to <code>#query</code> in the URL. |
| You can tell that you're looking at the updated <strong>Query</strong> view by the presence of the tabs (3).</li><li>The <strong>druid</strong> panel shows the available schemas, datasources, and columns.</li><li>Query tabs allow you to manage and run several queries at once. |
| Click the plus icon to open a new tab. |
| To manipulate existing tabs, click the tab name.</li><li>The tab bar contains some helpful tools including the <strong>Connect external data</strong> button that samples external data and creates an initial query with the appropriate <code>EXTERN</code> definition that you can then edit as needed.</li><li>The <strong>Recent query tasks</strong> panel lets you see currently running and previous queries from all users in the cluster. |
| It is equivalent to the <strong>Task</strong> view in the <strong>Ingestion</strong> view with the filter of <code>type='query_controller'</code>.</li><li>You can click on each query entry to attach to that query in a new tab.</li><li>You can download an archive of all the pertinent details about the query that you can share.</li><li>The <strong>Run</strong> button runs the query.</li><li>The <strong>Preview</strong> button appears when you enter an INSERT/REPLACE query. It runs the query inline without the INSERT/REPLACE clause and with an added LIMIT to give you a preview of the data that would be ingested if you click <strong>Run</strong>. |
| The added LIMIT makes the query run faster but provides incomplete results.</li><li>The engine selector lets you choose which engine (API endpoint) to send a query to. By default, it automatically picks which endpoint to use based on an analysis of the query, but you can select a specific engine explicitly. You can also configure the engine specific context parameters from this menu.</li><li>The <strong>Max tasks</strong> picker appears when you have the <strong>sql-msq-task</strong> engine selected. It lets you configure the degree of parallelism.</li><li>The More menu (<strong>...</strong>) contains the following helpful tools:</li></ol><ul><li><strong>Explain SQL query</strong> shows you the logical plan returned by <code>EXPLAIN PLAN FOR</code> for a SQL query.</li><li><strong>Query history</strong> shows you previously executed queries.</li><li><strong>Convert ingestion spec to SQL</strong> lets you convert a native batch ingestion spec to an equivalent SQL query.</li><li><strong>Attach tab from task ID</strong> lets you create a new tab from the task ID of a query executed on this cluster.</li><li><strong>Open query detail archive</strong> lets you open a detail archive generated on any cluster by (7).</li></ul><ol start="13"><li>The query timer indicates how long the query has been running for.</li><li>The <strong>(cancel)</strong> link cancels the currently running query.</li><li>The main progress bar shows the overall progress of the query. |
| The progress is computed from the various counters in the live reports (16).</li><li>The <strong>Current stage</strong> progress bar shows the progress for the currently running query stage. |
| If several stages are executing concurrently, it conservatively shows the information for the earliest executing stage.</li><li>The live query reports show detailed information of all the stages (past, present, and future). The live reports are shown while the query is running. You can hide the report if you want. |
| After queries finish, you can access them by clicking on the query time indicator or from the <strong>Recent query tasks</strong> panel (6).</li><li>You can expand each stage of the live query report by clicking on the triangle to show per worker and per partition statistics.</li></ol><h2 class="anchor anchorWithStickyNavbar_LWe7" id="data-loader">Data loader<a href="#data-loader" class="hash-link" aria-label="Direct link to Data loader" title="Direct link to Data loader"></a></h2><p>You can use the data loader to build an ingestion spec with a step-by-step wizard.</p><p><img loading="lazy" alt="Data loader tiles" src="/assets/images/web-console-02-data-loader-1-fcc691fda096b9d9fb00f9a5cd30293f.png" width="1250" height="840" class="img_ev3q"></p><p>After selecting the location of your data, follow the series of steps displaying incremental previews of the data as it is ingested. |
| After filling in the required details on every step you can navigate to the next step by clicking <strong>Next</strong>. |
| You can also freely navigate between the steps from the top navigation.</p><p>Navigating with the top navigation leaves the underlying spec unmodified while clicking <strong>Next</strong> attempts to fill in the subsequent steps with appropriate defaults.</p><p><img loading="lazy" alt="Data loader ingestion" src="/assets/images/web-console-03-data-loader-2-6eb770d4034261a96b968deb305f1258.png" width="1250" height="840" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="datasources">Datasources<a href="#datasources" class="hash-link" aria-label="Direct link to Datasources" title="Direct link to Datasources"></a></h2><p>The <strong>Datasources</strong> view shows all the datasources currently loaded on the cluster, as well as their sizes and availability. |
| From the <strong>Datasources</strong> view, you can edit the retention rules, configure automatic compaction, and drop data in a datasource.</p><p>A datasource is partitioned into one or more segments organized by time chunks. |
| To display a timeline of segments, toggle the option for <strong>Show segment timeline</strong>.</p><p>Like any view that is powered by a Druid SQL query, you can click <strong>View SQL query for table</strong> from the ellipsis menu to run the underlying SQL query directly.</p><p><img loading="lazy" alt="Datasources" src="/assets/images/web-console-04-datasources-d0ac928b0107a903b7c99fd8dff2fc39.png" width="1250" height="840" class="img_ev3q"></p><p>You can view and edit retention rules to determine the general availability of a datasource.</p><p><img loading="lazy" alt="Retention" src="/assets/images/web-console-05-retention-e5f87124a1e9c252043a45b84a6039ed.png" width="1250" height="840" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="segments">Segments<a href="#segments" class="hash-link" aria-label="Direct link to Segments" title="Direct link to Segments"></a></h2><p>The <strong>Segments</strong> view shows all the <a href="/docs/latest/design/segments">segments</a> in the cluster. |
| Each segment has a detail view that provides more information. |
| The Segment ID is also conveniently broken down into Datasource, Start, End, Version, and Partition columns for ease of filtering and sorting.</p><p><img loading="lazy" alt="Segments" src="/assets/images/web-console-06-segments-2a1f30ad959f3af6b5bbe9818f29674d.png" width="1250" height="840" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="supervisors">Supervisors<a href="#supervisors" class="hash-link" aria-label="Direct link to Supervisors" title="Direct link to Supervisors"></a></h2><p>From this view, you can check the status of existing supervisors as well as suspend, resume, and reset them. |
| The supervisor oversees the state of the indexing tasks to coordinate handoffs, manage failures, and ensure that the scalability and replication requirements are maintained. Submit a supervisor spec manually by clicking the ellipsis icon and selecting <strong>Submit JSON supervisor</strong>.</p><p><img loading="lazy" alt="Supervisors" src="/assets/images/web-console-07-supervisors-dc27d65a42df39922d4ad9cff556faf8.png" width="1250" height="840" class="img_ev3q"></p><p>Click the magnifying glass icon for any supervisor to see detailed reports of its progress.</p><p><img loading="lazy" alt="Supervisors status" src="/assets/images/web-console-08-supervisor-status-07ece8b3920e682c3264c779053801a0.png" width="1250" height="840" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="tasks">Tasks<a href="#tasks" class="hash-link" aria-label="Direct link to Tasks" title="Direct link to Tasks"></a></h2><p>The tasks table allows you to see the currently running and recently completed tasks. |
| To navigate your tasks more easily, you can group them by their <strong>Type</strong>, <strong>Datasource</strong>, or <strong>Status</strong>. |
| Submit a task manually by clicking the ellipsis icon and selecting <strong>Submit JSON task</strong>.</p><p><img loading="lazy" alt="Tasks" src="/assets/images/web-console-0.7-tasks-d53bfa761253b59a0bd368825f8b5c48.png" width="1250" height="840" class="img_ev3q"></p><p>Click the magnifying glass icon for any task to see more detail about it.</p><p><img loading="lazy" alt="Tasks status" src="/assets/images/web-console-09-task-status-3bc2b07f8ebe5dca9d6259d011b97d47.png" width="1250" height="840" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="services">Services<a href="#services" class="hash-link" aria-label="Direct link to Services" title="Direct link to Services"></a></h2><p>The <strong>Services</strong> view lets you see the current status of the nodes making up your cluster. |
| You can group the nodes by <strong>Type</strong> or by <strong>Tier</strong> to get meaningful summary statistics. </p><p><img loading="lazy" alt="Services" src="/assets/images/web-console-10-servers-a6657c30723d278409d8d884d3655ed1.png" width="1250" height="840" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="lookups">Lookups<a href="#lookups" class="hash-link" aria-label="Direct link to Lookups" title="Direct link to Lookups"></a></h2><p>Access the <strong>Lookups</strong> view from the <strong>Lookups</strong> card in the home view or by clicking the ellipsis icon in the top-level navigation. |
| Here you can create and edit query time <a href="/docs/latest/querying/lookups">lookups</a>.</p><p><img loading="lazy" alt="Lookups" src="/assets/images/web-console-13-lookups-337b7e84ed82f5580448a5ba083f91c1.png" width="1250" height="840" class="img_ev3q"></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/latest/configuration/logging"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Logging</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/latest/operations/java"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Java runtime</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#home" class="table-of-contents__link toc-highlight">Home</a></li><li><a href="#query" class="table-of-contents__link toc-highlight">Query</a></li><li><a href="#data-loader" class="table-of-contents__link toc-highlight">Data loader</a></li><li><a href="#datasources" class="table-of-contents__link toc-highlight">Datasources</a></li><li><a href="#segments" class="table-of-contents__link toc-highlight">Segments</a></li><li><a href="#supervisors" class="table-of-contents__link toc-highlight">Supervisors</a></li><li><a href="#tasks" class="table-of-contents__link toc-highlight">Tasks</a></li><li><a href="#services" class="table-of-contents__link toc-highlight">Services</a></li><li><a href="#lookups" class="table-of-contents__link toc-highlight">Lookups</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/favicon.png" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/favicon.png" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></div><div class="footer__copyright">Copyright © 2023 Apache Software Foundation. Except where otherwise noted, licensed under CC BY-SA 4.0. Apache Druid, Druid, and the Druid logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</div></div></div></footer></div> |
| <script src="/assets/js/runtime~main.4c9a7172.js"></script> |
| <script src="/assets/js/main.3a5ab01b.js"></script> |
| </body> |
| </html> |
