mirror of https://github.com/apache/druid.git
Add web consoles doc page (#7123)
* Add web consoles doc page * PR comments * Remove 'unified' * PR comments * Fix TOC * PR comments * More revisions * GUI -> UI * Update router docs * Reword router doc
This commit is contained in:
Jonathan Wei
GitHub
parent
e432965c13
commit
a0afd7931d
|
|
@ -113,15 +113,7 @@ If it finds such segments, it simply skips them.
|
|||
|
||||
### The Coordinator Console
|
||||
|
||||
The Druid Coordinator exposes a web GUI for displaying cluster information and rule configuration. After the Coordinator starts, the console can be accessed at:
|
||||
|
||||
```
|
||||
http://<COORDINATOR_IP>:<COORDINATOR_PORT>
|
||||
```
|
||||
|
||||
There exists a full cluster view (which shows only the realtime and Historical nodes), as well as views for individual Historical nodes, datasources and segments themselves. Segment information can be displayed in raw JSON form or as part of a sortable and filterable table.
|
||||
|
||||
The Coordinator console also exposes an interface to creating and editing rules. All valid datasources configured in the segment database, along with a default datasource, are available for configuration. Rules of different types can be added, deleted or edited.
|
||||
The Druid Coordinator exposes a web GUI for displaying cluster information and rule configuration. For more details, please see [coordinator console](../operations/web-consoles.html#coordinator-console).
|
||||
|
||||
### FAQ
|
||||
|
||||
|
|
|
|||
|
|
@ -41,11 +41,7 @@ This mode is recommended if you intend to use the indexing service as the single
|
|||
|
||||
### Overlord Console
|
||||
|
||||
The Overlord console can be used to view pending tasks, running tasks, available workers, and recent worker creation and termination. The console can be accessed at:
|
||||
|
||||
```
|
||||
http://<OVERLORD_IP>:<port>/console.html
|
||||
```
|
||||
The Overlord provides a UI for managing tasks and workers. For more details, please see [overlord console](../operations/web-consoles.html#overlord-console).
|
||||
|
||||
### Blacklisted Workers
|
||||
|
||||
|
|
|
|||
|
|
@ -78,6 +78,8 @@ caller. End users typically query Brokers rather than querying Historicals or Mi
|
|||
Overlords, and Coordinators. They are optional since you can also simply contact the Druid Brokers, Overlords, and
|
||||
Coordinators directly.
|
||||
|
||||
The Router also runs the [Druid Console](../operations/management-uis.html#druid-console), a management UI for datasources, segments, tasks, data processes (Historicals and MiddleManagers), and coordinator dynamic configuration. The user can also run SQL and native Druid queries within the console.
|
||||
|
||||
### Data server
|
||||
|
||||
A Data server executes ingestion jobs and stores queryable data.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: doc_page
|
||||
title: "Router Node"
|
||||
title: "Router Process"
|
||||
---
|
||||
|
||||
<!--
|
||||
|
|
@ -22,9 +22,14 @@ title: "Router Node"
|
|||
~ under the License.
|
||||
-->
|
||||
|
||||
# Router Node
|
||||
# Router Process
|
||||
|
||||
The Router process can be used to route queries to different Broker processes. By default, the broker routes queries based on how [Rules](../operations/rule-configuration.html) are set up. For example, if 1 month of recent data is loaded into a `hot` cluster, queries that fall within the recent month can be routed to a dedicated set of brokers. Queries outside this range are routed to another set of brokers. This set up provides query isolation such that queries for more important data are not impacted by queries for less important data.
|
||||
|
||||
For query routing purposes, you should only ever need the Router process if you have a Druid cluster well into the terabyte range.
|
||||
|
||||
In addition to query routing, the Router also runs the [Druid Console](../operations/management-uis.html#druid-console), a management UI for datasources, segments, tasks, data processes (Historicals and MiddleManagers), and coordinator dynamic configuration. The user can also run SQL and native Druid queries within the console.
|
||||
|
||||
You should only ever need the Router node if you have a Druid cluster well into the terabyte range. The Router node can be used to route queries to different Broker nodes. By default, the broker routes queries based on how [Rules](../operations/rule-configuration.html) are set up. For example, if 1 month of recent data is loaded into a `hot` cluster, queries that fall within the recent month can be routed to a dedicated set of brokers. Queries outside this range are routed to another set of brokers. This set up provides query isolation such that queries for more important data are not impacted by queries for less important data.
|
||||
|
||||
Running
|
||||
-------
|
||||
|
|
@ -36,7 +41,7 @@ org.apache.druid.cli.Main server router
|
|||
Example Production Configuration
|
||||
--------------------------------
|
||||
|
||||
In this example, we have two tiers in our production cluster: `hot` and `_default_tier`. Queries for the `hot` tier are routed through the `broker-hot` set of Brokers, and queries for the `_default_tier` are routed through the `broker-cold` set of Brokers. If any exceptions or network problems occur, queries are routed to the `broker-cold` set of brokers. In our example, we are running with a c3.2xlarge EC2 node. We assume a `common.runtime.properties` already exists.
|
||||
In this example, we have two tiers in our production cluster: `hot` and `_default_tier`. Queries for the `hot` tier are routed through the `broker-hot` set of Brokers, and queries for the `_default_tier` are routed through the `broker-cold` set of Brokers. If any exceptions or network problems occur, queries are routed to the `broker-cold` set of brokers. In our example, we are running with a c3.2xlarge EC2 instance. We assume a `common.runtime.properties` already exists.
|
||||
|
||||
JVM settings:
|
||||
|
||||
|
|
@ -176,13 +181,13 @@ This is a non-default implementation that is provided for experimentation purpos
|
|||
HTTP Endpoints
|
||||
--------------
|
||||
|
||||
The Router node exposes several HTTP endpoints for interactions.
|
||||
The Router process exposes several HTTP endpoints for interactions.
|
||||
|
||||
### GET
|
||||
|
||||
* `/status`
|
||||
|
||||
Returns the Druid version, loaded extensions, memory used, total memory and other useful information about the node.
|
||||
Returns the Druid version, loaded extensions, memory used, total memory and other useful information about the process.
|
||||
|
||||
* `/druid/v2/datasources`
|
||||
|
||||
|
|
@ -203,7 +208,7 @@ Returns the metrics of the datasource.
|
|||
Router as Management Proxy
|
||||
--------------------------
|
||||
|
||||
The Router can be configured to forward requests to the active Coordinator or Overlord node. This may be useful for
|
||||
The Router can be configured to forward requests to the active Coordinator or Overlord process. This may be useful for
|
||||
setting up a highly available cluster in situations where the HTTP redirect mechanism of the inactive -> active
|
||||
Coordinator/Overlord does not function correctly (servers are behind a load balancer, the hostname used in the redirect
|
||||
is only resolvable internally, etc.).
|
||||
|
|
@ -224,10 +229,10 @@ determined from the original request path based on Druid API path conventions. F
|
|||
that using the management proxy does not require modifying the API request other than issuing the request to the Router
|
||||
instead of the Coordinator or Overlord. Most Druid API requests can be routed implicitly.
|
||||
|
||||
Explicit routes are those where the request to the Router contains a path prefix indicating which node the request
|
||||
Explicit routes are those where the request to the Router contains a path prefix indicating which process the request
|
||||
should be routed to. For the Coordinator this prefix is `/proxy/coordinator` and for the Overlord it is `/proxy/overlord`.
|
||||
This is required for API calls with an ambiguous destination. For example, the `/status` API is present on all Druid
|
||||
nodes, so explicit routing needs to be used to indicate the proxy destination.
|
||||
processes, so explicit routing needs to be used to indicate the proxy destination.
|
||||
|
||||
This is summarized in the table below:
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
layout: doc_page
|
||||
title: "Management UIs"
|
||||
---
|
||||
|
||||
<!--
|
||||
~ 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.
|
||||
-->
|
||||
|
||||
# Management UIs
|
||||
|
||||
## Druid Console
|
||||
|
||||
Druid provides a console for managing datasources, segments, tasks, data processes (Historicals and MiddleManagers), and coordinator dynamic configuration. The user can also run SQL and native Druid queries within the console.
|
||||
|
||||
The Druid Console is hosted by the [Router](../development/router.html) process. We recommend running the Router process on your [Query server](../design/processes.html).
|
||||
|
||||
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>
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
## Legacy Consoles
|
||||
|
||||
These older consoles provide a subset of the functionality of the Druid Console. We recommend using the Druid Console if possible.
|
||||
|
||||
### Coordinator Consoles
|
||||
|
||||
#### Version 2
|
||||
|
||||
The Druid Coordinator exposes a web console for displaying cluster information and rule configuration. After the Coordinator starts, the console can be accessed at:
|
||||
|
||||
```
|
||||
http://<COORDINATOR_IP>:<COORDINATOR_PORT>
|
||||
```
|
||||
|
||||
There exists a full cluster view (which shows indexing tasks and Historical processes), as well as views for individual Historical processes, datasources and segments themselves. Segment information can be displayed in raw JSON form or as part of a sortable and filterable table.
|
||||
|
||||
The Coordinator console also exposes an interface to creating and editing rules. All valid datasources configured in the segment database, along with a default datasource, are available for configuration. Rules of different types can be added, deleted or edited.
|
||||
|
||||
#### Version 1
|
||||
|
||||
The oldest version of Druid's Coordinator console is still available for backwards compatibility at:
|
||||
|
||||
```
|
||||
http://<COORDINATOR_IP>:<COORDINATOR_PORT>/old-console
|
||||
```
|
||||
|
||||
### Overlord Console
|
||||
|
||||
The Overlord console can be used to view pending tasks, running tasks, available workers, and recent worker creation and termination. The console can be accessed at:
|
||||
|
||||
```
|
||||
http://<OVERLORD_IP>:<OVERLORD_PORT>/console.html
|
||||
```
|
||||
|
|
@ -130,6 +130,7 @@ layout: toc
|
|||
* [Different Hadoop Versions](/docs/VERSION/operations/other-hadoop.html)
|
||||
* [High Availability](/docs/VERSION/operations/high-availability.html)
|
||||
* [Performance FAQ](/docs/VERSION/operations/performance-faq.html)
|
||||
* [Management UIs](/docs/VERSION/operations/management-uis.html)
|
||||
* [Dump Segment Tool](/docs/VERSION/operations/dump-segment.html)
|
||||
* [Insert Segment Tool](/docs/VERSION/operations/insert-segment-to-db.html)
|
||||
* [Pull Dependencies Tool](/docs/VERSION/operations/pull-deps.html)
|
||||
|
|
|
|||
Loading…
Reference in New Issue