Please find attached the proposed changes to UCD-SNMP-MIB.txt.
This basically clarifies the descriptions of the memory and systemStats
groups - defining the actual behaviour in much greater detail, rather than
leaving things implicit or vague.

I'd like to see this included in 5.4, if at all possible.

Dave
Index: UCD-SNMP-MIB.txt
===================================================================
RCS file: /cvsroot/net-snmp/net-snmp/mibs/UCD-SNMP-MIB.txt,v
retrieving revision 5.7
diff -u -u -r5.7 UCD-SNMP-MIB.txt
--- UCD-SNMP-MIB.txt	7 Nov 2006 22:14:44 -0000	5.7
+++ UCD-SNMP-MIB.txt	22 Nov 2006 11:17:56 -0000
@@ -37,7 +37,7 @@
 	FROM SNMPv2-TC;
 
 ucdavis MODULE-IDENTITY
-    LAST-UPDATED "200611070000Z"
+    LAST-UPDATED "200611220000Z"
     ORGANIZATION "University of California, Davis"
     CONTACT-INFO    
 	"This mib is no longer being maintained by the University of
@@ -53,6 +53,9 @@
          email:    [email protected]
         "
     DESCRIPTION
+	"Clarify behaviour of objects in the memory & systemStats groups."
+    REVISION	 "200611220000Z"
+    DESCRIPTION
 	"Clarify behaviour of mem*Text objects (& provide updated versions)."
     REVISION	 "200611070000Z"
     DESCRIPTION
@@ -157,6 +160,12 @@
          is '07'h; and the value is '9f780442f60000'h."
     SYNTAX Opaque (SIZE (7))
 
+ErrorFlag ::= TEXTUAL-CONVENTION
+    STATUS      current
+    DESCRIPTION
+        "Represents a possible error condition"
+    SYNTAX INTEGER  { noError(0),  error(1) }
+
 --
 -- Process table checks
 --
@@ -397,7 +406,8 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total Swap Size configured for the host."
+	"The total amount of swap space configured for this host
+         (measured in kB)."
     ::= { memory 3 }
 
 memAvailSwap OBJECT-TYPE
@@ -405,7 +415,8 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Available Swap Space on the host."
+	"The amount of swap space currently unused or
+         available (measured in kB)."
     ::= { memory 4 }
 
 memTotalReal OBJECT-TYPE
@@ -413,7 +424,8 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total Real/Physical Memory Size on the host."
+	"The total amount of real/physical memory installed
+         on this host (measured in kB)."
     ::= { memory 5 }
 
 memAvailReal OBJECT-TYPE
@@ -421,7 +433,8 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Available Real/Physical Memory Space on the host."
+	"The amount of real/physical memory currently unused
+         or available (measured in kB)."
     ::= { memory 6 }
 
 memTotalSwapTXT OBJECT-TYPE
@@ -429,7 +442,12 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total virtual memory used by text."
+	"The total amount of swap space or virtual memory allocated
+         for text pages on this host (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not distinguish text
+         pages from other uses of swap space or virtual memory."
     ::= { memory 7 }
 
 memAvailSwapTXT OBJECT-TYPE
@@ -437,11 +455,16 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION	
-	"Active virtual memory used by text.
-         Note that despite the name of the object,
-         this value did in practise monitor the
-         memory *used* rather than available.
-         For clarity, this object is being deprecated
+	"The amount of swap space or virtual memory currently
+         being used by text pages on this host (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not distinguish text
+         pages from other uses of swap space or virtual memory.
+
+         Note that (despite the name), this value reports the
+         amount used, rather than the amount free or available
+         for use.  For clarity, this object is being deprecated
          in favour of 'memUsedSwapTXT(16)."
     ::= { memory 8 }
 
@@ -450,7 +473,12 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total Real/Physical Memory Size used by text."
+	"The total amount of real/physical memory allocated
+         for text pages on this host (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not distinguish text
+         pages from other uses of physical memory."
     ::= { memory 9 }
 
 memAvailRealTXT OBJECT-TYPE
@@ -458,11 +486,16 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"Active Real/Physical Memory Space used by text.
-         Note that despite the name of the object,
-         this value did in practise monitor the
-         memory *used* rather than available.
-         For clarity, this object is being deprecated
+	"The amount of real/physical memory currently being
+         used by text pages on this host (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not distinguish text
+         pages from other uses of physical memory.
+
+         Note that (despite the name), this value reports the
+         amount used, rather than the amount free or available
+         for use.  For clarity, this object is being deprecated
          in favour of 'memUsedRealTXT(17)."
     ::= { memory 10 }
 
@@ -471,7 +504,9 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total Available Memory on the host"
+        "The total amount of memory free or available for use on
+         this host (measured in kB).  This value typically covers
+         both real memory and swap space or virtual memory."
     ::= { memory 11 }
 
 memMinimumSwap OBJECT-TYPE
@@ -479,9 +514,14 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Minimum amount of free swap required to be free
-	 or else memErrorSwap is set to 1 and an error string is
-	 returned memSwapErrorMsg."
+	"The minimum amount of swap space expected to be kept
+         free or available during normal operation of this host
+         (measured in kB).
+
+         If this value (as reported by 'memAvailSwap(4)') falls
+         below the specified level, then 'memSwapError(100)' will
+         be set to 1 and an error message made available via
+         'memSwapErrorMsg(101)'."
     ::= { memory 12 }
 
 memShared OBJECT-TYPE
@@ -489,7 +529,12 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total Shared Memory"
+        "The total amount of real or virtual memory currently
+         allocated for use as shared memory (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not explicitly identify
+         memory as specifically reserved for this purpose."
     ::= { memory 13 }
 
 memBuffer OBJECT-TYPE
@@ -497,7 +542,12 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total Buffered Memory"
+        "The total amount of real or virtual memory currently
+         allocated for use as memory buffers (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not explicitly identify
+         memory as specifically reserved for this purpose."
     ::= { memory 14 }
 
 memCached OBJECT-TYPE
@@ -505,7 +555,12 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Total Cached Memory"
+        "The total amount of real or virtual memory currently
+         allocated for use as cached memory (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not explicitly identify
+         memory as specifically reserved for this purpose."
     ::= { memory 15 }
 
 memUsedSwapTXT OBJECT-TYPE
@@ -513,7 +568,12 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION	
-	"Active virtual memory used by text."
+	"The amount of swap space or virtual memory currently
+         being used by text pages on this host (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not distinguish text
+         pages from other uses of swap space or virtual memory."
     ::= { memory 16 }
 
 memUsedRealTXT OBJECT-TYPE
@@ -521,15 +581,22 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Active Real/Physical Memory Space used by text."
+	"The amount of real/physical memory currently being
+         used by text pages on this host (measured in kB).
+
+         This object will not be implemented on hosts where the
+         underlying operating system does not distinguish text
+         pages from other uses of physical memory."
     ::= { memory 17 }
 
 memSwapError OBJECT-TYPE
-    SYNTAX	Integer32
+    SYNTAX	ErrorFlag
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Error flag.  1 indicates very little swap space left"
+	"Indicates whether the amount of available swap space
+         (as reported by 'memAvailSwap(4)'), is less than the
+         desired minimum (specified by 'memMinimumSwap(12)')."
     ::= { memory 100 }
 	
 memSwapErrorMsg OBJECT-TYPE
@@ -537,7 +604,9 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Error message describing the Error Flag condition"
+	"Describes whether the amount of available swap space
+         (as reported by 'memAvailSwap(4)'), is less than the
+         desired minimum (specified by 'memMinimumSwap(12)')."
     ::= { memory 101 } 
 
 
@@ -953,7 +1022,7 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Reference Index for each observed systemStat (1)."
+	"Bogus Index.  This should always return the integer 1."
     ::= { systemStats 1 }
 
 ssErrorName OBJECT-TYPE
@@ -961,7 +1030,7 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"The list of systemStats names (vmstat) we're Counting."
+	"Bogus Name. This should always return the string 'systemStats'."
     ::= { systemStats 2 }
 
 ssSwapIn OBJECT-TYPE
@@ -969,7 +1038,8 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Amount of memory swapped in from disk (kB/s)."
+	"The average amount of memory swapped in from disk,
+         calculated over the last minute (measured in kB/s)."
     ::= { systemStats 3 }
 
 ssSwapOut OBJECT-TYPE
@@ -977,7 +1047,8 @@
     MAX-ACCESS	read-only
     STATUS	current
     DESCRIPTION
-	"Amount of memory swapped to disk (kB/s)."
+	"The average amount of memory swapped out to disk,
+         calculated over the last minute (measured in kB/s)."
     ::= { systemStats 4 }
 
 ssIOSent OBJECT-TYPE
@@ -985,8 +1056,13 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"Blocks sent to a block device (blocks/s). Deprecated, replaced by
-	the ssIORawSent object"
+	"The average amount of data written to disk or other
+         block device, calculated over the last minute
+         (measured in blocks/s).
+       
+	 This object has been deprecated in favour of
+         'ssIORawSent(57)', which can be used to calculate
+         the same metric, but over any desired time period."
     ::= { systemStats 5 }
 
 ssIOReceive OBJECT-TYPE
@@ -994,8 +1070,13 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"Blocks received from a block device (blocks/s). Deprecated, replaced by
-	the ssIORawReceived object"
+	"The average amount of data read from disk or other
+         block device, calculated over the last minute
+         (measured in blocks/s).
+       
+	 This object has been deprecated in favour of
+         'ssIORawReceived(58)', which can be used to calculate
+         the same metric, but over any desired time period."
     ::= { systemStats 6 }
 
 ssSysInterrupts OBJECT-TYPE
@@ -1003,8 +1084,12 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"The number of interrupts per second, including the clock.
-	Deprecated, replaced by ssRawInterrupts"
+	"The average rate of interrupts processed (including the clock)
+         calculated over the last minute (measured in interrupts/s).
+       
+	 This object has been deprecated in favour of
+         'ssRawInterrupts(59)', which can be used to calculate
+         the same metric, but over any desired time period."
     ::= { systemStats 7 }
 
 ssSysContext OBJECT-TYPE
@@ -1012,8 +1097,12 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"The number of context switches per second.
-	Deprecated, replaced by ssRawContext"
+	"The average rate of context switches, calculated
+         over the last minute (measured in switches/s).
+       
+	 This object has been deprecated in favour of
+         'ssRawContext(60)', which can be used to calculate
+         the same metric, but over any desired time period."
     ::= { systemStats 8 }
 
 ssCpuUser OBJECT-TYPE
@@ -1021,8 +1110,12 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"percentages of user CPU time. Deprecated, replaced by the ssCpuRawUser
-	object"
+	"The percentage of CPU time spent processing user-level
+         code, calculated over the last minute.
+       
+	 This object has been deprecated in favour of
+         'ssCpuRawUser(50)', which can be used to calculate
+         the same metric, but over any desired time period."
     ::= { systemStats 9 }
 
 ssCpuSystem OBJECT-TYPE
@@ -1030,8 +1123,12 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"percentages of system CPU time. Deprecated, replaced by of the
-	ssCpuRawSystem object"
+	"The percentage of CPU time spent processing system-level
+         code, calculated over the last minute.
+       
+	 This object has been deprecated in favour of
+         'ssCpuRawSystem(52)', which can be used to calculate
+         the same metric, but over any desired time period."
     ::= { systemStats 10 }
 
 ssCpuIdle OBJECT-TYPE
@@ -1039,8 +1136,12 @@
     MAX-ACCESS	read-only
     STATUS	deprecated
     DESCRIPTION
-	"percentages of idle CPU time. Deprecated, replaced by of the
-	ssCpuRawIdle object"
+	"The percentage of processor time spent idle,
+         calculated over the last minute.
+       
+	 This object has been deprecated in favour of
+         'ssCpuRawIdle(53)', which can be used to calculate
+         the same metric, but over any desired time period."
     ::= { systemStats 11 }
 
 -- The agent only implements those of the following counters that the
@@ -1051,7 +1152,12 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
-        "user CPU time."
+        "The number of 'ticks' (typically 1/100s) spent
+         processing user-level code.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors)."
     ::= { systemStats 50 }
 
 ssCpuRawNice OBJECT-TYPE
@@ -1059,7 +1165,16 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
-        "nice CPU time."
+        "The number of 'ticks' (typically 1/100s) spent
+         processing reduced-priority code.
+
+         This object will not be implemented on hosts where
+         the underlying operating system does not measure
+         this particular CPU metric.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors)."
     ::= { systemStats 51 }
 
 ssCpuRawSystem OBJECT-TYPE
@@ -1067,7 +1182,17 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
-        "system CPU time."
+        "The number of 'ticks' (typically 1/100s) spent
+         processing system-level code.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors).
+
+         This object may sometimes be implemented as the
+         combination of the 'ssCpuRawWait(54)' and
+         'ssCpuRawKernel(55)' counters, so care must be
+         taken when summing the overall raw counters."
     ::= { systemStats 52 }
 
 ssCpuRawIdle OBJECT-TYPE
@@ -1075,7 +1200,12 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
-        "idle CPU time."
+        "The number of 'ticks' (typically 1/100s) spent
+         idle.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors)."
     ::= { systemStats 53 }
 
 ssCpuRawWait OBJECT-TYPE
@@ -1083,7 +1213,17 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
-        "iowait CPU time. This is primarily a SysV thingie"
+        "The number of 'ticks' (typically 1/100s) spent
+         waiting for IO.
+
+         This object will not be implemented on hosts where
+         the underlying operating system does not measure
+         this particular CPU metric.  This time may also be
+         included within the 'ssCpuRawSystem(52)' counter.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors)."
     ::= { systemStats 54 }
 
 ssCpuRawKernel OBJECT-TYPE
@@ -1091,6 +1231,17 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
+        "The number of 'ticks' (typically 1/100s) spent
+         processing kernel-level code.
+
+         This object will not be implemented on hosts where
+         the underlying operating system does not measure
+         this particular CPU metric.  This time may also be
+         included within the 'ssCpuRawSystem(52)' counter.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors).
         "kernel CPU time."
     ::= { systemStats 55 }
 
@@ -1099,7 +1250,16 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
-        "interruptlevel CPU time. This is primarily a BSD thingie"
+        "The number of 'ticks' (typically 1/100s) spent
+         processing hardware interrupts.
+
+         This object will not be implemented on hosts where
+         the underlying operating system does not measure
+         this particular CPU metric.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors)."
     ::= { systemStats 56 }
 
 ssIORawSent OBJECT-TYPE
@@ -1139,7 +1299,16 @@
     MAX-ACCESS  read-only
     STATUS      current
     DESCRIPTION
-        "Soft IRQ CPU time. This is for Linux 2.6"
+        "The number of 'ticks' (typically 1/100s) spent
+         processing software interrupts.
+
+         This object will not be implemented on hosts where
+         the underlying operating system does not measure
+         this particular CPU metric.
+
+         On a multi-processor system, the 'ssCpuRaw*'
+         counters are cumulative over all CPUs, so their
+         sum will typically be N*100 (for N processors)."
     ::= { systemStats 61 }
 
 ssRawSwapIn OBJECT-TYPE
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Net-snmp-coders mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/net-snmp-coders

Reply via email to