This is an automated email from the ASF dual-hosted git repository.

nvazquez pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git


The following commit(s) were added to refs/heads/main by this push:
     new ae1d650  Volumes metrics doc update (#60)
ae1d650 is described below

commit ae1d6507c2f9aa3c05260997812858919d2c7d13
Author: Andrija Panic <[email protected]>
AuthorDate: Thu May 5 13:27:39 2022 +0300

    Volumes metrics doc update (#60)
    
    * Description on the volume metrics
    
    * image added
    
    * Delete volume-metrics.png
    
    * Add files via upload
    
    * Update storage.rst
    
    * Update storage.rst
---
 source/_static/images/volume-metrics.png | Bin 0 -> 15305 bytes
 source/adminguide/storage.rst            |  32 +++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/source/_static/images/volume-metrics.png 
b/source/_static/images/volume-metrics.png
new file mode 100644
index 0000000..c857260
Binary files /dev/null and b/source/_static/images/volume-metrics.png differ
diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst
index e92d9ef..109927b 100644
--- a/source/adminguide/storage.rst
+++ b/source/adminguide/storage.rst
@@ -698,6 +698,36 @@ determine when the physical deletion of volumes will occur.
 Administrators should adjust these values depending on site policies
 around data retention.
 
+Volume Metrics
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Volume statistics are collected on a regular interval (defined by global
+setting volume.stats.interval with a default of 600 seconds). 
+This feature is currently only available for VMware and KVM. 
+Volume stats include include bytes/s and IO/s statistics as shown in the
+API output bellow.
+
+.. code:: bash
+
+   [root@mgmt]# cmk list volumesmetrics id=272c3d8b-ef2c-499e-abfb-736b54d3d6b1
+   {
+   "count": 1,
+   "volume": [
+      {
+         ...
+         "diskiopstotal": 30245,
+         "diskioread": 22443,
+         "diskiowrite": 7802,
+         "diskkbsread": 343124,
+         "diskkbswrite": 217619,
+         ...
+Bytes read/write, as well as the total IO/s, are exposed via UI, as shown in 
the image below.
+
+|volume-metrics.png|
+
+These statistics are obtained from the hypervisor directly and they represent
+"current" bytes/s and IO/s values at the time of collection.
+
 
 Working with Volume Snapshots
 -----------------------------
@@ -910,5 +940,7 @@ and use the resource group name you added in the LINSTOR 
cluster.
    :alt: Detach Disk Button.
 .. |Migrateinstance.png| image:: /_static/images/migrate-instance.png
    :alt: button to migrate a volume.
+.. |volume-metrics.png| image:: /_static/images/volume-metrics.png
+   :alt: Volume metrics   
 .. |volume-from-snap.png| image:: /_static/images/volume-from-snap.png
    :alt: Offering is needed when creating a volume from the ROOT volume 
snapshot.

Reply via email to