You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by cw...@apache.org on 2019/09/14 03:09:18 UTC

[incubator-druid] branch 0.16.0-incubating updated: Web console: Update web console docs for 0.16.0 (#8530) (#8540)

This is an automated email from the ASF dual-hosted git repository.

cwylie pushed a commit to branch 0.16.0-incubating
in repository https://gitbox.apache.org/repos/asf/incubator-druid.git


The following commit(s) were added to refs/heads/0.16.0-incubating by this push:
     new d797ff2  Web console: Update web console docs for 0.16.0 (#8530) (#8540)
d797ff2 is described below

commit d797ff22678c6914fca3149a645171ad635be5ad
Author: Clint Wylie <cw...@apache.org>
AuthorDate: Fri Sep 13 20:09:06 2019 -0700

    Web console: Update web console docs for 0.16.0 (#8530) (#8540)
    
    * Update webconsole docs
    
    * home view
    
    * fix annotation typo
---
 docs/assets/web-console-01-home-view.png         | Bin 58587 -> 62928 bytes
 docs/assets/web-console-02-data-loader-1.png     | Bin 68576 -> 80587 bytes
 docs/assets/web-console-03-data-loader-2.png     | Bin 456607 -> 280137 bytes
 docs/assets/web-console-04-datasources.png       | Bin 178133 -> 113501 bytes
 docs/assets/web-console-05-retention.png         | Bin 173350 -> 99148 bytes
 docs/assets/web-console-06-segments.png          | Bin 209772 -> 136070 bytes
 docs/assets/web-console-07-supervisors.png       | Bin 120310 -> 77637 bytes
 docs/assets/web-console-08-supervisor-status.png | Bin 0 -> 82538 bytes
 docs/assets/web-console-08-tasks.png             | Bin 64362 -> 0 bytes
 docs/assets/web-console-09-task-status.png       | Bin 94299 -> 251600 bytes
 docs/assets/web-console-10-servers.png           | Bin 79421 -> 92508 bytes
 docs/assets/web-console-11-query-sql.png         | Bin 111209 -> 136714 bytes
 docs/assets/web-console-12-query-rune.png        | Bin 137679 -> 94341 bytes
 docs/assets/web-console-13-lookups.png           | Bin 54480 -> 56556 bytes
 docs/operations/druid-console.md                 |  31 +++++++++++++++--------
 15 files changed, 20 insertions(+), 11 deletions(-)

diff --git a/docs/assets/web-console-01-home-view.png b/docs/assets/web-console-01-home-view.png
index 6fb3cf5..8388636 100644
Binary files a/docs/assets/web-console-01-home-view.png and b/docs/assets/web-console-01-home-view.png differ
diff --git a/docs/assets/web-console-02-data-loader-1.png b/docs/assets/web-console-02-data-loader-1.png
index 1cda146..64c5189 100644
Binary files a/docs/assets/web-console-02-data-loader-1.png and b/docs/assets/web-console-02-data-loader-1.png differ
diff --git a/docs/assets/web-console-03-data-loader-2.png b/docs/assets/web-console-03-data-loader-2.png
index 0e327b3..ab3aad5 100644
Binary files a/docs/assets/web-console-03-data-loader-2.png and b/docs/assets/web-console-03-data-loader-2.png differ
diff --git a/docs/assets/web-console-04-datasources.png b/docs/assets/web-console-04-datasources.png
index a2b18b5..267c175 100644
Binary files a/docs/assets/web-console-04-datasources.png and b/docs/assets/web-console-04-datasources.png differ
diff --git a/docs/assets/web-console-05-retention.png b/docs/assets/web-console-05-retention.png
index 7601d58..409a624 100644
Binary files a/docs/assets/web-console-05-retention.png and b/docs/assets/web-console-05-retention.png differ
diff --git a/docs/assets/web-console-06-segments.png b/docs/assets/web-console-06-segments.png
index a2dc7bf..8b6bd83 100644
Binary files a/docs/assets/web-console-06-segments.png and b/docs/assets/web-console-06-segments.png differ
diff --git a/docs/assets/web-console-07-supervisors.png b/docs/assets/web-console-07-supervisors.png
index 41901a9..9d20b32 100644
Binary files a/docs/assets/web-console-07-supervisors.png and b/docs/assets/web-console-07-supervisors.png differ
diff --git a/docs/assets/web-console-08-supervisor-status.png b/docs/assets/web-console-08-supervisor-status.png
new file mode 100644
index 0000000..42625c2
Binary files /dev/null and b/docs/assets/web-console-08-supervisor-status.png differ
diff --git a/docs/assets/web-console-08-tasks.png b/docs/assets/web-console-08-tasks.png
deleted file mode 100644
index 124d8fc..0000000
Binary files a/docs/assets/web-console-08-tasks.png and /dev/null differ
diff --git a/docs/assets/web-console-09-task-status.png b/docs/assets/web-console-09-task-status.png
index 3002818..1731b62 100644
Binary files a/docs/assets/web-console-09-task-status.png and b/docs/assets/web-console-09-task-status.png differ
diff --git a/docs/assets/web-console-10-servers.png b/docs/assets/web-console-10-servers.png
index 20947c4..a0df368 100644
Binary files a/docs/assets/web-console-10-servers.png and b/docs/assets/web-console-10-servers.png differ
diff --git a/docs/assets/web-console-11-query-sql.png b/docs/assets/web-console-11-query-sql.png
index c69977a..9b7ead5 100644
Binary files a/docs/assets/web-console-11-query-sql.png and b/docs/assets/web-console-11-query-sql.png differ
diff --git a/docs/assets/web-console-12-query-rune.png b/docs/assets/web-console-12-query-rune.png
index 27b09a6..f980cb5 100644
Binary files a/docs/assets/web-console-12-query-rune.png and b/docs/assets/web-console-12-query-rune.png differ
diff --git a/docs/assets/web-console-13-lookups.png b/docs/assets/web-console-13-lookups.png
index ce1895d..b284d19 100644
Binary files a/docs/assets/web-console-13-lookups.png and b/docs/assets/web-console-13-lookups.png differ
diff --git a/docs/operations/druid-console.md b/docs/operations/druid-console.md
index bc6b140..8c03061 100644
--- a/docs/operations/druid-console.md
+++ b/docs/operations/druid-console.md
@@ -40,7 +40,9 @@ Below is a description of the high-level features and functionality of the Druid
 
 ## 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.
+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.
 
 ![home-view](../assets/web-console-01-home-view.png)
 
@@ -50,7 +52,7 @@ The data loader view allows you to load data by building an ingestion spec with
 
 ![data-loader-1](../assets/web-console-02-data-loader-1.png)
 
-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 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.
 
@@ -60,8 +62,10 @@ Navigating with the top navigation will leave the underlying spec unmodified whi
 
 ## 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.
+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.
 
 ![datasources](../assets/web-console-04-datasources.png)
 
@@ -71,20 +75,23 @@ You can view and edit retention rules to determine the general availability of a
 
 ## 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.
+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.
 
 ![segments](../assets/web-console-06-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.
+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.
 
 ![supervisors](../assets/web-console-07-supervisors.png)
 
-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.
+Click on the magnifying glass for any supervisor to see detailed reports of its progress.
 
-![tasks](../assets/web-console-08-tasks.png)
+![supervisor-status](../assets/web-console-08-supervisor-status.png)
 
 Click on the magnifying glass for any task to see more detail about it.
 
@@ -92,13 +99,15 @@ Click on the magnifying glass for any task to see more detail about it.
 
 ## 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.
+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. 
 
 ![servers](../assets/web-console-10-servers.png)
 
 ## Query
 
-The query view lets you issue [DruidSQL](../querying/sql.md) queries and display the results as a simple table.
+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.
 
 ![query-sql](../assets/web-console-11-query-sql.png)
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org