This is an automated email from the ASF dual-hosted git repository.
cwylie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-druid.git
The following commit(s) were added to refs/heads/master by this push:
new e4f2dca Druid console docs (#7300)
e4f2dca is described below
commit e4f2dcacf25406bde7476d7eef2b1abdb8047e68
Author: Vadim Ogievetsky <[email protected]>
AuthorDate: Thu Mar 21 00:37:33 2019 -0700
Druid console docs (#7300)
* console docs
* fix typo
---
docs/content/operations/druid-console.md | 90 +++++++++++++++++++++++++
docs/content/operations/img/01-home-view.png | Bin 0 -> 60287 bytes
docs/content/operations/img/02-datasources.png | Bin 0 -> 163824 bytes
docs/content/operations/img/03-retention.png | Bin 0 -> 123857 bytes
docs/content/operations/img/04-segments.png | Bin 0 -> 125873 bytes
docs/content/operations/img/05-tasks-1.png | Bin 0 -> 101635 bytes
docs/content/operations/img/06-tasks-2.png | Bin 0 -> 221977 bytes
docs/content/operations/img/07-tasks-3.png | Bin 0 -> 195170 bytes
docs/content/operations/img/08-servers.png | Bin 0 -> 119310 bytes
docs/content/operations/img/09-sql.png | Bin 0 -> 80580 bytes
docs/content/operations/management-uis.md | 2 +
11 files changed, 92 insertions(+)
diff --git a/docs/content/operations/druid-console.md
b/docs/content/operations/druid-console.md
new file mode 100644
index 0000000..a6e4a90
--- /dev/null
+++ b/docs/content/operations/druid-console.md
@@ -0,0 +1,90 @@
+---
+layout: doc_page
+title: "Druid 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.
+ -->
+
+# 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://<ROUTER_IP>:<ROUTER_PORT>
+```
+
+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.
+
+
+
+## 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.
+
+
+
+You can view and edit retention rules to determine the general availability of
a datasource.
+
+
+
+## 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.
+
+
+
+## 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.
+
+
+
+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.
+
+
+
+Since there will likely be a lot of tasks you can group the tasks by their
type, datasource, or status to make navigation easier.
+
+
+
+## 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.
+
+
+
+## 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.
+
+
+
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 0000000..4dbd31d
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 0000000..0df697b
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 0000000..306296d
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 0000000..6565912
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 0000000..9a18468
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 0000000..3ae5850
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 0000000..178c87e
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 0000000..2754d0e
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 0000000..b5e844c
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 8029fd6..635d4fe 100644
--- a/docs/content/operations/management-uis.md
+++ b/docs/content/operations/management-uis.md
@@ -43,6 +43,8 @@ http://<ROUTER_IP>:<ROUTER_PORT>
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.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
