diff --git a/docs/content/operations/druid-console.md b/docs/content/operations/druid-console.md new file mode 100644 index 00000000000..a6e4a90868e --- /dev/null +++ b/docs/content/operations/druid-console.md @@ -0,0 +1,90 @@ +--- +layout: doc_page +title: "Druid console" +--- + + + +# Druid console + +The Druid Console is hosted by the [Router](../development/router.html) process. + +In addition, the following cluster settings must be enabled: + +- the Router's [management proxy](../development/router.html#enabling-the-management-proxy) must be enabled. +- the Broker processes in the cluster must have [Druid SQL](../querying/sql.html) 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://: +``` + +Below is a description of the high-level features and functionality of the Druid Console + +## Home + +The home view provide 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#legacy-consoles) should you need them. + +![home-view](./img/01-home-view.png) + +## 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](./img/02-datasources.png) + +You can view and edit retention rules to determine the general availability of a datasource. + +![retention](./img/03-retention.png) + +## 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](./img/04-segments.png) + +## 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. + +![tasks-1](./img/05-tasks-1.png) + +The tasks table let’s 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. + +![tasks-2](./img/06-tasks-2.png) + +Since there will likely be a lot of tasks you can group the tasks by their type, datasource, or status to make navigation easier. + +![tasks-3](./img/07-tasks-3.png) + +## 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](./img/08-servers.png) + +## SQL + +The SQL view lets you issue direct DruidSQL queries and display the results as a simple table. Note that despite the name this view also allows you to enter native Druid queries in Hjson format. + +![sql](./img/09-sql.png) + diff --git a/docs/content/operations/img/01-home-view.png b/docs/content/operations/img/01-home-view.png new file mode 100644 index 00000000000..4dbd31db744 Binary files /dev/null and b/docs/content/operations/img/01-home-view.png differ diff --git a/docs/content/operations/img/02-datasources.png b/docs/content/operations/img/02-datasources.png new file mode 100644 index 00000000000..0df697b9332 Binary files /dev/null and b/docs/content/operations/img/02-datasources.png differ diff --git a/docs/content/operations/img/03-retention.png b/docs/content/operations/img/03-retention.png new file mode 100644 index 00000000000..306296d4ec2 Binary files /dev/null and b/docs/content/operations/img/03-retention.png differ diff --git a/docs/content/operations/img/04-segments.png b/docs/content/operations/img/04-segments.png new file mode 100644 index 00000000000..6565912c1f7 Binary files /dev/null and b/docs/content/operations/img/04-segments.png differ diff --git a/docs/content/operations/img/05-tasks-1.png b/docs/content/operations/img/05-tasks-1.png new file mode 100644 index 00000000000..9a184681b2a Binary files /dev/null and b/docs/content/operations/img/05-tasks-1.png differ diff --git a/docs/content/operations/img/06-tasks-2.png b/docs/content/operations/img/06-tasks-2.png new file mode 100644 index 00000000000..3ae5850b82b Binary files /dev/null and b/docs/content/operations/img/06-tasks-2.png differ diff --git a/docs/content/operations/img/07-tasks-3.png b/docs/content/operations/img/07-tasks-3.png new file mode 100644 index 00000000000..178c87e5087 Binary files /dev/null and b/docs/content/operations/img/07-tasks-3.png differ diff --git a/docs/content/operations/img/08-servers.png b/docs/content/operations/img/08-servers.png new file mode 100644 index 00000000000..2754d0eadd3 Binary files /dev/null and b/docs/content/operations/img/08-servers.png differ diff --git a/docs/content/operations/img/09-sql.png b/docs/content/operations/img/09-sql.png new file mode 100644 index 00000000000..b5e844c4ee4 Binary files /dev/null and b/docs/content/operations/img/09-sql.png differ diff --git a/docs/content/operations/management-uis.md b/docs/content/operations/management-uis.md index 8029fd6835d..635d4fe905e 100644 --- a/docs/content/operations/management-uis.md +++ b/docs/content/operations/management-uis.md @@ -43,6 +43,8 @@ http://: The Druid Console contains all of the functionality provided by the older consoles described below, which are still available if needed. The legacy consoles may be replaced by the Druid Console in the future. +For more information on the features of the Druid Console have a look at the [Druid Console overview](./druid-console.html) + ## Legacy Consoles These older consoles provide a subset of the functionality of the Druid Console. We recommend using the Druid Console if possible.