Skip to content

Commit

Permalink
update more pages with storage metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
taroface committed Mar 18, 2020
1 parent 0b10b81 commit 2b34252
Show file tree
Hide file tree
Showing 8 changed files with 52 additions and 19 deletions.
1 change: 1 addition & 0 deletions _includes/v20.1/admin-ui/logical-bytes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Logical bytes reflect the approximate number of bytes stored in the database. This value may deviate from the number of physical bytes on disk, due to factors such as compression and [write amplification](https://en.wikipedia.org/wiki/Write_amplification) affecting the latter.
Binary file added images/v20.1/admin_ui_live_bytes.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 images/v20.1/admin_ui_logical_bytes_per_store.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 5 additions & 4 deletions v20.1/admin-ui-databases-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ toc: true
On a secure cluster, this area of the Admin UI can only be accessed by an `admin` user. See [Admin UI access](admin-ui-overview.html#admin-ui-access).
{{site.data.alerts.end}}

The **Databases** page of the Admin UI provides details of the databases configured, the tables in each database, and the grants assigned to each user. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then click **Databases** on the left-hand navigation bar.
The **Databases** page of the Admin UI provides details of the databases configured, the tables in each database, and the grants assigned to each user.

To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then click **Databases** in the left-hand navigation. You can select [Tables](#tables-view) or [Grants](#grants-view) from the menu.

## Tables view

The **Tables** view shows details of the system table as well as the tables in your databases. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then select **Databases** from the left-hand navigation bar.
The **Tables** view on the Databases page shows details of the system table as well as the tables in your databases.

<img src="{{ 'images/v20.1/admin_ui_database_tables_view.png' | relative_url }}" alt="CockroachDB Admin UI Database Tables View" style="border:1px solid #eee;max-width:100%" />

Expand All @@ -21,14 +22,14 @@ The following details are displayed for each table:
Metric | Description
--------|----
Table Name | The name of the table.
Size | Approximate total disk size of the table across all replicas.
Size | Approximate disk size of all replicas of this table on the cluster.
Ranges | The number of ranges in the table.
\# of Columns | The number of columns in the table.
\# of Indices | The number of indices for the table.

## Grants view

The **Grants** view shows the [privileges](authorization.html#assign-privileges) granted to users for each database. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then select **Databases** from the left-hand navigation bar, select **Databases** from the left-hand navigation bar, and then select **Grants** from the **View** menu.
The **Grants** view on the Databases page shows the [privileges](authorization.html#assign-privileges) granted to users for each database.

For more details about grants and privileges, see [Grants](grant.html).

Expand Down
17 changes: 14 additions & 3 deletions v20.1/admin-ui-hardware-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ summary: The Hardware dashboard lets you monitor CPU usage, disk throughput, net
toc: true
---

The **Hardware** dashboard lets you monitor CPU usage, disk throughput, network traffic, storage capacity, and memory. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left, and then select **Dashboard** > **Hardware**.
The **Hardware** dashboard lets you monitor the hardware utilization of your cluster. This includes CPU usage, disk throughput, network traffic, storage capacity, and memory.

To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** in the left-hand navigation, and select **Dashboard** > **Hardware**.

{% include {{ page.version.version }}/admin-ui/admin-ui-metrics-navigation.md %}

Expand Down Expand Up @@ -86,9 +88,18 @@ For Mac OS, this graph is not populated and shows zero disk IOPS in progress. Th

<img src="{{ 'images/v20.1/admin_ui_available_disk_capacity.png' | relative_url }}" alt="CockroachDB Admin UI Disk Capacity graph" style="border:1px solid #eee;max-width:100%" />

- In the node view, the graph shows the available storage capacity for the selected node.
Metric | Description
--------|--------
**Available Disk Capacity** | Free disk space available to CockroachDB data on each node.

### Capacity metrics

The **available** disk capacity equals the amount of empty disk space that can be occupied by CockroachDB data. This value cannot exceed the store size, which is determined as follows:

- If a store size was specified using the [`--store`](cockroach-start.html#store) flag when starting nodes, this value is used as the limit for CockroachDB data.
- If no store size has been explicitly set, the actual disk capacity is used as the limit for CockroachDB data.

- In the cluster view, the graph shows the available storage capacity across all nodes in the cluster.
This disk space is not used by the Cockroach binary, operating system, and other system files.

{{site.data.alerts.callout_info}}
{% include {{ page.version.version }}/misc/available-capacity-metric.md %}
Expand Down
23 changes: 14 additions & 9 deletions v20.1/admin-ui-overview-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,24 @@ The timeseries data used to power the graphs in the Admin UI is stored within th

<img src="{{ 'images/v20.1/admin_ui_capacity.png' | relative_url }}" alt="CockroachDB Admin UI Capacity graph" style="border:1px solid #eee;max-width:100%" />

You can monitor the **Capacity** graph to determine when additional storage is needed.
You can monitor the **Capacity** graph to determine when additional storage is needed (e.g., by scaling your cluster).

- In the node view, the graph shows the maximum allocated capacity, available storage capacity, and capacity used by CockroachDB for the selected node.
Metric | Description
--------|--------
**Capacity** | The maximum store size. This value may be set per node using [`--store`](cockroach-start.html#store). If a store size has not been set, this metric displays the actual disk capacity. See [Capacity metrics](#capacity-metrics).
**Available** | The free disk space available to CockroachDB data.
**Used** | The disk space in use by CockroachDB data. This excludes the Cockroach binary, operating system, and other system files.

- In the cluster view, the graph shows the maximum allocated capacity, available storage capacity, and capacity used by CockroachDB across all nodes in the cluster.
### Capacity metrics

On hovering over the graph, the values for the following metrics are displayed:
The **Capacity** graph displays disk usage by CockroachDB data in relation to the maximum [store](architecture/storage-layer.html) size, which is determined as follows:

Metric | Description
--------|----
**Capacity** | The maximum storage capacity allocated to CockroachDB. You can configure the maximum storage capacity for a given node using the `--store` flag. For more information, see [Start a Node](cockroach-start.html#store).
**Available** | The free storage capacity available to CockroachDB.
**Used** | Disk space used by the data in the CockroachDB store. Note that this value is less than (**Capacity** - **Available**) because **Capacity** and **Available** metrics consider the entire disk and all applications on the disk, including CockroachDB, whereas **Used** metric tracks only the store's disk usage.
- If a store size was specified using the [`--store`](cockroach-start.html#store) flag when starting nodes, this value is used as the limit for CockroachDB data.
- If no store size has been explicitly set, the actual disk capacity is used as the limit for CockroachDB data.

The **available** capacity thus equals the amount of empty disk space, up to the value of the maximum store size. The **used** capacity refers only to disk space occupied by CockroachDB data, which resides in the store directory on each node.

The disk usage of the Cockroach binary, operating system, and other system files is not shown on the **Capacity** graph.

{{site.data.alerts.callout_info}}
{% include {{ page.version.version }}/misc/available-capacity-metric.md %}
Expand Down
17 changes: 15 additions & 2 deletions v20.1/admin-ui-replication-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ summary: The Replication dashboard lets you monitor the replication metrics for
toc: true
---

The **Replication** dashboard in the CockroachDB Admin UI enables you to monitor the replication metrics for your cluster. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **Replication**.
The **Replication** dashboard in the CockroachDB Admin UI enables you to monitor the replication metrics for your cluster.

To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** in the left-hand navigation, and select **Dashboard** > **Replication**.

## Review of CockroachDB terminology

Expand Down Expand Up @@ -41,6 +43,18 @@ Leaders w/o Leases | The number of Raft leaders without leases. If the number if
Unavailable | The number of unavailable ranges. If the number if non-zero for a long time, troubleshoot your cluster.
Under-replicated | The number of under-replicated ranges.

## Logical Bytes per Store

<img src="{{ 'images/v20.1/admin_ui_logical_bytes_per_store.png' | relative_url }}" alt="CockroachDB Admin UI Replicas per Store" style="border:1px solid #eee;max-width:100%" />

Metric | Description
--------|--------
**Logical Bytes per Store** | Number of logical bytes stored in [key-value pairs](distribution-layer.html#table-data) on each node. This includes historical and deleted data.

{{site.data.alerts.callout_info}}
{% include {{ page.version.version }}/admin-ui/logical-bytes.md %}
{{site.data.alerts.end}}

## Replicas Per Store

<img src="{{ 'images/v20.1/admin_ui_replicas_per_store.png' | relative_url }}" alt="CockroachDB Admin UI Replicas per Store" style="border:1px solid #eee;max-width:100%" />
Expand Down Expand Up @@ -86,7 +100,6 @@ The **Replication** dashboard shows other time series graphs that are important

- Leaseholders per Store
- Average Queries per Store
- Logical Bytes per Store
- Range Operations

For monitoring CockroachDB, it is sufficient to use the [**Ranges**](#ranges), [**Replicas per Store**](#replicas-per-store), and [**Replica Quiescence**](#replica-quiescence) graphs.
Expand Down
4 changes: 3 additions & 1 deletion v20.1/admin-ui-storage-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,15 @@ The disk usage of the Cockroach binary, operating system, and other system files

The **Live Bytes** graph displays the amount of data that can be read by applications and CockroachDB.

<img src="{{ 'images/v20.1/admin_ui_live_bytes.png' | relative_url }}" alt="CockroachDB Admin UI Replicas per Store" style="border:1px solid #eee;max-width:100%" />

Metric | Description
--------|--------
**Live** | Number of logical bytes stored in live [key-value pairs](distribution-layer.html#table-data). Live data excludes historical and deleted data.
**System** | Number of physical bytes stored in [system key-value pairs](distribution-layer.html#meta-ranges).

{{site.data.alerts.callout_info}}
Logical bytes reflect the approximate number of bytes stored in the database. This value may deviate from the number of physical bytes on disk, due to factors such as compression and [write amplification](https://en.wikipedia.org/wiki/Write_amplification) affecting the latter.
{% include {{ page.version.version }}/admin-ui/logical-bytes.md %}
{{site.data.alerts.end}}

## File Descriptors
Expand Down

0 comments on commit 2b34252

Please sign in to comment.