From 2ddb1e4746d73d6e2293124f30db940ae5c29038 Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Thu, 5 Sep 2024 16:32:37 +0200 Subject: [PATCH 1/9] Added configuration elements. --- articles/vmhostd.asm.xml | 202 +++++++++++++++++++++++++++ concepts/vmhostd_about.xml | 40 ++++++ references/vhostmd_configuration.xml | 92 ++++++++++++ 3 files changed, 334 insertions(+) create mode 100644 articles/vmhostd.asm.xml create mode 100644 concepts/vmhostd_about.xml create mode 100644 references/vhostmd_configuration.xml diff --git a/articles/vmhostd.asm.xml b/articles/vmhostd.asm.xml new file mode 100644 index 000000000..dc291397d --- /dev/null +++ b/articles/vmhostd.asm.xml @@ -0,0 +1,202 @@ + + + + + %entities; +]> + + + + + + + + + + Glue example + + + Glue for more information + + + Glue what's next + + + + + + Concept example + + + + + + Task example + + + + + + Reference example + + + + + + Legal Notice + + + GNU Free Documentation License + + + + + + Setting Up Virtual Host Metrics Daemon on &productname; + Subtitle if necessary + + + + 2024-11-14 + + + + Initial version. + + + + + + + + + + + + + + + + &x86-64; + &power; + + + + &productname; + + short title for SEO and social media, max. 55 chars + short description, max. 150 chars + ultrashort description for social media, max 55 chars + + + Systems Management + + + + Configuration + Installation + + Products & Solutions + + + + https://bugzilla.suse.com/enter_bug.cgi + Smart Docs + Documentation + + maintainer@suse.com + + yes + + + + + WHAT? + + + Describe your topic in one sentence. + + + + + WHY? + + + State the reason why one should read this. + + + + + EFFORT + + + What's the effort one has to put in? + + + + + GOAL + + + What's the reader's take-away from this article? + + + + + REQUIREMENTS + + + + + List the requirements to accomplish the task(s) described below. + + + + + + + + + + + + + + + + You are a very special concept now! + + + + + + + + + + + + diff --git a/concepts/vmhostd_about.xml b/concepts/vmhostd_about.xml new file mode 100644 index 000000000..d44c66c07 --- /dev/null +++ b/concepts/vmhostd_about.xml @@ -0,0 +1,40 @@ + + + + + %entities; +]> + + + + + + + What is virtual host metrics daemon aka <literal>vhostmd</literal>? + + + + + + + + + +vhostdmd is a daemon that runs in a host environment and provides a metrics +communication channel between the host and guest machines. The daemon provides a limited set of +host resources consumption to the guest machine administrator, to help analyse problems with the +guest machine. + + + vhostdmd writes metrics periodically to a disk. What is to record, the + frequency and location are adjustable parameters. The data can be read as read-only on the guest if desired. + + diff --git a/references/vhostmd_configuration.xml b/references/vhostmd_configuration.xml new file mode 100644 index 000000000..6362c2f4b --- /dev/null +++ b/references/vhostmd_configuration.xml @@ -0,0 +1,92 @@ + + + + + %entities; +]> + + + + + + + Configuration of <literal>vhostmd</literal> + + + + + Introductory text + + + + + The default configuration file of vhostmd is located in + /etc/vhostmd/vhostmd.conf. The configuration file is an XML file that must + include the <vhostmd> element. <vhostmd> then + includes <globals> and <metrics> that are described in following sections: + + +
+ The <literal><globals></literal> element + + The <globals> element defines the disk where to store data, how often are the data updated and how are + transported to guest machines. It contains the following elements: + + + + + <disk> + + +The element is used to define the path of the disk where metrics data is stored and also the size +of disk. It may contain the following elements: + + + + + <name> - defines a name of the disk + + + + + <path> - an absolute path where the disk is mounted + + + + + <size> - using the unit attribute specify + how big the metrics should be. Use k for KB, m + for MB. + + + + + + + <update_period> + + + Defines how often are the metric updated. The value is in seconds. + + + + + <transport> + + + Specify how the metrics are transported to guest machines. In case of &productname;, use + the default of virtio. + + + + +
+ From de5071c710f58cfafeb8907aaa650704c3bd5b6f Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Fri, 6 Sep 2024 14:34:41 +0200 Subject: [PATCH 2/9] Added metrics atributes. --- references/vhostmd_configuration.xml | 65 ++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/references/vhostmd_configuration.xml b/references/vhostmd_configuration.xml index 6362c2f4b..07bc6a938 100644 --- a/references/vhostmd_configuration.xml +++ b/references/vhostmd_configuration.xml @@ -87,6 +87,71 @@ of disk. It may contain the following elements: + + <virtio> + + +Here you can use the following elements: + + + + + <max_channels> - specify the maximum number virtio can use + between the host and guest systems. + + + + + <expiration_time> + + + + + +
+ The <literal><metrics></literal> element + + The <metrics> contains a list of metrics to be collected. Each + metric has two attributes: + + + + type + + +Describes the metrics value data type. Possible values are the following: int32, +uint32, int64, uint64, +real32, real64, string, +group and xml. + + + Use group when a metrics returns several values. + xml is a versatile form when the metric returns a valid XML. + + + + + context + + + Defines where the particular metric is collected. Possible values are: + + + + + host for metrics collected on the host machine + + + + + vm for metrics collected on the guest machine. + + + + + + +
From 616ec9c216132cf71b6cb6bdcdc293f483e08f19 Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Mon, 9 Sep 2024 15:43:06 +0200 Subject: [PATCH 3/9] Completed the vhostmd configuration. --- references/vhostmd_configuration.xml | 57 ++++++++++++++++++++++++++-- 1 file changed, 54 insertions(+), 3 deletions(-) diff --git a/references/vhostmd_configuration.xml b/references/vhostmd_configuration.xml index 07bc6a938..b1b6d8b77 100644 --- a/references/vhostmd_configuration.xml +++ b/references/vhostmd_configuration.xml @@ -31,7 +31,9 @@ The default configuration file of vhostmd is located in /etc/vhostmd/vhostmd.conf. The configuration file is an XML file that must include the <vhostmd> element. <vhostmd> then - includes <globals> and <metrics> that are described in following sections: + includes <globals> and <metrics> that are + described in following sections. You can use the default configuration file as a reference for + custom changes.
@@ -102,7 +104,9 @@ Here you can use the following elements: - <expiration_time> + <expiration_time> - defines the time interval after which a + virtio channel of a virtual machine is closed when being idle. The default values is + three times as <update_period>. @@ -153,5 +157,52 @@ Describes the metrics value data type. Possible values are the following: -
+ + + Each metric must have a unique name and a command to run to record the metrics. The following + list describes possible elements to define a metric: + + + + <name> + + +defines the variable unique name + + + + + <action> + + +specify a command or script to tun to collect a metric. For example, to gather total CPU time, use: + + <action>virsh dominfo NAME | sed 's/: */:/' | \ + gawk -F: '/CPU time/ {print $2;}'<action> + + + + <variable> + + + if an action retuns a group of values, define variables that store particular data. The + element needs to have defined the following attributes: + + + + + name - specify the name of a variable + + + + + type - specify the data type of the variable + + + + + + + + From 4f44b95faca79c46d8e89de7dcb898a556bdf644 Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Tue, 10 Sep 2024 15:47:41 +0200 Subject: [PATCH 4/9] Added installation and DC file. --- DC-Micro-vhostmd | 8 ++ articles/{vmhostd.asm.xml => vhostmd.asm.xml} | 51 ++++++----- .../{vmhostd_about.xml => vhostmd_about.xml} | 0 tasks/vhostmd_installation.xml | 91 +++++++++++++++++++ 4 files changed, 126 insertions(+), 24 deletions(-) create mode 100644 DC-Micro-vhostmd rename articles/{vmhostd.asm.xml => vhostmd.asm.xml} (83%) rename concepts/{vmhostd_about.xml => vhostmd_about.xml} (100%) create mode 100644 tasks/vhostmd_installation.xml diff --git a/DC-Micro-vhostmd b/DC-Micro-vhostmd new file mode 100644 index 000000000..4a44c6f8a --- /dev/null +++ b/DC-Micro-vhostmd @@ -0,0 +1,8 @@ +MAIN="vhostmd.asm.xml" +SRC_DIR="articles" +IMG_SRC_DIR="images" + +STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns" +DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat" +PROFOS="slmicro" +PROFCONDITION="alp-deployment-all" \ No newline at end of file diff --git a/articles/vmhostd.asm.xml b/articles/vhostmd.asm.xml similarity index 83% rename from articles/vmhostd.asm.xml rename to articles/vhostmd.asm.xml index dc291397d..99cd5ece3 100644 --- a/articles/vmhostd.asm.xml +++ b/articles/vhostmd.asm.xml @@ -19,33 +19,24 @@ --> - - - Glue example - - - Glue for more information - - - Glue what's next - + - - Concept example + + About vhostmd - - Task example + + Installation - - Reference example + + Configuring vhostmd @@ -127,7 +118,7 @@ Smart Docs Documentation - maintainer@suse.com + jsindelarova@suse.com yes @@ -183,17 +174,29 @@ - + + + + + + + - + - You are a very special concept now! + + + - - - - + + + + + + + + diff --git a/concepts/vmhostd_about.xml b/concepts/vhostmd_about.xml similarity index 100% rename from concepts/vmhostd_about.xml rename to concepts/vhostmd_about.xml diff --git a/tasks/vhostmd_installation.xml b/tasks/vhostmd_installation.xml new file mode 100644 index 000000000..3fda1cbbd --- /dev/null +++ b/tasks/vhostmd_installation.xml @@ -0,0 +1,91 @@ + + + + + %entities; +]> + + + + + + + Getting <literal>vhostmd</literal> + + + + + The topic covers installation of vmhostmd on &productname;. + + + + + By default, vhostmd is not present on the delivered images. So to use it, + you need to install it and then proceed as follows: + + + + + Install the daemon by running: + + + &prompt.sudo;transactional-update pkg install vhostmd + + + + + Reboot your system to switch to the new snapshot. + + + + + Start the daemon by running: + + +&prompt.sudo;vhostmd OPTIONS + + + You can use the following options to modify the command behavior: + + + + + -v - for a verbose output + + + + --connect URI - to pass URI of the + libvirt daemon to establish connections to the daemon + + + + -f FILE_PATH - to pass an alternative + configuration file. For details regarding configuration, refer to . + + + + + -p PID_FILE - to create an alternative + PID file. The default is /var/run/vhostmd.pid + + + + + -u USERNAME - to use a nonprivileged user. + + + + + + + + From a7e1b4521d3e37b201ee7505931ea382000cf986 Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Thu, 12 Sep 2024 13:19:18 +0200 Subject: [PATCH 5/9] Completed the article. --- articles/vhostmd.asm.xml | 29 +++++++--- concepts/vhostmd_about.xml | 6 +-- concepts/vhostmd_data_format.xml | 41 +++++++++++++++ references/vhostmd_configuration.xml | 6 ++- tasks/vhostmd_installation.xml | 4 +- tasks/vhostmd_providing_information.xml | 70 +++++++++++++++++++++++++ 6 files changed, 143 insertions(+), 13 deletions(-) create mode 100644 concepts/vhostmd_data_format.xml create mode 100644 tasks/vhostmd_providing_information.xml diff --git a/articles/vhostmd.asm.xml b/articles/vhostmd.asm.xml index 99cd5ece3..8278f6c73 100644 --- a/articles/vhostmd.asm.xml +++ b/articles/vhostmd.asm.xml @@ -19,8 +19,7 @@ --> - - + @@ -32,6 +31,9 @@ Installation + + Pass metrics to VM + @@ -128,7 +130,8 @@ WHAT? - Describe your topic in one sentence. + vhostmd is a tool that collects metrics on a virtual machine host + and can provide those metrics to virtual machines running on that host. @@ -136,7 +139,8 @@ WHY? - State the reason why one should read this. + The article describes how to install and configure vhostmd to + enable you collecting metrics. @@ -152,7 +156,7 @@ GOAL - What's the reader's take-away from this article? + You will have the vhostmd tool running and collecting metrics. @@ -162,7 +166,12 @@ - List the requirements to accomplish the task(s) described below. + a running instance of &productname; + + + + + virtual machines running on that instance @@ -189,6 +198,14 @@ + + + + + + + + diff --git a/concepts/vhostmd_about.xml b/concepts/vhostmd_about.xml index d44c66c07..b819ab24e 100644 --- a/concepts/vhostmd_about.xml +++ b/concepts/vhostmd_about.xml @@ -10,7 +10,7 @@ - vhostdmd is a daemon that runs in a host environment and provides a metrics communication channel between the host and guest machines. The daemon provides a limited set of -host resources consumption to the guest machine administrator, to help analyse problems with the +host resources consumption to the guest machine administrator (susually in a read-only mode), to help analyse problems with the guest machine. vhostdmd writes metrics periodically to a disk. What is to record, the - frequency and location are adjustable parameters. The data can be read as read-only on the guest if desired. + frequency and location of the stored data are adjustable parameters. diff --git a/concepts/vhostmd_data_format.xml b/concepts/vhostmd_data_format.xml new file mode 100644 index 000000000..a66c3f70a --- /dev/null +++ b/concepts/vhostmd_data_format.xml @@ -0,0 +1,41 @@ + + + + + %entities; +]> + + + + + + + How are the collected metrics stored? + + + + + The topic covers details about the data format of metrics and also how the output in XML + looks like. + + + + + vhostmd stores the collected metrics data on the metrics disk in a raw + format. The disk contains 32bytes header followed by the metrics data. + +
+Metrics XML format + + If you configured that a + +
+ diff --git a/references/vhostmd_configuration.xml b/references/vhostmd_configuration.xml index b1b6d8b77..781427027 100644 --- a/references/vhostmd_configuration.xml +++ b/references/vhostmd_configuration.xml @@ -29,7 +29,7 @@ The default configuration file of vhostmd is located in - /etc/vhostmd/vhostmd.conf. The configuration file is an XML file that must + /etc/vhostmd/vhostmd.conf. Yoy can adjust this files to suit yor needs. The configuration file is an XML file that must include the <vhostmd> element. <vhostmd> then includes <globals> and <metrics> that are described in following sections. You can use the default configuration file as a reference for @@ -167,7 +167,9 @@ Describes the metrics value data type. Possible values are the following: <name> -defines the variable unique name +defines the variable unique name. If the metrics is collected on a virtual machine, you can use the +following values here: NAME, ID, and UUID. +Those values are then replaced with actual ones of the virtual machine currently being checked. diff --git a/tasks/vhostmd_installation.xml b/tasks/vhostmd_installation.xml index 3fda1cbbd..bfb83e628 100644 --- a/tasks/vhostmd_installation.xml +++ b/tasks/vhostmd_installation.xml @@ -30,7 +30,7 @@ in the assembly --> By default, vhostmd is not present on the delivered images. So to use it, - you need to install it and then proceed as follows: + you need to install it first: @@ -80,7 +80,7 @@ in the assembly --> - -u USERNAME - to use a nonprivileged user. + -u USERNAME - to use a non-privileged user. diff --git a/tasks/vhostmd_providing_information.xml b/tasks/vhostmd_providing_information.xml new file mode 100644 index 000000000..6dad4e7b8 --- /dev/null +++ b/tasks/vhostmd_providing_information.xml @@ -0,0 +1,70 @@ + + + + + %entities; +]> + + + + + + + Providing collected metrics to a virtual machine + + + + + The topic covers steps to make collected metrics visible to a virtual machine. + + + + + You can make the collected metrics vsible to particular virtual machines for further usage or + just for reading. There are two ways to achieve this. Either you can atach the metrics disk using the &virsh; command or + you can adjust the domain configuration. + + + To attach the metrics disk in a read-only mode, run &virsh; as follows: + + +&prompt.sudo;virsh attach-disk VIRTUAL_MACHINE \ + PATH_TO_METRICS_DISC --driver tap \ + --subdriver aio --type disk --mode readonly + + + + To change the domain configuration, proceed as follows: + + + + Run the command + &prompt.sudo;virsh edit + GUEST_NAME + + + + Update the <devices> section by adding the following snippet: + + +<disk type='block' device='disk'> + <source dev='/dev/shm/vhostmd0'/> + <target dev='hdb' bus='ide'/> + <readonly/> +</disk> + + + Adjust the dev and dbus valuse of the target. + + + + From 45b2e0a472ad39cb45be306b8dcdf59f432a7f9e Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Fri, 13 Sep 2024 15:01:16 +0200 Subject: [PATCH 6/9] Completed output format description. --- articles/vhostmd.asm.xml | 36 ++++++++----- concepts/vhostmd_data_format.xml | 89 +++++++++++++++++++++++++++++++- 2 files changed, 111 insertions(+), 14 deletions(-) diff --git a/articles/vhostmd.asm.xml b/articles/vhostmd.asm.xml index 8278f6c73..a82349074 100644 --- a/articles/vhostmd.asm.xml +++ b/articles/vhostmd.asm.xml @@ -25,6 +25,9 @@ About vhostmd + + Metrics format + @@ -51,14 +54,13 @@ - + - Setting Up Virtual Host Metrics Daemon on &productname; - Subtitle if necessary + Setting Up Virtual Host Metrics Daemon on &productname; - - 2024-11-14 + + 2024-10-14 @@ -72,7 +74,7 @@ - + &productname; - short title for SEO and social media, max. 55 chars - short description, max. 150 chars - ultrashort description for social media, max 55 chars + Setting Up Virtual Host Metrics Daemon + vhostmd is a tool that collects metrics on a virtual machine host + and can provide those metrics to virtual machines running on that host. + vhostmd is a tool to collect metrics. Systems Management @@ -117,8 +121,8 @@ https://bugzilla.suse.com/enter_bug.cgi - Smart Docs - Documentation + Documentation + SUSE Linux Enterprise Micro 6.1 jsindelarova@suse.com @@ -148,7 +152,7 @@ EFFORT - What's the effort one has to put in? + It takes approximately 15 minutes to read the article. @@ -213,6 +217,14 @@ + + + + + + + + diff --git a/concepts/vhostmd_data_format.xml b/concepts/vhostmd_data_format.xml index a66c3f70a..39d78ebf4 100644 --- a/concepts/vhostmd_data_format.xml +++ b/concepts/vhostmd_data_format.xml @@ -30,12 +30,97 @@ vhostmd stores the collected metrics data on the metrics disk in a raw - format. The disk contains 32bytes header followed by the metrics data. + format. The disk contains 32bytes header followed by the metrics data in XML format.
Metrics XML format - If you configured that a + The collected metrics results are similar to the configured metrics definition. The <metric> + element can have the following attirbutes: + + + type + + + Denotes the data type of the particular metric, for example string. + + + + + context + + + Identifies whether the metric is collected on the host (host) or on a virtual machine (vm). + + + + + id + + + Used in the vm context. Conveys the ID number of the virtual machine. + + + + + uuid + + + Used in the vm context. Conveys the Universally Unique Identifier of the virtual machine. + + + + + + The <metric> element contains the following elements: + + + + <name> + + + Conveys the metric name. + + + + + <value> + + + Conveys the metrics actual value. + + + + + + No multiple values within one metric + + When the group type of a metric has been configured, each configured <variable> is stored + as a separate metric in the result. For example, the following configuration snippet: + + +<metric type="group" context="host"> + <name>PageRates</name> + <action>pagerate.pl</action> + <variable name="PageInRate" type="uint64"/> + <variable name="PageFaultRate" type="uint64"/> +</metric> + + + Results in the following snippet: + + +<metric type='uint64' context='host'> + <name>PageInRate</name> + <value>0.000000</value> +</metric> +<metric type='uint64' context='host'> + <name>PageFaultRate</name> + <value>0.000000</value> +</metric> + + +
From 116f6e8de297bdd88c2e600aec9898c6b92540ae Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Mon, 23 Sep 2024 11:59:35 +0200 Subject: [PATCH 7/9] Applied review. --- articles/vhostmd.asm.xml | 2 +- concepts/vhostmd_about.xml | 6 +++--- references/vhostmd_configuration.xml | 6 +++--- tasks/vhostmd_installation.xml | 18 ++++++++++++++++++ tasks/vhostmd_providing_information.xml | 6 +++--- 5 files changed, 28 insertions(+), 10 deletions(-) diff --git a/articles/vhostmd.asm.xml b/articles/vhostmd.asm.xml index a82349074..347911de9 100644 --- a/articles/vhostmd.asm.xml +++ b/articles/vhostmd.asm.xml @@ -144,7 +144,7 @@ The article describes how to install and configure vhostmd to - enable you collecting metrics. + enable collecting metrics. diff --git a/concepts/vhostmd_about.xml b/concepts/vhostmd_about.xml index b819ab24e..0de486aba 100644 --- a/concepts/vhostmd_about.xml +++ b/concepts/vhostmd_about.xml @@ -30,11 +30,11 @@ vhostdmd is a daemon that runs in a host environment and provides a metrics communication channel between the host and guest machines. The daemon provides a limited set of -host resources consumption to the guest machine administrator (susually in a read-only mode), to help analyse problems with the +host resources consumption to the guest machine administrator (usually in a read-only mode), to help analyse problems with the guest machine. - vhostdmd writes metrics periodically to a disk. What is to record, the - frequency and location of the stored data are adjustable parameters. + vhostdmd writes metrics periodically to a disk. Which metrics to collect, the + frequency and location of the stored data are configurable parameters. diff --git a/references/vhostmd_configuration.xml b/references/vhostmd_configuration.xml index 781427027..e834b3b21 100644 --- a/references/vhostmd_configuration.xml +++ b/references/vhostmd_configuration.xml @@ -23,13 +23,13 @@ - Introductory text + The topic covers the configuration of metrics and data location. The default configuration file of vhostmd is located in - /etc/vhostmd/vhostmd.conf. Yoy can adjust this files to suit yor needs. The configuration file is an XML file that must + /etc/vhostmd/vhostmd.conf. You can adjust this files to suit your needs. The configuration file is an XML file that must include the <vhostmd> element. <vhostmd> then includes <globals> and <metrics> that are described in following sections. You can use the default configuration file as a reference for @@ -76,7 +76,7 @@ of disk. It may contain the following elements: <update_period> - Defines how often are the metric updated. The value is in seconds. + Defines how often the metrics are updated. The value is in seconds. diff --git a/tasks/vhostmd_installation.xml b/tasks/vhostmd_installation.xml index bfb83e628..058e65982 100644 --- a/tasks/vhostmd_installation.xml +++ b/tasks/vhostmd_installation.xml @@ -86,6 +86,24 @@ in the assembly --> + + + You can run vhostmd also as &systemd; sevice: + + +&prompt.sudo;systemctl enable --now vhostmd + + + + Service restart needed after configuration changes + + Whenever you perform changes to configuration as described in , restart the vhostmd service as follows: + + + &prompt.sudo;systemctl restart vhostmd + + diff --git a/tasks/vhostmd_providing_information.xml b/tasks/vhostmd_providing_information.xml index 6dad4e7b8..f5384faaa 100644 --- a/tasks/vhostmd_providing_information.xml +++ b/tasks/vhostmd_providing_information.xml @@ -29,8 +29,8 @@ in the assembly --> - You can make the collected metrics vsible to particular virtual machines for further usage or - just for reading. There are two ways to achieve this. Either you can atach the metrics disk using the &virsh; command or + You can make the collected metrics visible to particular virtual machines for further usage or + just for reading. There are two ways to achieve this. Either you can attach the metrics disk using the &virsh; command or you can adjust the domain configuration. @@ -63,7 +63,7 @@ in the assembly --> </disk> - Adjust the dev and dbus valuse of the target. + Adjust the dev and dbus values of the target. From c589cca50361b06f09362b55b5952ceb79fe13b5 Mon Sep 17 00:00:00 2001 From: lvicoun Date: Tue, 24 Sep 2024 08:57:03 +0200 Subject: [PATCH 8/9] Apply suggestions from code review Co-authored-by: Daria Vladykina --- articles/vhostmd.asm.xml | 6 ++--- concepts/vhostmd_about.xml | 10 ++++---- concepts/vhostmd_data_format.xml | 10 ++++---- references/vhostmd_configuration.xml | 33 +++++++++++++------------ tasks/vhostmd_installation.xml | 22 ++++++++--------- tasks/vhostmd_providing_information.xml | 6 ++--- 6 files changed, 44 insertions(+), 43 deletions(-) diff --git a/articles/vhostmd.asm.xml b/articles/vhostmd.asm.xml index 347911de9..4105b61d6 100644 --- a/articles/vhostmd.asm.xml +++ b/articles/vhostmd.asm.xml @@ -59,12 +59,12 @@ Setting Up Virtual Host Metrics Daemon on &productname; - + 2024-10-14 - Initial version. + Initial version @@ -106,7 +106,7 @@ Setting Up Virtual Host Metrics Daemon vhostmd is a tool that collects metrics on a virtual machine host and can provide those metrics to virtual machines running on that host. - vhostmd is a tool to collect metrics. + vhostmd is a tool for collecting metrics Systems Management diff --git a/concepts/vhostmd_about.xml b/concepts/vhostmd_about.xml index 0de486aba..169b84a30 100644 --- a/concepts/vhostmd_about.xml +++ b/concepts/vhostmd_about.xml @@ -18,7 +18,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:trans="http://docbook.org/ns/transclusion"> - What is virtual host metrics daemon aka <literal>vhostmd</literal>? + What is a virtual host metrics daemon aka <literal>vhostmd</literal>? @@ -28,10 +28,10 @@ -vhostdmd is a daemon that runs in a host environment and provides a metrics -communication channel between the host and guest machines. The daemon provides a limited set of -host resources consumption to the guest machine administrator (usually in a read-only mode), to help analyse problems with the -guest machine. +vhostmd is a daemon that runs in a host environment and provides a metrics +communication channel between the host and guest machines. The daemon provides the guest +machine administrator with a limited set of host resource usage data (usually in read-only mode), +to help analyze issues with the guest machine. vhostdmd writes metrics periodically to a disk. Which metrics to collect, the diff --git a/concepts/vhostmd_data_format.xml b/concepts/vhostmd_data_format.xml index 39d78ebf4..97acfdd7d 100644 --- a/concepts/vhostmd_data_format.xml +++ b/concepts/vhostmd_data_format.xml @@ -23,27 +23,27 @@ - The topic covers details about the data format of metrics and also how the output in XML - looks like. + The topic provides details on the metrics data format and XML output + structure. vhostmd stores the collected metrics data on the metrics disk in a raw - format. The disk contains 32bytes header followed by the metrics data in XML format. + format. The disk contains a 32-byte header followed by the metrics data in XML format.
Metrics XML format The collected metrics results are similar to the configured metrics definition. The <metric> - element can have the following attirbutes: + element can have the following attributes: type - Denotes the data type of the particular metric, for example string. + Denotes the data type of the particular metric, for example, string. diff --git a/references/vhostmd_configuration.xml b/references/vhostmd_configuration.xml index e834b3b21..09c09acfc 100644 --- a/references/vhostmd_configuration.xml +++ b/references/vhostmd_configuration.xml @@ -29,10 +29,10 @@ The default configuration file of vhostmd is located in - /etc/vhostmd/vhostmd.conf. You can adjust this files to suit your needs. The configuration file is an XML file that must + /etc/vhostmd/vhostmd.conf. You can adjust this file to suit your needs. The configuration file is an XML file that must include the <vhostmd> element. <vhostmd> then includes <globals> and <metrics> that are - described in following sections. You can use the default configuration file as a reference for + described in the following sections. Use the default configuration file as a reference for custom changes. @@ -49,24 +49,24 @@ The element is used to define the path of the disk where metrics data is stored and also the size -of disk. It may contain the following elements: +of the disk. It may contain the following elements: - <name> - defines a name of the disk + <name> — defines the name of the disk - <path> - an absolute path where the disk is mounted + <path> — an absolute path where the disk is mounted - <size> - using the unit attribute specify - how big the metrics should be. Use k for KB, m - for MB. + <size> — using the unit attribute, + specify the maximum size of the metrics. Use k for KB, + m for MB. @@ -84,8 +84,8 @@ of disk. It may contain the following elements: <transport> - Specify how the metrics are transported to guest machines. In case of &productname;, use - the default of virtio. + Specifies how the metrics are transported to guest machines. In the case of + &productname;, use the default of virtio. @@ -117,7 +117,7 @@ Here you can use the following elements:
The <literal><metrics></literal> element - The <metrics> contains a list of metrics to be collected. Each + The <metrics> element contains a list of metrics to be collected. Each metric has two attributes: @@ -131,7 +131,7 @@ Describes the metrics value data type. Possible values are the following: group and xml. - Use group when a metrics returns several values. + Use group when a metric returns several values. xml is a versatile form when the metric returns a valid XML. @@ -150,7 +150,7 @@ Describes the metrics value data type. Possible values are the following: - vm for metrics collected on the guest machine. + vm for metrics collected on the guest machine @@ -177,7 +177,8 @@ Those values are then replaced with actual ones of the virtual machine currently <action> -specify a command or script to tun to collect a metric. For example, to gather total CPU time, use: +Specifies a command or script to run to collect a metric. For example, +to gather total CPU time, use: <action>virsh dominfo NAME | sed 's/: */:/' | \ gawk -F: '/CPU time/ {print $2;}'<action> @@ -193,12 +194,12 @@ specify a command or script to tun to collect a metric. For example, to gather t - name - specify the name of a variable + name — specify the name of a variable - type - specify the data type of the variable + type — specify the data type of the variable diff --git a/tasks/vhostmd_installation.xml b/tasks/vhostmd_installation.xml index 058e65982..ea3ecf29c 100644 --- a/tasks/vhostmd_installation.xml +++ b/tasks/vhostmd_installation.xml @@ -24,13 +24,13 @@ in the assembly --> - The topic covers installation of vmhostmd on &productname;. + The topic covers installation of vhostmd on &productname;. - By default, vhostmd is not present on the delivered images. So to use it, - you need to install it first: + By default, vhostmd is not included in the delivered + images. Therefore, you must install it before using it: @@ -38,7 +38,7 @@ in the assembly --> Install the daemon by running: - &prompt.sudo;transactional-update pkg install vhostmd +&prompt.sudo;transactional-update pkg install vhostmd @@ -59,7 +59,7 @@ in the assembly --> - -v - for a verbose output + -v — for a verbose output @@ -68,19 +68,19 @@ in the assembly --> - -f FILE_PATH - to pass an alternative + -f FILE_PATH — to pass an alternative configuration file. For details regarding configuration, refer to . - -p PID_FILE - to create an alternative - PID file. The default is /var/run/vhostmd.pid + -p PID_FILE — to create an alternative + PID file. The default is /var/run/vhostmd.pid. - -u USERNAME - to use a non-privileged user. + -u USERNAME — to use a non-privileged user @@ -88,7 +88,7 @@ in the assembly --> - You can run vhostmd also as &systemd; sevice: + You can also run vhostmd as &systemd; service: &prompt.sudo;systemctl enable --now vhostmd @@ -101,7 +101,7 @@ in the assembly --> linkend="vhostmd-configuration"/>, restart the vhostmd service as follows: - &prompt.sudo;systemctl restart vhostmd +&prompt.sudo;systemctl restart vhostmd diff --git a/tasks/vhostmd_providing_information.xml b/tasks/vhostmd_providing_information.xml index f5384faaa..36859d3b9 100644 --- a/tasks/vhostmd_providing_information.xml +++ b/tasks/vhostmd_providing_information.xml @@ -29,9 +29,9 @@ in the assembly --> - You can make the collected metrics visible to particular virtual machines for further usage or - just for reading. There are two ways to achieve this. Either you can attach the metrics disk using the &virsh; command or - you can adjust the domain configuration. + You can make the collected metrics visible to particular virtual machines for further use or + just for reading. There are two ways to achieve this. You can either attach the + metrics disk using the &virsh; command or adjust the domain configuration. To attach the metrics disk in a read-only mode, run &virsh; as follows: From 0c7589c74d83852362e7f3a86a05054f77b3545f Mon Sep 17 00:00:00 2001 From: Jana Halackova Date: Tue, 24 Sep 2024 13:12:27 +0200 Subject: [PATCH 9/9] Applied review. --- articles/vhostmd.asm.xml | 10 +++++----- concepts/vhostmd_about.xml | 5 +++-- references/vhostmd_configuration.xml | 21 +++++++++++---------- tasks/vhostmd_installation.xml | 4 ++-- 4 files changed, 21 insertions(+), 19 deletions(-) diff --git a/articles/vhostmd.asm.xml b/articles/vhostmd.asm.xml index 4105b61d6..829f58c73 100644 --- a/articles/vhostmd.asm.xml +++ b/articles/vhostmd.asm.xml @@ -54,7 +54,7 @@ - + Setting Up Virtual Host Metrics Daemon on &productname; @@ -104,8 +104,8 @@ &productname; Setting Up Virtual Host Metrics Daemon - vhostmd is a tool that collects metrics on a virtual machine host - and can provide those metrics to virtual machines running on that host. + vhostmd is a tool that collects metrics from a virtual machine host + and provides these metrics to virtual machines running on that host. vhostmd is a tool for collecting metrics @@ -134,8 +134,8 @@ WHAT? - vhostmd is a tool that collects metrics on a virtual machine host - and can provide those metrics to virtual machines running on that host. + vhostmd is a tool that collects metrics from a virtual machine host + and can provide these metrics to the virtual machines running on that host. diff --git a/concepts/vhostmd_about.xml b/concepts/vhostmd_about.xml index 169b84a30..d8c3dc298 100644 --- a/concepts/vhostmd_about.xml +++ b/concepts/vhostmd_about.xml @@ -34,7 +34,8 @@ machine administrator with a limited set of host resource usage data (usually in to help analyze issues with the guest machine. - vhostdmd writes metrics periodically to a disk. Which metrics to collect, the - frequency and location of the stored data are configurable parameters. + vhostdmd periodically writes metrics to a disk. The metrics to be + collected, along with the + frequency and storage location of the data, are configurable parameters. diff --git a/references/vhostmd_configuration.xml b/references/vhostmd_configuration.xml index 09c09acfc..485fdfc93 100644 --- a/references/vhostmd_configuration.xml +++ b/references/vhostmd_configuration.xml @@ -39,8 +39,9 @@
The <literal><globals></literal> element - The <globals> element defines the disk where to store data, how often are the data updated and how are - transported to guest machines. It contains the following elements: + The <globals> element defines the disk storage location, data update + frequency and the method of transporting data + to guest machines. It contains the following elements: @@ -98,15 +99,15 @@ Here you can use the following elements: - <max_channels> - specify the maximum number virtio can use + <max_channels>—specifies the maximum number virtion can use between the host and guest systems. - <expiration_time> - defines the time interval after which a - virtio channel of a virtual machine is closed when being idle. The default values is - three times as <update_period>. + <expiration_time>—defines the time interval after which a + virtio channel of a virtual machine is closed when being idle. The default value is + three times the <update_period>. @@ -167,9 +168,9 @@ Describes the metrics value data type. Possible values are the following: <name> -defines the variable unique name. If the metrics is collected on a virtual machine, you can use the -following values here: NAME, ID, and UUID. -Those values are then replaced with actual ones of the virtual machine currently being checked. +Defines the unique variable name. If the metric is collected on a virtual machine, you can use the +following values here: NAME, ID and UUID. +Those values are then replaced with the actual ones of the virtual machine currently being checked. @@ -189,7 +190,7 @@ to gather total CPU time, use: if an action retuns a group of values, define variables that store particular data. The - element needs to have defined the following attributes: + element needs to have the following attributes defined: diff --git a/tasks/vhostmd_installation.xml b/tasks/vhostmd_installation.xml index ea3ecf29c..74016d14c 100644 --- a/tasks/vhostmd_installation.xml +++ b/tasks/vhostmd_installation.xml @@ -63,8 +63,8 @@ in the assembly --> - --connect URI - to pass URI of the - libvirt daemon to establish connections to the daemon + --connect URI—to pass the URI of the + libvirt daemon to establish connections to the daemon