You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by fj...@apache.org on 2019/05/21 18:30:53 UTC

[incubator-druid] branch 0.15.0-incubating updated: Update Druid Console docs for 0.15.0 (#7697) (#7720)

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

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


The following commit(s) were added to refs/heads/0.15.0-incubating by this push:
     new 7266e47  Update Druid Console docs for 0.15.0 (#7697) (#7720)
7266e47 is described below

commit 7266e4708e0fb3eb156438657c96db5a2ce25d75
Author: Clint Wylie <cj...@gmail.com>
AuthorDate: Tue May 21 11:30:47 2019 -0700

    Update Druid Console docs for 0.15.0 (#7697) (#7720)
    
    * Update Druid Console docs for 0.15.0
    
    * SQL -> query
    
    * added links and fix typos
---
 docs/content/operations/druid-console.md         |  48 +++++++++++++++++------
 docs/content/operations/img/01-home-view.png     | Bin 60287 -> 58587 bytes
 docs/content/operations/img/02-data-loader-1.png | Bin 0 -> 68576 bytes
 docs/content/operations/img/02-datasources.png   | Bin 163824 -> 0 bytes
 docs/content/operations/img/03-data-loader-2.png | Bin 0 -> 456607 bytes
 docs/content/operations/img/03-retention.png     | Bin 123857 -> 0 bytes
 docs/content/operations/img/04-datasources.png   | Bin 0 -> 178133 bytes
 docs/content/operations/img/04-segments.png      | Bin 125873 -> 0 bytes
 docs/content/operations/img/05-retention.png     | Bin 0 -> 173350 bytes
 docs/content/operations/img/05-tasks-1.png       | Bin 101635 -> 0 bytes
 docs/content/operations/img/06-segments.png      | Bin 0 -> 209772 bytes
 docs/content/operations/img/06-tasks-2.png       | Bin 221977 -> 0 bytes
 docs/content/operations/img/07-supervisors.png   | Bin 0 -> 120310 bytes
 docs/content/operations/img/07-tasks-3.png       | Bin 195170 -> 0 bytes
 docs/content/operations/img/08-servers.png       | Bin 119310 -> 0 bytes
 docs/content/operations/img/08-tasks.png         | Bin 0 -> 64362 bytes
 docs/content/operations/img/09-sql-1.png         | Bin 80580 -> 0 bytes
 docs/content/operations/img/09-task-status.png   | Bin 0 -> 94299 bytes
 docs/content/operations/img/10-servers.png       | Bin 0 -> 79421 bytes
 docs/content/operations/img/10-sql-2.png         | Bin 179193 -> 0 bytes
 docs/content/operations/img/11-query-sql.png     | Bin 0 -> 111209 bytes
 docs/content/operations/img/12-query-rune.png    | Bin 0 -> 137679 bytes
 docs/content/operations/img/13-lookups.png       | Bin 0 -> 54480 bytes
 23 files changed, 35 insertions(+), 13 deletions(-)

diff --git a/docs/content/operations/druid-console.md b/docs/content/operations/druid-console.md
index c8b0696..3dbc491 100644
--- a/docs/content/operations/druid-console.md
+++ b/docs/content/operations/druid-console.md
@@ -45,49 +45,71 @@ The home view provides a high level overview of the cluster. Each card is clicka
 
 ![home-view](./img/01-home-view.png)
 
+## 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](./img/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 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](./img/03-data-loader-2.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)
+![datasources](./img/04-datasources.png)
 
 You can view and edit retention rules to determine the general availability of a datasource.
 
-![retention](./img/03-retention.png)
+![retention](./img/05-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)
+![segments](./img/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.
 
-![tasks-1](./img/05-tasks-1.png)
+![supervisors](./img/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.
 
-![tasks-2](./img/06-tasks-2.png)
+![tasks](./img/08-tasks.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.
+Click on the magnifying glass for any task to see more detail about it.
 
-![tasks-3](./img/07-tasks-3.png)
+![tasks-status](./img/09-task-status.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)
+![servers](./img/10-servers.png)
+
+## Query
+
+The query view lets you issue [DruidSQL](../querying/sql.html) queries and display the results as a simple table.
+
+![query-sql](./img/11-query-sql.png)
 
-## SQL
+The query view can also issue queries in Druid's [native query format](../querying/querying.html), which is JSON over HTTP.
+To send a native Druid query, you must start your query with `{` and format it as JSON.
 
-The SQL view lets you issue direct DruidSQL queries and display the results as a simple table.
+![query-rune](./img/12-query-rune.png)
 
-![sql](./img/09-sql-1.png)
+## Lookups
 
-The SQL 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 in the format of JSON.
+You can create and edit query time lookups via the lookup view.
 
-![sql](./img/10-sql-2.png)
+![lookups](./img/13-lookups.png)
diff --git a/docs/content/operations/img/01-home-view.png b/docs/content/operations/img/01-home-view.png
index 4dbd31d..6fb3cf5 100644
Binary files a/docs/content/operations/img/01-home-view.png and b/docs/content/operations/img/01-home-view.png differ
diff --git a/docs/content/operations/img/02-data-loader-1.png b/docs/content/operations/img/02-data-loader-1.png
new file mode 100644
index 0000000..1cda146
Binary files /dev/null and b/docs/content/operations/img/02-data-loader-1.png differ
diff --git a/docs/content/operations/img/02-datasources.png b/docs/content/operations/img/02-datasources.png
deleted file mode 100644
index 0df697b..0000000
Binary files a/docs/content/operations/img/02-datasources.png and /dev/null differ
diff --git a/docs/content/operations/img/03-data-loader-2.png b/docs/content/operations/img/03-data-loader-2.png
new file mode 100644
index 0000000..0e327b3
Binary files /dev/null and b/docs/content/operations/img/03-data-loader-2.png differ
diff --git a/docs/content/operations/img/03-retention.png b/docs/content/operations/img/03-retention.png
deleted file mode 100644
index 306296d..0000000
Binary files a/docs/content/operations/img/03-retention.png and /dev/null differ
diff --git a/docs/content/operations/img/04-datasources.png b/docs/content/operations/img/04-datasources.png
new file mode 100644
index 0000000..a2b18b5
Binary files /dev/null and b/docs/content/operations/img/04-datasources.png differ
diff --git a/docs/content/operations/img/04-segments.png b/docs/content/operations/img/04-segments.png
deleted file mode 100644
index 6565912..0000000
Binary files a/docs/content/operations/img/04-segments.png and /dev/null differ
diff --git a/docs/content/operations/img/05-retention.png b/docs/content/operations/img/05-retention.png
new file mode 100644
index 0000000..7601d58
Binary files /dev/null and b/docs/content/operations/img/05-retention.png differ
diff --git a/docs/content/operations/img/05-tasks-1.png b/docs/content/operations/img/05-tasks-1.png
deleted file mode 100644
index 9a18468..0000000
Binary files a/docs/content/operations/img/05-tasks-1.png and /dev/null differ
diff --git a/docs/content/operations/img/06-segments.png b/docs/content/operations/img/06-segments.png
new file mode 100644
index 0000000..a2dc7bf
Binary files /dev/null and b/docs/content/operations/img/06-segments.png differ
diff --git a/docs/content/operations/img/06-tasks-2.png b/docs/content/operations/img/06-tasks-2.png
deleted file mode 100644
index 3ae5850..0000000
Binary files a/docs/content/operations/img/06-tasks-2.png and /dev/null differ
diff --git a/docs/content/operations/img/07-supervisors.png b/docs/content/operations/img/07-supervisors.png
new file mode 100644
index 0000000..41901a9
Binary files /dev/null and b/docs/content/operations/img/07-supervisors.png differ
diff --git a/docs/content/operations/img/07-tasks-3.png b/docs/content/operations/img/07-tasks-3.png
deleted file mode 100644
index 178c87e..0000000
Binary files a/docs/content/operations/img/07-tasks-3.png and /dev/null differ
diff --git a/docs/content/operations/img/08-servers.png b/docs/content/operations/img/08-servers.png
deleted file mode 100644
index 2754d0e..0000000
Binary files a/docs/content/operations/img/08-servers.png and /dev/null differ
diff --git a/docs/content/operations/img/08-tasks.png b/docs/content/operations/img/08-tasks.png
new file mode 100644
index 0000000..124d8fc
Binary files /dev/null and b/docs/content/operations/img/08-tasks.png differ
diff --git a/docs/content/operations/img/09-sql-1.png b/docs/content/operations/img/09-sql-1.png
deleted file mode 100644
index b5e844c..0000000
Binary files a/docs/content/operations/img/09-sql-1.png and /dev/null differ
diff --git a/docs/content/operations/img/09-task-status.png b/docs/content/operations/img/09-task-status.png
new file mode 100644
index 0000000..3002818
Binary files /dev/null and b/docs/content/operations/img/09-task-status.png differ
diff --git a/docs/content/operations/img/10-servers.png b/docs/content/operations/img/10-servers.png
new file mode 100644
index 0000000..20947c4
Binary files /dev/null and b/docs/content/operations/img/10-servers.png differ
diff --git a/docs/content/operations/img/10-sql-2.png b/docs/content/operations/img/10-sql-2.png
deleted file mode 100644
index e0980ab..0000000
Binary files a/docs/content/operations/img/10-sql-2.png and /dev/null differ
diff --git a/docs/content/operations/img/11-query-sql.png b/docs/content/operations/img/11-query-sql.png
new file mode 100644
index 0000000..c69977a
Binary files /dev/null and b/docs/content/operations/img/11-query-sql.png differ
diff --git a/docs/content/operations/img/12-query-rune.png b/docs/content/operations/img/12-query-rune.png
new file mode 100644
index 0000000..27b09a6
Binary files /dev/null and b/docs/content/operations/img/12-query-rune.png differ
diff --git a/docs/content/operations/img/13-lookups.png b/docs/content/operations/img/13-lookups.png
new file mode 100644
index 0000000..ce1895d
Binary files /dev/null and b/docs/content/operations/img/13-lookups.png differ


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