mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2025-02-22 03:12:22 +00:00
docs: Add at least some docs and fix schema entry for perf events
There was no documentation at all for the XML part. I added at least some. The 2.0.0 introduction date is deliberate as the parser for the XML is broken. The schema file was missing entries for 'mbml' and 'mbmt'.
This commit is contained in:
parent
da8285c44a
commit
c22dad33c2
@ -1822,6 +1822,50 @@
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h3><a name="elementsPerf">Performance monitoring events</a></h3>
|
||||
|
||||
<p>
|
||||
Some platforms allow monitoring of performance of the virtual machine and
|
||||
the code executed inside. To enable the performance monitoring events
|
||||
you can either specify them in the <code>perf</code> element or enable
|
||||
them via <code>virDomainSetPerfEvents</code> API. The performance values
|
||||
are then retrieved using the virConnectGetAllDomainStats API.
|
||||
<span class="since">Since 2.0.0</span>
|
||||
</p>
|
||||
|
||||
<pre>
|
||||
...
|
||||
<perf>
|
||||
<event name='cmt' enabled='yes'/>
|
||||
<event name='mbmt' enabled='no'/>
|
||||
<event name='mbml' enabled='yes'/>
|
||||
</perf>
|
||||
...
|
||||
</pre>
|
||||
|
||||
<table class="top_table">
|
||||
<tr>
|
||||
<th>event name</th>
|
||||
<th>Description</th>
|
||||
<th>stats parameter name</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>cmt</code></td>
|
||||
<td>usage of l3 cache in bytes by applications running on the platform</td>
|
||||
<td><code>perf.cmt</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mbmt</code></td>
|
||||
<td>total system bandwidth from one level of cache</td>
|
||||
<td><code>perf.mbmt</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mbml</code></td>
|
||||
<td>bandwidth of memory traffic for a memory controller</td>
|
||||
<td><code>perf.mbml</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3><a name="elementsDevices">Devices</a></h3>
|
||||
|
||||
<p>
|
||||
|
@ -412,6 +412,8 @@
|
||||
<attribute name="name">
|
||||
<choice>
|
||||
<value>cmt</value>
|
||||
<value>mbmt</value>
|
||||
<value>mbml</value>
|
||||
</choice>
|
||||
</attribute>
|
||||
<attribute name="enabled">
|
||||
|
Loading…
x
Reference in New Issue
Block a user