summaryrefslogtreecommitdiff
path: root/src/pmdas/windows/help
diff options
context:
space:
mode:
Diffstat (limited to 'src/pmdas/windows/help')
-rw-r--r--src/pmdas/windows/help65
1 files changed, 65 insertions, 0 deletions
diff --git a/src/pmdas/windows/help b/src/pmdas/windows/help
new file mode 100644
index 0000000..b58a1ea
--- /dev/null
+++ b/src/pmdas/windows/help
@@ -0,0 +1,65 @@
+#
+# Copyright (c) 2010 Aconex. All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# Windows PMDA help file in the ASCII format. Only metrics which are
+# not using PDH regular expressions for extraction should be contained
+# here - the rest have their help text auto-generated by Windows PDH.
+#
+# lines beginning with a # are ignored
+# lines beginning @ introduce a new entry of the form
+# @ metric_name oneline-text
+# help test goes
+# here over multiple lines
+# ...
+#
+# the metric_name is decoded against the default PMNS -- as a special case,
+# a name of the form NNN.MM (for numeric NNN and MM) is interpreted as an
+# instance domain identification, and the text describes the instance domain
+#
+# blank lines before the @ line are ignored
+#
+@ kernel.uname.release release level of the running kernel
+@ kernel.uname.version version level (build number) and build date of the running kernel
+@ kernel.uname.sysname name of the implementation of the operating system
+@ kernel.uname.machine name of the hardware type the system is running on
+@ kernel.uname.nodename host name of this node on the network
+@ kernel.uname.distro Windows distribution name
+The Windows distribution name, from the GetVersionEx Win32 API.
+
+@ network.interface.speed interface speed in megabytes per second
+The linespeed on the network interface, as reported by the kernel,
+scaled from Megabits/second to Megabytes/second.
+See also network.interface.baudrate for the bytes/second value.
+
+@ network.interface.baudrate interface speed in bytes per second
+The linespeed on the network interface, as reported by the kernel,
+scaled from bits/second and divided by 8 to convert to bytes/second.
+See also network.interface.speed for the Megabytes/second value.
+
+@ pmda.uname identity and type of current system
+Identity and type of current system.
+
+See also the kernel.uname.* metrics
+
+@ pmda.version build version of Windows PMDA
+
+@ hinv.physmem total system memory metric
+@ hinv.pagesize Memory page size
+The memory page size of the running kernel in bytes.
+@ hinv.ncpu number of CPUs in the system
+@ hinv.ndisk number of disks in the syste (excluding floppy drives)
+@ hinv.nfilesys number of (local) file systems currently mounted
+
+@ filesys.capacity Total capacity of mounted filesystem (Kbytes)
+@ filesys.used Total space used on mounted filesystem (Kbytes)
+@ filesys.free Total space free on mounted filesystem (Kbytes)