Hardware dashboard reference document #3419

Amruta-Ranade · 2018-07-24T15:58:33Z

Summary of changes:

Added reference document for the new Hardware Dashboard
Added navigation link to the sidebar nav
Added screenshots

cockroach-teamcity · 2018-07-24T15:58:40Z

This change is

cockroach-teamcity · 2018-07-24T16:01:14Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/25bbb33be45e15e1d0244312e2fffd7f274e1c13/

cockroach-teamcity · 2018-07-24T16:07:00Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/ce992cc77e72ff43349c4e872ba9e3e237a98e40/

vilterp · 2018-07-24T19:29:32Z

v2.1/admin-ui-hardware-dashboard.md

+
+- In the cluster view, the graph shows the memory in use across all nodes in the cluster.
+
+## Disk Read Bytes


please add a note for

disk {read, write, iops}

net {read, write}

that those metrics are across the whole host, not just for the cockroach process, i.e. they could show disk activity from other processes. Memory and CPU, on the other hand, are just for the cockroach process. Kind of confusing, but I wasn't able to find a good way to get the per-process IO info on both Mac and Linux.

@vilterp I made the changes - might have made it worse. Can you check and let me know?

vilterp · 2018-07-24T19:31:16Z

v2.1/admin-ui-hardware-dashboard.md

+
+<img src="{{ 'images/v2.1/admin_ui_disk_read_bytes.png' | relative_url }}" alt="CockroachDB Admin UI Disk Read Bytes graph" style="border:1px solid #eee;max-width:100%" />
+
+- In the node view, the graph shows the current moving average, over the last 10 seconds, of the number of bytes read per second for the node.


I think "current moving average, over the last ten seconds, of per second" is pretty confusing, but I haven't been able to think of a better suggestion.

This language is consistent with the description for SQL Queries. I agree this is not very clear - I am trying to come up with a way to present it diagrammatically. I vote for not changing the language in the meanwhile, because it's technically correct.

cockroach-teamcity · 2018-07-24T21:17:43Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/85ddd209c16bf75815092d92971fe027f4b2de86/

lnhsingh

Reviewable status: complete! 0 of 0 LGTMs obtained

v2.1/admin-ui-hardware-dashboard.md, line 47 at r2 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

This language is consistent with the description for SQL Queries. I agree this is not very clear - I am trying to come up with a way to present it diagrammatically. I vote for not changing the language in the meanwhile, because it's technically correct.

Suggested reword (for whenever you do try to make this clearer): "[...] the graph shows the current moving average of the number of bytes read per second by all processes (including CockroachDB) for the selected node. The average is taken across the last 10 seconds."

v2.1/admin-ui-hardware-dashboard.md, line 15 at r3 (raw file):

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

- In the node view, the User CPU Percent graph shows the percentage of the total CPU seconds per second used by the CockroachDB process for the selected node.

"the User CPU Percent graph..." is inconsistent with the other sections (which only say, "the graph shows...")

v2.1/admin-ui-hardware-dashboard.md, line 20 at r3 (raw file):

{{site.data.alerts.callout_info}}
For multi-core systems, the User CPU Percent can be greater than 100%. Full utilization of one core is considered as 100% CPU usage. If you have n cores, then the User CPU Percent can range from 0% (indicating an idle system) to (n*100)% (indicating full utilization).

I think "User CPU Percent" should be "user CPU percent" here since you're referring to the metric, not the graph.

v2.1/admin-ui-hardware-dashboard.md, line 27 at r3 (raw file):

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

- In the node view, the graph shows the percentage of the total CPU seconds per second used by the system calls made by CockroachDB for the selected node.

Might be clearer to say "[...] used by the CockroachDB system calls for the selected node." Not sure if it changes the meaning though.

v2.1/admin-ui-hardware-dashboard.md, line 32 at r3 (raw file):

{{site.data.alerts.callout_info}}
For multi-core systems, the System CPU Percent can be greater than 100%. Full utilization of one core is considered as 100% CPU usage. If you have n cores, then the User CPU Percent can range from 0% (indicating an idle system) to (n*100)% (indicating full utilization).

I think "System CPU Percent" should be "system CPU percent" here since you're referring to the metric, not the graph.

v2.1/admin-ui-hardware-dashboard.md, line 77 at r3 (raw file):

- 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.

On hovering over the graph, the values for the following metrics are displayed:

Reword to be active/prescriptive: "Hover over the graph to display the values for the following metrics:"

v2.1/admin-ui-hardware-dashboard.md, line 83 at r3 (raw file):

Capacity | The maximum storage capacity allocated to CockroachDB. You can configure the maximum allocated storage capacity for CockroachDB using the <code>--store</code> flag. For more information, see [Start a Node](start-a-node.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.

Bold Capacity, Available, and Used since you're referring to the different metrics

Amruta-Ranade · 2018-07-25T18:29:53Z

v2.1/admin-ui-hardware-dashboard.md, line 83 at r3 (raw file):

Previously, lhirata wrote…

Bold Capacity, Available, and Used since you're referring to the different metrics

Ummm...not sure why we would do that? 🤔

lnhsingh

Reviewable status: complete! 0 of 0 LGTMs obtained

v2.1/admin-ui-hardware-dashboard.md, line 83 at r3 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Ummm...not sure why we would do that? 🤔

Since we're referring to labels/attributes on the graph, it seems like we should adhere to the following guidance:

Use bolded text to emphasize an important word or phrase, when referring to the name of a UI section or field, or to create visual separation and callouts

Amruta-Ranade · 2018-07-25T18:47:48Z

v2.1/admin-ui-hardware-dashboard.md, line 47 at r2 (raw file):

Previously, lhirata wrote…

Suggested reword (for whenever you do try to make this clearer): "[...] the graph shows the current moving average of the number of bytes read per second by all processes (including CockroachDB) for the selected node. The average is taken across the last 10 seconds."

Ooh..just found the term "10-second moving average". Rewording our phrase: " [... ]the 10-second moving average of the number of bytes read per second [...]". Does that sound better?

lnhsingh

Reviewable status: complete! 0 of 0 LGTMs obtained

v2.1/admin-ui-hardware-dashboard.md, line 47 at r2 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Ooh..just found the term "10-second moving average". Rewording our phrase: " [... ]the 10-second moving average of the number of bytes read per second [...]". Does that sound better?

👍

Amruta-Ranade · 2018-07-25T19:34:58Z

v2.1/admin-ui-hardware-dashboard.md, line 47 at r2 (raw file):

Previously, lhirata wrote…

👍

Discussion with Pete: It's not a 10-second moving avg; it is an "average over a 10-second window".

Amruta-Ranade · 2018-07-25T19:38:46Z

v2.1/admin-ui-hardware-dashboard.md, line 27 at r3 (raw file):

Previously, lhirata wrote…

Might be clearer to say "[...] used by the CockroachDB system calls for the selected node." Not sure if it changes the meaning though.

Discussion with Pete: Needs further reading (it's not the making of calls that takes time, it's the time required for completing the calls)

Amruta-Ranade

Reviewable status: complete! 0 of 0 LGTMs obtained

v2.1/admin-ui-hardware-dashboard.md, line 15 at r3 (raw file):

Previously, lhirata wrote…

"the User CPU Percent graph..." is inconsistent with the other sections (which only say, "the graph shows...")

Done.

v2.1/admin-ui-hardware-dashboard.md, line 20 at r3 (raw file):

Previously, lhirata wrote…

I think "User CPU Percent" should be "user CPU percent" here since you're referring to the metric, not the graph.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 32 at r3 (raw file):

Previously, lhirata wrote…

I think "System CPU Percent" should be "system CPU percent" here since you're referring to the metric, not the graph.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 77 at r3 (raw file):

Previously, lhirata wrote…

Reword to be active/prescriptive: "Hover over the graph to display the values for the following metrics:"

Done.

v2.1/admin-ui-hardware-dashboard.md, line 83 at r3 (raw file):

Previously, lhirata wrote…

Since we're referring to labels/attributes on the graph, it seems like we should adhere to the following guidance:
Use bolded text to emphasize an important word or phrase, when referring to the name of a UI section or field, or to create visual separation and callouts 

Done.

cockroach-teamcity · 2018-07-25T19:46:32Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/394bb7d59ad5b374f7611c39d7a0223dc5610ac0/

vilterp · 2018-07-25T20:41:07Z

v2.1/admin-ui-hardware-dashboard.md

+
+- In the node view, the graph shows the number of disk reads and writes in queue for all processes including CockroachDB for the selected node.
+
+- In the cluster view, the graph shows the number of disk reads and writes in queue for all processes including CockroachDB across all nodes in the cluster.


forgot to mention — IOPS in progress will always show up as 0 on Mac, because the library we're using doesn't report it on Mac, only Linux and maybe Windows. (There may be some way to get it; I just haven't found it yet)

Arguably we just shouldn't show this graph on mac, but we don't have any other OS-specific graphs. So, probably just best to note it here.

Filed cockroachdb/cockroach#27927; can use as known limitation

Amruta-Ranade · 2018-07-25T22:53:56Z

v2.1/admin-ui-hardware-dashboard.md, line 47 at r2 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Discussion with Pete: It's not a 10-second moving avg; it is an "average over a 10-second window".

Confirmed with Matt T.: It is a 10-second average.
Making that change everywhere relevant.

cockroach-teamcity · 2018-07-25T23:04:43Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/f8b0cf925eb3ddb0e2b76c3a1990f77bf628cc5d/

Amruta-Ranade · 2018-07-25T23:11:56Z

@lhirata I have made the changes you requested. Can you please confirm?
@jseldess Ready for your review!

cockroach-teamcity · 2018-07-25T23:12:55Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/59d6ecbb5021b81006e9ee86f6d1d279a022e2da/

lnhsingh

!

Reviewable status: complete! 0 of 0 LGTMs obtained (and 1 stale)

…r nav, and worked on review comments

cockroach-teamcity · 2018-07-26T13:34:08Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/09a0637b5577064778c7725a15096c830233b9e6/

jseldess

Nice work, @Amruta-Ranade. I have some comments, but this is pretty close, with some eventual follow-up work to do for the full 2.1 release.

One thing not noted below: You need to add this to https://www.cockroachlabs.com/docs/v2.1/admin-ui-overview.html somehow.

Reviewable status: complete! 0 of 0 LGTMs obtained (and 1 stale)

v2.1/admin-ui-hardware-dashboard.md, line 20 at r3 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Done.

I agree with @lhirata. You still need to make Percent lower-case.

v2.1/admin-ui-hardware-dashboard.md, line 32 at r3 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Done.

Again, agree with @lhirata. You still need to make Percent lower-case.

v2.1/admin-ui-hardware-dashboard.md, line 83 at r3 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Done.

You still need to bold the referenced metrics in the Used description.

v2.1/admin-ui-hardware-dashboard.md, line 15 at r5 (raw file):

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

- In the node view, the graph shows the percentage of the total CPU seconds per second used by the CockroachDB process for the selected node.

Based on discussions in the #frontend Slack channel, the CPU seconds per second terminology is probably not right here and needs to be re-thought. Same is true of instances of CPU seconds per second below.

v2.1/admin-ui-hardware-dashboard.md, line 27 at r5 (raw file):

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

- In the node view, the graph shows the percentage of the total CPU seconds per second used for CockroachDB system-level operations for the selected node.

In a follow-up PR, I think it is important to more clearly differentiate these two CPU metrics. How can we make them concrete for users? Perhaps we can provide a quick example for each.

v2.1/admin-ui-hardware-dashboard.md, line 47 at r5 (raw file):

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

- In the node view, the graph shows the 10-second average of the number of bytes read per second by all processes including CockroachDB for the selected node.

nit: Let's break up the sentence a bit with commas: all processes, including CockroachDB, for the selected node.

v2.1/admin-ui-hardware-dashboard.md, line 49 at r5 (raw file):

- In the node view, the graph shows the 10-second average of the number of bytes read per second by all processes including CockroachDB for the selected node.

- In the cluster view, the graph shows the 10-second average of the number of bytes read per second by all processes including CockroachDB across all nodes.

Same as above.

v2.1/admin-ui-hardware-dashboard.md, line 55 at r5 (raw file):

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

- In the node view, the graph shows the 10-second average of the number of bytes written per second by all processes including CockroachDB for the node.

Same as above.

v2.1/admin-ui-hardware-dashboard.md, line 57 at r5 (raw file):

- In the node view, the graph shows the 10-second average of the number of bytes written per second by all processes including CockroachDB for the node.

- In the cluster view, the graph shows the 10-second average of the number of bytes written per second by all processes including CockroachDB across all nodes.

Same as above.

v2.1/admin-ui-hardware-dashboard.md, line 63 at r5 (raw file):

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

- In the node view, the graph shows the number of disk reads and writes in queue for all processes including CockroachDB for the selected node.

Same as above.

v2.1/admin-ui-hardware-dashboard.md, line 65 at r5 (raw file):

- In the node view, the graph shows the number of disk reads and writes in queue for all processes including CockroachDB for the selected node.

- In the cluster view, the graph shows the number of disk reads and writes in queue for all processes including CockroachDB across all nodes in the cluster.

Same as above.

v2.1/admin-ui-hardware-dashboard.md, line 68 at r5 (raw file):

{{site.data.alerts.callout_info}}
For Mac OS, this graph is not populated and shows zero Disk IOPS in Progress. This is a [known limitation](https://github.com/cockroachdb/cockroach/issues/27927) that may be lifted in the future.

Disk IOPS in Progress > disk IOPS in progress.

v2.1/admin-ui-hardware-dashboard.md, line 75 at r5 (raw file):

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

You can monitor the **Disk Capacity** graph to determine when additional storage is needed.

I like stating up-front what users can get from a specific graph. In a follow-up PR, please consider doing this for the other graphs, where possible.

v2.1/admin-ui-hardware-dashboard.md, line 85 at r5 (raw file):
Let's tweak the second sentence to:

You can configure the maximum storage capacity for a given node using the --store flag.

Also, let's use backticks for --store instead of <code>--store</code>, unless there's a good reason.

v2.1/admin-ui-hardware-dashboard.md, line 87 at r5 (raw file):

**Capacity** | The maximum storage capacity allocated to CockroachDB. You can configure the maximum allocated storage capacity for CockroachDB using the <code>--store</code> flag. For more information, see [Start a Node](start-a-node.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.

For readability, use another comma: ... on the disk, including CockroachDB, ....

v2.1/admin-ui-overview-dashboard.md, line 16 at r5 (raw file):

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

- In the node view, the SQL Queries graph shows the 10-second average of the number of `SELECT`/`INSERT`/`UPDATE`/`DELETE` queries per second issued by SQL clients on the node.

While you're here, you might as well change the SQL Queries graph to just the graph, for concision.

jseldess · 2018-07-26T18:39:02Z

v2.1/admin-ui-hardware-dashboard.md, line 7 at r5 (raw file):

---

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-hand navigation bar, and then select **Dashboard** > **Hardware**.

One more thought, @Amruta-Ranade: Instead of or in addition to listing the types of metrics on this dashboard, the intro should probably make it clear why you would use this, what types of insights you would glean from it. I'd suggest looking at the airtable record, specifically the user stories there. @piyush-singh can probably help, too.

Amruta-Ranade

Reviewable status: complete! 0 of 0 LGTMs obtained (and 1 stale)

v2.1/admin-ui-hardware-dashboard.md, line 43 at r2 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

@vilterp I made the changes - might have made it worse. Can you check and let me know?

Follow-up with Pete: Looks okay.

v2.1/admin-ui-hardware-dashboard.md, line 20 at r3 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

I agree with @lhirata. You still need to make Percent lower-case.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 27 at r3 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Discussion with Pete: Needs further reading (it's not the making of calls that takes time, it's the time required for completing the calls)

Done.

v2.1/admin-ui-hardware-dashboard.md, line 32 at r3 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Again, agree with @lhirata. You still need to make Percent lower-case.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 83 at r3 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

You still need to bold the referenced metrics in the Used description.

Done

v2.1/admin-ui-hardware-dashboard.md, line 7 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

One more thought, @Amruta-Ranade: Instead of or in addition to listing the types of metrics on this dashboard, the intro should probably make it clear why you would use this, what types of insights you would glean from it. I'd suggest looking at the airtable record, specifically the user stories there. @piyush-singh can probably help, too.

I agree. I want to contextualize not just the dashboards but each graph wherever I can. In the next milestone, we are planning to reorganize the time series and dashboards, so would it be okay if I take it up holistically then? I think this dashboard might change, and so will the description.

v2.1/admin-ui-hardware-dashboard.md, line 15 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Based on discussions in the #frontend Slack channel, the CPU seconds per second terminology is probably not right here and needs to be re-thought. Same is true of instances of CPU seconds per second below.

For now, I am taking Ben's suggestion and going with: "In the node view, the graph shows the amount of CPU resources used by the CockroachDB process for the selected node." Does that look okay? Pete's working on changing the implementation, which will hopefully make it less convoluted to describe.

v2.1/admin-ui-hardware-dashboard.md, line 27 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

In a follow-up PR, I think it is important to more clearly differentiate these two CPU metrics. How can we make them concrete for users? Perhaps we can provide a quick example for each.

Yes.

v2.1/admin-ui-hardware-dashboard.md, line 49 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Same as above.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 55 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Same as above.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 57 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Same as above.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 63 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Same as above.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 65 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Same as above.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 68 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Disk IOPS in Progress > disk IOPS in progress.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 85 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

Let's tweak the second sentence to:

You can configure the maximum storage capacity for a given node using the --store flag.

Also, let's use backticks for --store instead of <code>--store</code>, unless there's a good reason.

Done.

v2.1/admin-ui-hardware-dashboard.md, line 87 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

For readability, use another comma: ... on the disk, including CockroachDB, ....

Done.

v2.1/admin-ui-overview-dashboard.md, line 16 at r5 (raw file):

Previously, jseldess (Jesse Seldess) wrote…

While you're here, you might as well change the SQL Queries graph to just the graph, for concision.

Done.

cockroach-teamcity · 2018-07-27T00:29:42Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/3cb6cd86022a59bbc3718ec9f200cfd3a472602e/

jseldess

LGTM, with one remaining nit.

Reviewable status: complete! 0 of 0 LGTMs obtained (and 1 stale)

v2.1/admin-ui-hardware-dashboard.md, line 32 at r3 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Done.

Still need to lower-case the Percent in the second sentence.

v2.1/admin-ui-hardware-dashboard.md, line 7 at r5 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

I agree. I want to contextualize not just the dashboards but each graph wherever I can. In the next milestone, we are planning to reorganize the time series and dashboards, so would it be okay if I take it up holistically then? I think this dashboard might change, and so will the description.

Sounds good. Please just keep a record of the work to revisit, perhaps in the related github issue.

v2.1/admin-ui-hardware-dashboard.md, line 15 at r5 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

For now, I am taking Ben's suggestion and going with: "In the node view, the graph shows the amount of CPU resources used by the CockroachDB process for the selected node." Does that look okay? Pete's working on changing the implementation, which will hopefully make it less convoluted to describe.

Hmm, I don't think that text really describes what the graph is showing currently, unfortunately, but if it's what you all agree on for now, I'm fine with it, as long as we revisit.

v2.1/admin-ui-hardware-dashboard.md, line 27 at r5 (raw file):

Previously, Amruta-Ranade (Amruta Ranade) wrote…

Yes.

Again, it'd be great to note this in the related issue so we don't forget.

Amruta-Ranade · 2018-07-27T11:48:32Z

@jseldess Created a tracking issue for Admin UI follow-up work: #3429

cockroach-teamcity · 2018-07-27T11:56:37Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/5413d29852d5181fcfc8b57e09499ac06218c5e1/

Amruta-Ranade added the in progress label Jul 24, 2018

Amruta-Ranade changed the title ~~Initial draft for the hardware dashboard reference document~~ Hardware dashboard reference document Jul 24, 2018

Amruta-Ranade requested review from vilterp and lnhsingh July 24, 2018 16:09

vilterp reviewed Jul 24, 2018

View reviewed changes

lnhsingh suggested changes Jul 25, 2018

View reviewed changes

lnhsingh reviewed Jul 25, 2018

View reviewed changes

Amruta-Ranade commented Jul 25, 2018

View reviewed changes

vilterp reviewed Jul 25, 2018

View reviewed changes

Amruta-Ranade requested a review from jseldess July 25, 2018 23:12

lnhsingh reviewed Jul 26, 2018

View reviewed changes

Drafted the hardware dashboard reference document, updated the sideba…

09a0637

…r nav, and worked on review comments

Amruta-Ranade force-pushed the hardware_dashboard branch from 59d6ecb to 09a0637 Compare July 26, 2018 13:31

lnhsingh approved these changes Jul 26, 2018

View reviewed changes

jseldess reviewed Jul 26, 2018

View reviewed changes

Worked on Jesse's comments

3cb6cd8

Amruta-Ranade commented Jul 27, 2018

View reviewed changes

jseldess approved these changes Jul 27, 2018

View reviewed changes

Amruta-Ranade mentioned this pull request Jul 27, 2018

Admin UI 2.1 Docs (Tracking Issue) #3429

Closed

Fixed nit

5413d29

Amruta-Ranade merged commit 23b5867 into master Jul 27, 2018

Amruta-Ranade deleted the hardware_dashboard branch July 27, 2018 14:25

Amruta-Ranade removed the in progress label Jul 27, 2018

Amruta-Ranade mentioned this pull request Aug 16, 2018

Allow users to identify bottlenecks in performance due to CPU / memory / IO / network issues #2931

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hardware dashboard reference document #3419

Hardware dashboard reference document #3419

Amruta-Ranade commented Jul 24, 2018

cockroach-teamcity commented Jul 24, 2018

cockroach-teamcity commented Jul 24, 2018

cockroach-teamcity commented Jul 24, 2018

vilterp Jul 24, 2018

Amruta-Ranade Jul 24, 2018

vilterp Jul 24, 2018

Amruta-Ranade Jul 24, 2018

cockroach-teamcity commented Jul 24, 2018

lnhsingh left a comment

Amruta-Ranade commented Jul 25, 2018

lnhsingh left a comment

Amruta-Ranade commented Jul 25, 2018

lnhsingh left a comment

Amruta-Ranade commented Jul 25, 2018

Amruta-Ranade commented Jul 25, 2018

Amruta-Ranade left a comment

cockroach-teamcity commented Jul 25, 2018

vilterp Jul 25, 2018 •

edited

Loading

vilterp Jul 25, 2018

Amruta-Ranade commented Jul 25, 2018

cockroach-teamcity commented Jul 25, 2018

Amruta-Ranade commented Jul 25, 2018

cockroach-teamcity commented Jul 25, 2018

lnhsingh left a comment

cockroach-teamcity commented Jul 26, 2018

jseldess left a comment

jseldess commented Jul 26, 2018

Amruta-Ranade left a comment

cockroach-teamcity commented Jul 27, 2018

jseldess left a comment

Amruta-Ranade commented Jul 27, 2018

cockroach-teamcity commented Jul 27, 2018


		- In the cluster view, the graph shows the memory in use across all nodes in the cluster.

		## Disk Read Bytes


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

		- In the node view, the graph shows the current moving average, over the last 10 seconds, of the number of bytes read per second for the node.

Hardware dashboard reference document #3419

Hardware dashboard reference document #3419

Conversation

Amruta-Ranade commented Jul 24, 2018

cockroach-teamcity commented Jul 24, 2018

cockroach-teamcity commented Jul 24, 2018

cockroach-teamcity commented Jul 24, 2018

vilterp Jul 24, 2018

Choose a reason for hiding this comment

Amruta-Ranade Jul 24, 2018

Choose a reason for hiding this comment

vilterp Jul 24, 2018

Choose a reason for hiding this comment

Amruta-Ranade Jul 24, 2018

Choose a reason for hiding this comment

cockroach-teamcity commented Jul 24, 2018

lnhsingh left a comment

Choose a reason for hiding this comment

Amruta-Ranade commented Jul 25, 2018

lnhsingh left a comment

Choose a reason for hiding this comment

Amruta-Ranade commented Jul 25, 2018

lnhsingh left a comment

Choose a reason for hiding this comment

Amruta-Ranade commented Jul 25, 2018

Amruta-Ranade commented Jul 25, 2018

Amruta-Ranade left a comment

Choose a reason for hiding this comment

cockroach-teamcity commented Jul 25, 2018

vilterp Jul 25, 2018 • edited Loading

Choose a reason for hiding this comment

vilterp Jul 25, 2018

Choose a reason for hiding this comment

Amruta-Ranade commented Jul 25, 2018

cockroach-teamcity commented Jul 25, 2018

Amruta-Ranade commented Jul 25, 2018

cockroach-teamcity commented Jul 25, 2018

lnhsingh left a comment

Choose a reason for hiding this comment

cockroach-teamcity commented Jul 26, 2018

jseldess left a comment

Choose a reason for hiding this comment

jseldess commented Jul 26, 2018

Amruta-Ranade left a comment

Choose a reason for hiding this comment

cockroach-teamcity commented Jul 27, 2018

jseldess left a comment

Choose a reason for hiding this comment

Amruta-Ranade commented Jul 27, 2018

cockroach-teamcity commented Jul 27, 2018

vilterp Jul 25, 2018 •

edited

Loading