-
Notifications
You must be signed in to change notification settings - Fork 471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] Admin UI docs #2534
Closed
Closed
[WIP] Admin UI docs #2534
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
7b2984f
Initial cleanup + documented cluster overview panel
Amruta-Ranade f6e6dd8
Restructured content
Amruta-Ranade 1361022
Work in Progress
Amruta-Ranade 77ad4ce
Node Map Doc
Amruta-Ranade 85446f7
Fixed nits + Redesigned localities reference table
Amruta-Ranade d05016f
Fixed nit
Amruta-Ranade 38b765c
Incorporated Andrew's and Josue's comments
Amruta-Ranade 2cfeec3
Added troubleshooting for localities with same names
Amruta-Ranade 1bf5ccf
Minor fixes
Amruta-Ranade 3ed48bc
Worked on Andrew's and Pete's comments
Amruta-Ranade f92a72b
Fixed nit.
Amruta-Ranade File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1102,21 +1102,33 @@ | |
"title": "Monitor CockroachDB with the Admin UI", | ||
"items": [ | ||
{ | ||
"title": "Overview", | ||
"title": "Access and Navigate the Admin UI", | ||
"urls": [ | ||
"/${VERSION}/admin-ui-overview.html" | ||
"/${VERSION}/admin-ui-access-and-navigate.html" | ||
] | ||
}, | ||
{ | ||
"title": "Access and Navigate the Admin UI", | ||
"title": "Cluster Overview Page", | ||
"urls": [ | ||
"/${VERSION}/admin-ui-access-and-navigate.html" | ||
"/${VERSION}/admin-ui-cluster-overview.html" | ||
] | ||
}, | ||
{ | ||
"title": "Node Map", | ||
"urls": [ | ||
"/${VERSION}/admin-ui-node-map.html" | ||
] | ||
}, | ||
{ | ||
"title": "Time Series Graphs", | ||
"urls": [ | ||
"/${VERSION}/admin-ui-time-series.html" | ||
] | ||
}, | ||
{ | ||
"title": "Overview Dashboard", | ||
"title": "Cluster Metrics Dashboard", | ||
"urls": [ | ||
"/${VERSION}/admin-ui-overview-dashboard.html" | ||
"/${VERSION}/admin-ui-metrics-dashboard.html" | ||
] | ||
}, | ||
{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @couchand Yes, I think you were on vacation when we discussed this. I am going to wait till the last week before the release to update all screenshots, so we have more time to make the visual tweaks if needed. So all screenshots as of now are placeholders. |
||
|
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: Overview Page | ||
toc: false | ||
--- | ||
|
||
On [accessing the Admin UI](admin-ui-access-and-navigate.html), the **Overview** page is displayed by default. The **Overview** page has three components: the [Cluster Overview panel](#cluster-overview-panel), the [Node List](#node-list), and the [Node Map](#node-map). | ||
|
||
<div id="toc"></div> | ||
|
||
## Cluster Overview Panel | ||
<img src="{{ 'images/admin_ui_summary_panel.png' | relative_url }}" alt="CockroachDB Admin UI Summary Panel" style="border:1px solid #eee;max-width:40%" /> | ||
|
||
The **Cluster Overview** panel provides the following metrics: | ||
|
||
Metric | Description | ||
--------|---- | ||
Capacity Usage | <ul><li>The storage capacity used as a percentage of total storage capacity allocated across all nodes.</li><li>The current capacity usage.</li></ul> | ||
Node Status | <ul><li>The number of [live nodes](admin-ui-access-and-navigate.html#live-nodes) in the cluster.</li><li>The number of suspect nodes in the cluster. A node is considered a suspect node if it's liveness status is unavailable or the node is in the process of decommissioning.</li><li>The number of [dead nodes](admin-ui-access-and-navigate.html#dead-nodes) in the cluster.</li> | ||
Replication Status | <ul><li>The total number of ranges in the cluster.</li><li>The number of [under-replicated ranges](admin-ui-replication-dashboard.html#review-of-cockroachdb-terminology) in the cluster. A non-zero number indicates an unstable cluster.</li><li>The number of [unavailable ranges](admin-ui-replication-dashboard.html#review-of-cockroachdb-terminology) in the cluster. A non-zero number indicates an unstable cluster.</li> | ||
|
||
## Node List | ||
|
||
The **Node List** is displayed by default on the **Cluster Overview** page. | ||
<img src="{{ 'images/admin_ui_nodes_page.png' | relative_url }}" alt="CockroachDB Admin UI" style="border:1px solid #eee;max-width:100%" /> | ||
|
||
#### Live Nodes | ||
Live nodes are nodes that are online and responding. They are marked with a green dot. If a node is removed or dies, the dot turns yellow to indicate that it is not responding. If the node remains unresponsive for a certain amount of time (5 minutes by default), the node turns red and is moved to the [**Dead Nodes**](#dead-nodes) section, indicating that it is no longer expected to come back. | ||
|
||
The following details are shown for each live node: | ||
|
||
Column | Description | ||
-------|------------ | ||
ID | The ID of the node. | ||
Address | The address of the node. You can click on the address to view further details about the node. | ||
Uptime | How long the node has been running. | ||
Bytes | The used capacity for the node. | ||
Replicas | The number of replicas on the node. | ||
Mem Usage | The memory usage for the node. | ||
Version | The build tag of the CockroachDB version installed on the node. | ||
Logs | Click **Logs** to see the logs for the node. | ||
|
||
#### Dead Nodes | ||
|
||
Nodes are considered dead once they have not responded for a certain amount of time ([5 minutes by default](stop-a-node.html#considerations)). At this point, the automated repair process starts, wherein CockroachDB automatically rebalances replicas from the dead node, using the unaffected replicas as sources. See [Stop a Node](stop-a-node.html#how-it-works) for more information. | ||
|
||
The following details are shown for each dead node: | ||
|
||
Column | Description | ||
-------|------------ | ||
ID | The ID of the node. | ||
Address | The address of the node. You can click on the address to view further details about the node. | ||
Down Since | How long the node has been down. | ||
|
||
#### Decommissioned Nodes | ||
|
||
<span class="version-tag">New in v1.1:</span> Nodes that have been decommissioned for permanent removal from the cluster are listed in the **Decommissioned Nodes** table. They are marked with a yellow dot. | ||
|
||
<img src="{{ 'images/cluster-status-after-decommission2.png' | relative_url }}" alt="CockroachDB Admin UI" style="border:1px solid #eee;max-width:100%" /> | ||
|
||
When you decommission a node, CockroachDB lets the node finish in-flight requests, rejects any new requests, and transfers all range replicas and range leases off the node so that it can be safely shut down. See [Remove Nodes](remove-nodes.html) for more information. | ||
|
||
## Node Map | ||
|
||
The **Node Map** is an [enterprise-only](enterprise-licensing.html) feature that gives you a visual representation of the geographical configuration of your cluster. To configure and understand the Node Map, see [Node Map](admin-ui-node-map.html). |
10 changes: 6 additions & 4 deletions
10
v2.0/admin-ui-overview-dashboard.md → v2.0/admin-ui-metrics-dashboard.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
commenting here since I can't comment on the images themselves:
node-map-components:
node-map