Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@scoopex
scoopex committed Nov 5, 2023
1 parent 7451091 commit 5b2d7f1
Show file tree
Hide file tree
Showing 8 changed files with 194 additions and 711 deletions.
512 changes: 0 additions & 512 deletions zabbix_templates/6.4/documentation/custom-os-kubernetes-node.html
View file

This file was deleted.

162 changes: 162 additions & 0 deletions zabbix_templates/6.4/documentation/custom-os-linux-disk-io-details.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<style type="text/css">

p.desc{
white-space:nowrap;
}

table.pretty {
margin: 1em 1em 1em 2em;
background: whitesmoke;
border-collapse: collapse;
}

table.pretty th, table.pretty td {
border: 1px gainsboro solid;
padding: 0.2em;
}

table.pretty th {
background: gainsboro;
text-align: left;
}

table.pretty caption {
margin-left: inherit;
margin-right: inherit;
white-space:nowrap;
}
</style>
<body>
<h2>Macro Overview</h2>

The following macros can be overloaded on host level.
<table class="pretty">
<tr>
<th>Name</th><th>Default</th>
</tr>
</table>
<h1>Static Elements</h1>
<h2>Trigger Overview</h2>
<table class="pretty">
<tr>
<th>Name</th><th>Description</th><th>Priority</th><th>Expression</th><th>Dependencies</th>
</tr>
</table>
<h2>Graph Overview</h2>
<table class="pretty">
<tr>
<th>Name</th><th>Elements</th>
</tr>
</table>
<h2>Item Overview</h2>
<table class="pretty">
<tr>
<th>Type</th><th>Name</th><th>Key</th><th>Description</th><th>Interval (sec)</th><th>History Days</th><th>Trend Days</th>
</tr>
</table>
<h1>Discovery rule "Disk IO detail discovery"</h1>
<table class="pretty">
<tr>
<th>Name</th><th>Value</th>
</tr>
<tr>
<td>Name</td><td>Disk IO detail discovery</td>
</tr>
<tr>
<td>Key</td><td>vfs.dev.discovery.detail</td>
</tr>
<tr>
<td>Type</td><td>ZABBIX_ACTIVE</td>
</tr>
<tr>
<td>Delay</td><td></td>
</tr>
</table>
<h2>Trigger Overview</h2>
<table class="pretty">
<tr>
<th>Name</th><th>Description</th><th>Priority</th><th>Expression</th><th>Dependencies</th>
</tr>
</table>
<h2>Graph Overview</h2>
<table class="pretty">
<tr>
<th>Name</th><th>Elements</th>
</tr>
<tr>
<td>IO: Activities</td><td><tt>custom.vfs.dev.io.active[{#BLOCKDEVICE}]<br>custom.vfs.dev.queue_depth[{#BLOCKDEVICE}]<br>
</tt></td>
</tr>
<tr>
<td>IO: Merged Operations</td><td><tt>custom.vfs.dev.read.merged[{#BLOCKDEVICE}]<br>custom.vfs.dev.write.merged[{#BLOCKDEVICE}]<br>
</tt></td>
</tr>
<tr>
<td>IO: Milleseconds spend in IO</td><td><tt>custom.vfs.dev.read.ms[{#BLOCKDEVICE}]<br>custom.vfs.dev.write.ms[{#BLOCKDEVICE}]<br>custom.vfs.dev.io.ms[{#BLOCKDEVICE}]<br>custom.vfs.dev.weight.io.ms[{#BLOCKDEVICE}]<br>
</tt></td>
</tr>
<tr>
<td>IO: Ops</td><td><tt>custom.vfs.dev.read.ops[{#BLOCKDEVICE}]<br>custom.vfs.dev.write.ops[{#BLOCKDEVICE}]<br>
</tt></td>
</tr>
<tr>
<td>IO: Transfer</td><td><tt>custom.vfs.dev.read.sectors[{#BLOCKDEVICE}]<br>custom.vfs.dev.write.sectors[{#BLOCKDEVICE}]<br>
</tt></td>
</tr>
</table>
<h2>Item Overview</h2>
<table class="pretty">
<tr>
<th>Type</th><th>Name</th><th>Key</th><th>Description</th><th>Interval (sec)</th><th>History Days</th><th>Trend Days</th>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Currently Active</td><td><tt>custom.vfs.dev.io.active[{#BLOCKDEVICE}]</tt></td><td>Number of I/Os currently in progress.
The only field that should go to zero. Incremented as requests are given to appropriate struct request_queue and decremented as they finish.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Milleseconds spend in IO</td><td><tt>custom.vfs.dev.io.ms[{#BLOCKDEVICE}]</tt></td><td>Number of milliseconds spent doing I/Os. This field increases so long as field #12 (custom.vfs.dev.io.active) is nonzero.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO:Queue Depth</td><td><tt>custom.vfs.dev.queue_depth[{#BLOCKDEVICE}]</tt></td><td>Number of I/Os currently in progress.&amp;#13;
The only field that should go to zero. Incremented as requests are given to appropriate struct request_queue and decremented as they finish.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Merged Reads</td><td><tt>custom.vfs.dev.read.merged[{#BLOCKDEVICE}]</tt></td><td>Number of reads merged.
Reads and writes which are adjacent to each other may be merged for efficiency. Thus two 4K reads may become one 8K read before it is ultimately handed to the disk, and so it will be counted (and queued) as only one I/O. This field lets you know how often this was done.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Milleseconds spend in Read IO</td><td><tt>custom.vfs.dev.read.ms[{#BLOCKDEVICE}]</tt></td><td>Number of milliseconds spent reading.
This is the total number of milliseconds spent by all reads (as measured from __make_request() to end_that_request_last()).</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Ops Read</td><td><tt>custom.vfs.dev.read.ops[{#BLOCKDEVICE}]</tt></td><td>This is the total number of reads completed successfully.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO Transfer Read</td><td><tt>custom.vfs.dev.read.sectors[{#BLOCKDEVICE}]</tt></td><td>This is the total number of sectors read successfully.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Milleseconds weighted spend in IO</td><td><tt>custom.vfs.dev.weight.io.ms[{#BLOCKDEVICE}]</tt></td><td>Weighted number of milliseconds spent doing I/Os.

This field is incremented at each I/O start, I/O completion, I/O merge, or read of these stats by the number of I/Os in progress (field 12) times the number of milliseconds spent doing I/O since the last update of this field. This can provide an easy measure of both I/O completion time and the backlog that may be accumulating</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Merged Writes</td><td><tt>custom.vfs.dev.write.merged[{#BLOCKDEVICE}]</tt></td><td>Number of writes merged.
Reads and writes which are adjacent to each other may be merged for efficiency. Thus two 4K reads may become one 8K read before it is ultimately handed to the disk, and so it will be counted (and queued) as only one I/O. This field lets you know how often this was done.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Milleseconds spend in Write IO</td><td><tt>custom.vfs.dev.write.ms[{#BLOCKDEVICE}]</tt></td><td>Number of milliseconds spent writing.&amp;#13;
This is the total number of milliseconds spent by all writes (as measured from __make_request() to end_that_request_last()).</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO: Ops Write</td><td><tt>custom.vfs.dev.write.ops[{#BLOCKDEVICE}]</tt></td><td>This is the total number of reads completed successfully.</td><td></td><td></td><td></td>
</tr>
<tr>
<td>ZABBIX_ACTIVE</td><td>{#BLOCKDEVICE} - IO Transfer Write</td><td><tt>custom.vfs.dev.write.sectors[{#BLOCKDEVICE}]</tt></td><td>This is the total number of sectors write successfully.</td><td></td><td></td><td></td>
</tr>
</table>
</body>
</html>
169 changes: 0 additions & 169 deletions zabbix_templates/6.4/documentation/custom-os-linux-disk-performance-details.html
View file

This file was deleted.

Loading

0 comments on commit 5b2d7f1

Please sign in to comment.