Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 35 additions & 13 deletions docs/content/operations/druid-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Binary file modified docs/content/operations/img/01-home-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/02-datasources.png
Binary file not shown.
Binary file added docs/content/operations/img/03-data-loader-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/03-retention.png
Binary file not shown.
Binary file added docs/content/operations/img/04-datasources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/04-segments.png
Binary file not shown.
Binary file added docs/content/operations/img/05-retention.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/05-tasks-1.png
Binary file not shown.
Binary file added docs/content/operations/img/06-segments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/06-tasks-2.png
Binary file not shown.
Binary file added docs/content/operations/img/07-supervisors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/07-tasks-3.png
Binary file not shown.
Binary file removed docs/content/operations/img/08-servers.png
Binary file not shown.
Binary file added docs/content/operations/img/08-tasks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/09-sql-1.png
Binary file not shown.
Binary file added docs/content/operations/img/09-task-status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/operations/img/10-servers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/operations/img/10-sql-2.png
Binary file not shown.
Binary file added docs/content/operations/img/11-query-sql.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/operations/img/12-query-rune.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/operations/img/13-lookups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.