druid/docs/operations/druid-console.md

5.0 KiB

id title
druid-console Web console

The Druid Console is hosted by the Router process.

In addition, the following cluster settings must be enabled:

After enabling Druid SQL on the Brokers and deploying a Router with the managment proxy enabled, the Druid console can be accessed at:

http://<ROUTER_IP>:<ROUTER_PORT>

Below is a description of the high-level features and functionality of the Druid Console

Home

The home view provides a high level overview of the cluster. Each card is clickable and links to the appropriate view. The legacy menu allows you to go to the legacy coordinator and overlord consoles should you need them.

home-view

Data loader

The data loader view allows you to load data by building an ingestion spec with a step-by-step wizard.

data-loader-1

After picking the source of your data just follow the series for steps that will show you incremental previews of the data as it will be ingested. After filling in the required details on every step you can navigate to the next step by clicking the Next button. You can also freely navigate between the steps from the top navigation.

Navigating with the top navigation will leave the underlying spec unmodified while clicking the Next button will attempt to fill in the subsequent steps with appropriate defaults.

data-loader-2

Datasources

The datasources view shows all the currently enabled datasources. From this view you can see the sizes and availability of the different datasources. You can edit the retention rules and drop data (as well as issue kill tasks). Like any view that is powered by a DruidSQL query you can click “Go to SQL” to run the underlying SQL query directly.

datasources

You can view and edit retention rules to determine the general availability of a datasource.

retention

Segments

The segment view shows every single segment in the cluster. Each segment can be expanded to provide more information. The Segment ID is also conveniently broken down into Datasource, Start, End, Version, and Partition columns for ease of filtering and sorting.

segments

Tasks and supervisors

The task view is also the home of supervisors. From this view you can check the status of existing supervisors as well as suspend and resume them. You can also submit new supervisors by entering their JSON spec.

supervisors

The tasks table allows you see the currently running and recently completed tasks. From this table you can monitor individual tasks and also submit new tasks by entering their JSON spec. To make managing a lot of tasks more accessible, you can group the tasks by their type, datasource, or status to make navigation easier.

tasks

Click on the magnifying glass for any task to see more detail about it.

tasks-status

Servers

The data servers tab lets you see the current status of the historical nodes and MiddleManager (indexer) processes. Note that currently only historical nodes that are actively serving segments will be shown in this view.

servers

Query

The query view lets you issue DruidSQL queries and display the results as a simple table.

query-sql

The query view can also issue queries in Druid's native query format, which is JSON over HTTP. To send a native Druid query, you must start your query with { and format it as JSON.

query-rune

Lookups

You can create and edit query time lookups via the lookup view.

lookups