Browse Source

[Docs] kvm plugin documentation

This patch adds usage docs for the kvm plugin.

Change-Id: I6a28ae46f10bf97bcbe504e40353a2b0f3f8fe87
Major Hayden 2 years ago
parent
commit
137a0f5cf9
No account linked to committer's email address
1 changed files with 41 additions and 0 deletions
  1. 41
    0
      doc/source/plugins-base/plugin-kvm.rst

+ 41
- 0
doc/source/plugins-base/plugin-kvm.rst View File

@@ -0,0 +1,41 @@
1
+``kvm`` - get details from running KVM instances
2
+================================================
3
+
4
+The KVM plugin connects to libvirt and retrieves details about KVM instances on
5
+the system. It returns basic information, including:
6
+
7
+* number of instances on the host (``kvm_vms``)
8
+* total number of virtual CPUs that libvirt can use (``kvm_total_vcpus``)
9
+* the total number of virtual CPUs scheduled (``kvm_scheduled_vcpus``)
10
+
11
+Usage
12
+-----
13
+
14
+This plugin takes no arguments.
15
+
16
+Example
17
+-------
18
+
19
+Run the plugin:
20
+
21
+.. code-block:: console
22
+
23
+    $ monitorstack kvm
24
+
25
+Example output in JSON format:
26
+
27
+.. code-block:: json
28
+
29
+    {
30
+      "variables": {
31
+        "kvm_vms": 1,
32
+        "kvm_scheduled_vcpus": 2,
33
+        "kvm_total_vcpus": 4
34
+      },
35
+      "meta": {
36
+        "kvm_host_id": 2046744907101423228
37
+      },
38
+      "message": "kvm is ok",
39
+      "exit_code": 0,
40
+      "measurement_name": "kvm"
41
+    }

Loading…
Cancel
Save