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.
Enable the following cluster settings to use the web console. Note that these settings are enabled by default.
The Router service hosts the web console. Access the web console at the following address:
http://<ROUTER_IP>:<ROUTER_PORT>
:::info Security note: Without Druid user permissions 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. :::
This topic presents the high-level features and functionality of the web console.
The Home view provides a high-level overview of the cluster. Each card is clickable and links to the appropriate view.
The Home view displays the following cards:
You can access the data loader and lookups view from the top-level navigation of the Home view.
SQL-based ingestion and the multi-stage query task engine use the Query 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.
The following screenshot shows a populated enhanced Query view along with a description of its parts:
#query
in the URL. You can tell that you're looking at the updated Query view by the presence of the tabs (3).EXTERN
definition that you can then edit as needed.type='query_controller'
.EXPLAIN PLAN FOR
for a SQL query.You can use the data loader to build an ingestion spec with a step-by-step wizard.
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 Next. You can also freely navigate between the steps from the top navigation.
Navigating with the top navigation leaves the underlying spec unmodified while clicking Next attempts to fill in the subsequent steps with appropriate defaults.
The Datasources view shows all the datasources currently loaded on the cluster, as well as their sizes and availability. From the Datasources view, you can edit the retention rules, configure automatic compaction, and drop data in a datasource.
A datasource is partitioned into one or more segments organized by time chunks. To display a timeline of segments, toggle the option for Show segment timeline.
Like any view that is powered by a Druid SQL query, you can click View SQL query for table from the ellipsis menu to run the underlying SQL query directly.
You can view and edit retention rules to determine the general availability of a datasource.
The Segments view shows all the segments 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.
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 Submit JSON supervisor.
Click the magnifying glass icon for any supervisor to see detailed reports of its progress.
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 Type, Datasource, or Status. Submit a task manually by clicking the ellipsis icon and selecting Submit JSON task.
Click the magnifying glass icon for any task to see more detail about it.
The Services view lets you see the current status of the nodes making up your cluster. You can group the nodes by Type or by Tier to get meaningful summary statistics.
Access the Lookups view from the Lookups card in the home view or by clicking the ellipsis icon in the top-level navigation. Here you can create and edit query time lookups.