From 9d61f16a15583e0552dc7bc44b888cd3d94691d0 Mon Sep 17 00:00:00 2001 From: Nathan Scott Date: Fri, 16 Dec 2016 10:40:59 +1100 Subject: [PATCH] docs, qa: add indom help text to a number of PMDAs Work towards test qa/908 which now passes on my laptop with a fair number of PMDAs installed. Much work remains though, for the many other optional PMDA indoms. --- qa/908 | 2 +- src/pmdas/jbd2/help | 2 ++ src/pmdas/linux/help | 28 ++++++++++++++++++++++++++++ src/pmdas/linux_proc/help | 15 +++++++++++++++ src/pmdas/linux_xfs/help | 3 +++ src/pmdas/mounts/help | 1 + src/pmdas/sample/help | 27 +++++++++++++++++++++++---- 7 files changed, 73 insertions(+), 5 deletions(-) diff --git a/qa/908 b/qa/908 index 5f3744664..11eb0f0ed 100755 --- a/qa/908 +++ b/qa/908 @@ -34,7 +34,7 @@ do if [ $? -eq 0 ] then echo "Missing help text for indom $indom" - echo "For reference - pmcd.agent.status:" + echo "For reference, domain $domain from pmcd.agent.status is:" pminfo -f pmcd.agent.status | grep "\[$domain or" fi done diff --git a/src/pmdas/jbd2/help b/src/pmdas/jbd2/help index e3e8dc269..ea4c11f3c 100644 --- a/src/pmdas/jbd2/help +++ b/src/pmdas/jbd2/help @@ -27,6 +27,8 @@ # blank lines before the @ line are ignored # +@ 122.0 all JBD2 block devices + @ jbd2.njournals Count of active JBD2 (Journal Block Device v2) devices @ jbd2.transaction.count Total transactions committed per journal diff --git a/src/pmdas/linux/help b/src/pmdas/linux/help index 851415be6..5d48c9b6a 100644 --- a/src/pmdas/linux/help +++ b/src/pmdas/linux/help @@ -29,6 +29,34 @@ # # blank lines before the @ line are ignored # + +@ 60.0 set of all processors +@ 60.1 set of all disks +@ 60.2 load averages for 1, 5, and 15 minutes +@ 60.3 set of network interfaces +@ 60.5 mounted block-device-backed filesystem +@ 60.6 swap devices +@ 60.7 network filesystem (NFS) v2 operations +@ 60.8 network filesystem (NFS) v3 operations +@ 60.10 set of all disk partitions +@ 60.11 SCSI devices +@ 60.12 kernel memory slabs +@ 60.14 network filesystem (NFS) v4 client operations +@ 60.15 network filesystem (NFS) v4 server operations +@ 60.17 network interface addresses (inet and ipv6) +@ 60.18 temporary filesystem (tempfs) mounts +@ 60.19 non-uniform memory access (NUMA) nodes +@ 60.23 internet control message protocol (ICMP) message types +@ 60.24 device mapper driver devices +@ 60.25 multi-device driver devices +@ 60.26 persistent per-processor interrupt IDs +@ 60.27 persistent per-processor softirq IDs +@ 60.28 IPC shm_stat shared memory IDs +@ 60.29 IPC msg_stat message queue IDs +@ 60.30 IPC sem_stat semaphore IDs +@ 60.31 buddyinfo memory fragmentation sets, per-NUMA-node +@ 60.32 zoneinfo memory types, per-NUMA-node + @ kernel.uname.release release level of the running kernel Release level of the running kernel as reported via the release[] value returned from uname(2) or uname -r. diff --git a/src/pmdas/linux_proc/help b/src/pmdas/linux_proc/help index 6189aa970..beefe9e9b 100644 --- a/src/pmdas/linux_proc/help +++ b/src/pmdas/linux_proc/help @@ -30,6 +30,21 @@ # blank lines before the @ line are ignored # +@ 3.9 all current processes +@ 3.39 set of interesting ("hot") processes + +@ 3.20 kernel cpusets resource control group (cgroup) +@ 3.21 kernel cpu accounting resource control group (cgroup) +@ 3.22 kernel per-processor cpu accounting control group (cgroup) +@ 3.23 kernel cpu scheduling control group (cgroup) +@ 3.24 kernel memory resource control group (cgroup) +@ 3.25 network classifier resource control group (cgroup) +@ 3.26 aggregate block device resource control group (cgroup) +@ 3.27 individual block device resource control group (cgroup) + +@ 3.37 control group (cgroup) subsystems +@ 3.38 control group (cgroup) mount points + @ proc.nprocs instantaneous number of processes @ proc.runq.runnable number of runnable (on run queue) processes diff --git a/src/pmdas/linux_xfs/help b/src/pmdas/linux_xfs/help index c5f9de0d5..b90252144 100644 --- a/src/pmdas/linux_xfs/help +++ b/src/pmdas/linux_xfs/help @@ -27,6 +27,9 @@ # # blank lines before the @ line are ignored # +@ 11.5 mounted XFS filesystems +@ 11.6 mounted XFS filesystem devices (sysfs) +@ 11.16 XFS project quota virtual mounts @ xfs.allocs.alloc_extent XFS extents allocated Number of file system extents allocated over XFS filesystems diff --git a/src/pmdas/mounts/help b/src/pmdas/mounts/help index 403dcc718..794de17f8 100644 --- a/src/pmdas/mounts/help +++ b/src/pmdas/mounts/help @@ -29,6 +29,7 @@ # # blank lines before the @ line are ignored # +@ MOUNTS.0 all mount points being monitored by pmdamounts @ mounts.device The currently tracked mounted devices from mounts.conf @ mounts.type The filesystem types of current mounts from mounts.conf diff --git a/src/pmdas/sample/help b/src/pmdas/sample/help index f0e421d1f..7571ad8cd 100644 --- a/src/pmdas/sample/help +++ b/src/pmdas/sample/help @@ -27,25 +27,44 @@ # blank lines before the @ line are ignored # -@ SAMPLE.1 Instance domain "colour" for sample PMDA +@ SAMPLE.0 Instance domain "colour" for sample PMDA Universally 3 instances, "red" (0), "green" (1) and "blue" (3). -@ SAMPLE.2 Instance domain "bin" for sample PMDA +@ SAMPLE.1 Instance domain "bin" for sample PMDA Universally 9 instances numbered 100 .. 900 in steps of 100, and named "bin-100" .. "bin-900" -@ SAMPLE.3 Instance domain "mirage" for sample PMDA +@ SAMPLE.2 Instance domain "mirage" for sample PMDA Random number of instances, that change with time. Instance "m-00" (0) is always present, while the others are numbered 1 .. 49 and named "m-01" .. "m-99" -@ SAMPLE.4 Instance domain "family" for sample PMDA. +@ SAMPLE.3 Instance domain "family" for sample PMDA. A fixed set of instances: "colleen", "terry", "emma", "cathy" and "fat bald bastard" +@ SAMPLE.4 Instance domain "hordes" for sample PMDA. +A relatively large instance domain, with hundreds of numeric instances. + +@ SAMPLE.5 Instance domain "dodgey" for sample PMDA. +Instances for an unreliable instance domain, where the instances can +under certain conditions (random or controlled) return holes, errors, +and other interesting scenarios for testing. A sample.dodgey.control +metric store controls this instance domain. + +@ SAMPLE.6 Instance domain "dynamic" for sample PMDA. +Instances come from $PCP_PMDAS_DIR/sample/dynamic.indom, if it exists. + @ SAMPLE.7 Instance domain "many" for sample PMDA. A varable size set of instances controlled by sample.many.count +@ SAMPLE.8 Instance domain "scramble" for sample PMDA. +Several constant instances, instances reordered on successive pmFetch +calls, and sometimes (probability 0.33) some instances are missing. + +@ SAMPLE.9 Instance domain "events" for sample PMDA. +Instances "fungus" and "bogus" for testing event metrics indoms. + @ sample.control A control variable for the "sample" PMDA This control variable may be modified using pmStore(). The allowed values are -- 2.11.4.GIT