From 860541ee679006cfade9dc470357f4548cce04c6 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Tue, 17 Sep 2024 23:10:07 +0200 Subject: [PATCH 01/12] DOCS-512 light page editing, resource-utilization-overview --- .../resource-utilization-overview.md | 205 ++++++++++-------- 1 file changed, 110 insertions(+), 95 deletions(-) diff --git a/docs/auto-discovery/resource-utilization-overview.md b/docs/auto-discovery/resource-utilization-overview.md index e1c5d6cd..3cf2f55e 100644 --- a/docs/auto-discovery/resource-utilization-overview.md +++ b/docs/auto-discovery/resource-utilization-overview.md @@ -5,27 +5,27 @@ sidebar_position: 25 ## What is Resource Utilization? -Device42's _Resource Utilization_ features \[_aka 'RU', the "enable monitoring for discovered devices" setting_\] are enabled for users with an installed RU license. This powerful module allows for the collection and examination of server resource usage metrics, which can fuel advanced business and capacity planning decisions as well as migration planning, move-group selection (via Affinity Groups), cloud target rightsizing, and support a variety of other digital transformation projects, as well. +Device42's Resource Utilization (RU) features are enabled for users with an installed RU license. RU is also known as the "enable monitoring for discovered devices" setting. This powerful module collects and examines server resource usage metrics, which can fuel advanced business and capacity planning decisions, migration planning, move-group selection (via Affinity Groups), cloud target rightsizing, and support a variety of other digital transformation projects. -Once enabled, you will see a 'monitoring' option on the Hypervisor/\*NIX/Windows Discovery settings screen, and stats are currently displayed on Linux and Windows-based platform CIs. +Once enabled, you will see a 'monitoring' option on Hypervisor/\*nix/Windows autodiscovery jobs. On Linux and Windows-based platform CIs, stats are currently displayed. ![](/assets/images/D42-22008_RU-sampling-interval-700x420.png) **Resource utilization is only available and will only function if:** -- The licensing module is enabled - on/off -\[the enable checkbox (pictured above) will be disabled if the licensing module is disabled\] -- Resource Utilization Tracking Checkbox is checked at time of discovery -- Verify monitoring option is checked after the device has been discovered (assuming the job is set to run again -- but verify when the schedule is set and next time its run, it should bring in data) +- The licensing module is enabled. Check if **Resource Utilization** is **Enabled** under **Tools > Settings > Licensing**. The **Enable Resource Utilization Tracking for Device(s)** checkbox (pictured above) will be disabled if the licensing module is disabled. +- The **Enable Resource Utilization Tracking for Device(s)** is checked at the time of discovery. +- The 'verify monitoring' option is checked after a device has been discovered. If the job is scheduled to run again, it should bring in data the next time the discovery job runs. * * * -## Handling of the same IP/machine instance across multiple RCs +## Handling of the Same IP/Machine Instance Across Multiple RCs -If an IP is discovered across multiple RCs, Device42 will _not_ monitor that IP again if it is already being monitored; were this otherwise permitted, unexpected behavior would likely result. We will adjust this and other RU workflows based on user feedback - please do let us know about any ideas or changes you have that would help you! +If an IP is discovered across multiple RCs, Device42 will **not** monitor that IP again if it is already being monitored; were this otherwise permitted, unexpected behavior would likely result. We will adjust this and other RU workflows based on user feedback - please do let us know about any ideas or changes you have that would help you! -### Monitoring management - Example scenarios +### Monitoring Management - Example Scenarios -Let’s consider three Devices A, B and C, and two Remote Collectors, RC#1 & #2. Monitoring is currently _disabled_ on all three. +Let’s consider three Devices A, B, and C, and two Remote Collectors, RC#1 & #2. Monitoring is currently **disabled** on all three. Consider a scenario where two discovery jobs are configured: @@ -52,17 +52,17 @@ Then you change the settings on Job #2 and run it from RC#2 with monitoring enab - DeviceB with monitoring on RC#1 - DeviceC with monitoring on RC#2 -Note that _DeviceB_ does not switch which RC it's attached to! +Note that DeviceB does not switch which RC it's attached to. * * * -### How can I switch device RU monitoring to another RC +### How Can I Switch Device RU Monitoring to Another RC? -If you _want_ to move a device to another RC, this can be accomplished by opening the device list, selecting the device, and setting the `Disable monitoring…` option. After disabling monitoring, re-run the job yet again with monitoring re-enabled on the new target RC. +If you _want_ to move a device to another RC, open the device list, select the device, and select a **Disable monitoring for selected devices...** action. After disabling monitoring, re-run the job again with monitoring re-enabled on the new target RC. ![Disable RU Monitoring on devices](/assets/images/disable_RU_monitoring_device_list_view-1.png) -The difference between the options deal with the handling of historical data for the device in question. If “Keep Data” is selected, data is stored for as long as is needed, and if the same device were rediscovered, the existing data will be automatically utilized. The second option simply deletes all existing data from the server. When a previously existent device is re-discovered with the second option selected, its history begins anew. +The difference between the options deals with the handling of historical data for the device in question. The **...but keep Data** action stores data for as long as needed, and if the same device were rediscovered, the existing data will be automatically utilized. The **...and delete data** option simply deletes all existing data from the server. When a previously existent device is rediscovered with this option selected, its history begins anew. Now re-run Job#2 on RC#2 with monitoring enabled once again. After that run, you can see the device has moved to RC2: @@ -72,52 +72,54 @@ Now re-run Job#2 on RC#2 with monitoring enabled once again. After that run, you * * * -## Technical Details: RU data storage +## Technical Details: RU Data Storage -### The time-series database \[TSDB\] +### The Time-Series Database (TSDB) Monitoring data is kept on the RC in a TSDB. A dedicated database called `sensors` is used for this purpose, and it contains the following series: -- **infeeds** - stores infeeds stats -- **outlets** - stores outlets stats -- **banks** - stores banks stats -- **battery** - stores battery stats -- **device** - stores device sensors - usually load, power factor, etc. -- **env\_sensor** - stores all types of device\_sensors - humidity, temperature, cpu, etc. +- **`infeeds`**: Stores infeeds stats +- **`outlets`**: Stores outlets stats +- **`banks`**: Stores banks stats +- **`battery`**: Stores battery stats +- **`device`**: Stores device sensors - usually load, power factor, etc. +- **`env_sensor`**: Stores all types of `device_sensors` - humidity, temperature, CPU, etc. -You can think about these series as if they were Excel sheets, in which the first column is always a timestamp. For example, a memory series looks like this: +You can think about these series as if they were Excel sheets, with the first column always consisting of a timestamp. For example, a memory series looks like this: ![A memory series in Device42](/assets/images/sensor_data_series.png) -In general, chart generation doesn't use all data points, as there tends to be quite a lot of them \[_for example, a 30 sec. interval for a month = 86,400 data points_\]. Instead, data is aggregated, which is a common way to visualize data of this type. +In general, charts don't use all data points as there tends to be quite a lot of them. For example, a 30-second interval for a month equals 86,400 data points. Instead, data is aggregated, which is a common way to visualize data of this type. -Aggregation takes multiple data points and converts their values to one depending on the selected aggregation function. Currently, Device42 does this one of three ways: _MIN, AVG,_ and _MAX_. +Aggregation takes multiple data points and converts their values to one depending on the selected aggregation function. Currently, Device42 does this one of three ways: `MIN`, `AVG`, and `MAX`. * * * -
As an example, to generate AVG physical values from 5 minutes intervals with a point every minute from the table in the screenshot above, we will get: | The MIN setting, instead, would return the smallest value from each set: |
|
|
As an example, to generate `AVG` physical values from 5-minute intervals with a point every minute from the table in the screenshot above, we will get: | The `MIN` setting, instead, would return the smallest value from each set: |
|
|
So, let’s look at the following example data for ReadTransfer :
| If a user requests data between 00:01 and 00:03 with density=3 (see API section for density details), Device42 will print:
|
5uI<)2MxR9VMl#EvhKj(+F1GR=3lZE9hlk
z#z2a7;OROqf*?DtIuj{!Zcy||)G0f(?c9`P?d Yp0A? S*tma{B7e6=2%{Fx
zlLuoBnIxoCy|&+KC0LqH@84RKER8NiTdLXUUvyz$snC|S^!~?@1)?pH3-tcWzdIQ4
z{;36n>i>Z&_PS7)g`)_VDK+~B3PEAB>cVHD&j+M!ecO9SFKWZx=I~^a$FvZ}K>YV>
z5HG_cQw7|JBA**uSW;{
z(1g-n{`Gz~Wk<}9V%tM2KSP~=<+z?6`hjzGu&VWu<$Sy21uq7RKq?jid~%fv2>{~*
z%q!-7^PX{xD}6N3xOH(cK!o}Ip-REilKyv@NF6#H*@}2n!9yXpmXu*|V5aZg(R)AR
zCkk~LTgcHZ;(K(YEfe~L6LB(5{y
|&MaQVhErY4B)5T&D`fmR2vgV-}a;M7ddKTqEkpK`JpVYW$fR!iPEl~{bI
zoqF}|ySdNURB}=M+`CA|=a))O7vSV
z`h=P>O=tSdY8$Q3Dq4M7h3QZ=xL(@BnF0|MlwhVm0oj4oT~zr(u><5thv>SLAOl`%
zsl-zTJty@}0b-mSwUBL{z*A-}VbZ13f)*!WHgC|EMQN|h!8jMgPy&b1&!%Uaaz|Va
ze@y>?r23w(y6(og2KSkdx&_34G@&R!@C_P$7)osxF@Dx@aaHW^w!5*@W=jQ@6ZYiA
zhc2l-if9M-J`=bFWjfcG%=7VXPXWqSKU%jq1|YQQjt|Snr~PK%tnvw@uTz5WxLvR@
zx<9~Mz=~JJ>y?u0Fgev%kSm1hHyY&gjWMy8u-P>}0-cp}CCe8NH8GZ;eN6Z-on%WQ
z^xq;G1MBsIjzv4(mO7V^9bG)lw>tB(
z0Z#wYsok^ZD#6i@{*tcW_ROZ={QdITMo(buQp`V##iQ7QoU@V@U|-wp;pvlK3gQG5
z?2sF!Xz4&}`1uU+Cz{HLl6sbc`D0R0{|m_H(bp!GobOjiL9T3pcG1!MAxj-iwOZtz
z=qYm-2BtIq2_KKsQ&qVO0NJY5rUZdJeLfVuY%q(2dTYUtTilP7$IYp<^6Zd_Q&l7%
z&5ASTw`>UbZVGOjhd4i_Jriu5_pSgs;?0?Ivp3}%6p}Im3Sr(FkO}e)U0e6~s{VH|
zDc3N;fBd5S^nLS3uWTShm
DrW+Q4{f(=
zgd{tMb4y60bok9k#0$z>$C{AG`CJw}5ib-N7Zr&4LGTb0PF4zDP=RvruS}XBASA$_
z5Js3+W$Cx