mirror of
https://github.com/apache/druid.git
synced 2025-02-18 16:12:23 +00:00
7dcbaca658
* Spellcheck docs Fix spelling mistakes in docs and add CI job for running spellcheck on docs. * Add missing license header
124 lines
5.0 KiB
Markdown
124 lines
5.0 KiB
Markdown
---
|
|
id: druid-console
|
|
title: "Web console"
|
|
---
|
|
|
|
<!--
|
|
~ Licensed to the Apache Software Foundation (ASF) under one
|
|
~ or more contributor license agreements. See the NOTICE file
|
|
~ distributed with this work for additional information
|
|
~ regarding copyright ownership. The ASF licenses this file
|
|
~ to you under the Apache License, Version 2.0 (the
|
|
~ "License"); you may not use this file except in compliance
|
|
~ with the License. You may obtain a copy of the License at
|
|
~
|
|
~ http://www.apache.org/licenses/LICENSE-2.0
|
|
~
|
|
~ Unless required by applicable law or agreed to in writing,
|
|
~ software distributed under the License is distributed on an
|
|
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
~ KIND, either express or implied. See the License for the
|
|
~ specific language governing permissions and limitations
|
|
~ under the License.
|
|
-->
|
|
|
|
|
|
The Druid Console is hosted by the [Router](../design/router.md) process.
|
|
|
|
In addition, the following cluster settings must be enabled:
|
|
|
|
- the Router's [management proxy](../design/router.html#enabling-the-management-proxy) must be enabled.
|
|
- the Broker processes in the cluster must have [Druid SQL](../querying/sql.md) enabled.
|
|
|
|
After enabling Druid SQL on the Brokers and deploying a Router with the management 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](./management-uis.html#legacy-consoles) should you need them.
|
|
|
|
|
|
|
|
## Data loader
|
|
|
|
The data loader view allows you to load data by building an ingestion spec with a step-by-step wizard.
|
|
|
|
|
|
|
|
After selecting the location 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.
|
|
|
|
|
|
|
|
## 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, configure automatic compaction, and drop data.
|
|
Like any view that is powered by a DruidSQL query you can click `View SQL query for table` from the `...` menu to run the underlying SQL query directly.
|
|
|
|
|
|
|
|
You can view and edit retention rules to determine the general availability of a datasource.
|
|
|
|
|
|
|
|
## Segments
|
|
|
|
The segment view shows all the segments in the cluster.
|
|
Each segment can be 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.
|
|
|
|
|
|
|
|
## Tasks and supervisors
|
|
|
|
From this view you can check the status of existing supervisors as well as suspend, resume, and reset them.
|
|
The tasks table allows you see the currently running and recently completed tasks.
|
|
To make managing a lot of tasks more accessible, you can group the tasks by their `Type`, `Datasource`, or `Status` to make navigation easier.
|
|
|
|
|
|
|
|
Click on the magnifying glass for any supervisor to see detailed reports of its progress.
|
|
|
|
|
|
|
|
Click on the magnifying glass for any task to see more detail about it.
|
|
|
|
|
|
|
|
## Servers
|
|
|
|
The servers tab 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.
|
|
|
|
|
|
|
|
## Query
|
|
|
|
The query view lets you issue [DruidSQL](../querying/sql.md) queries and display the results as a table.
|
|
The view will attempt to infer your query and let you modify via contextual actions such as adding filters and changing the sort order when possible.
|
|
|
|
|
|
|
|
The query view can also issue queries in Druid's [native query format](../querying/querying.md), which is JSON over HTTP.
|
|
To send a native Druid query, you must start your query with `{` and format it as JSON.
|
|
|
|
|
|
|
|
## Lookups
|
|
|
|
You can create and edit query time lookups via the lookup view.
|
|
|
|
|