usr/src/man/man1m/fmstat.1m

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FMSTAT 1M "Jun 16, 2009"
   7 .SH NAME
   8 fmstat \- report fault management module statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBfmstat\fR [\fB-astTz\fR] [\fB-d\fR u | d ] [\fB-m\fR \fImodule\fR] [\fIinterval\fR [\fIcount\fR]]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBfmstat\fR utility can be used by administrators and service personnel to
  19 report statistics associated with the Solaris Fault Manager, \fBfmd\fR(1M) and
  20 its associated set of modules. The Fault Manager runs in the background on each
  21 Solaris system. It receives telemetry information relating to problems detected
  22 by the system software, diagnoses these problems, and initiates proactive
  23 self-healing activities such as disabling faulty components.
  24 .sp
  25 .LP
  26 You can use \fBfmstat\fR to view statistics for diagnosis engines and agents
  27 that are currently participating in fault management. The documentation for
  28 \fBfmd\fR(1M), \fBfmadm\fR(1M), and \fBfmdump\fR(1M) describes more about tools
  29 to observe fault management activities.
  30 .sp
  31 .LP
  32 If the \fB-m\fR option is present or the \fB-t\fR option is present,
  33 \fBfmstat\fR reports any statistics kept by the specified fault management
  34 module. The module list can be obtained using \fBfmadm config\fR.
  35 .sp
  36 .LP
  37 If the \fB-m\fR option is not present, \fBfmstat\fR reports the following
  38 statistics for each of its client modules:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBmodule\fR\fR
  43 .ad
  44 .RS 11n
  45 The name of the fault management module, as reported by \fBfmadm config\fR.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBev_recv\fR\fR
  52 .ad
  53 .RS 11n
  54 The number of telemetry events received by the module.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBev_acpt\fR\fR
  61 .ad
  62 .RS 11n
  63 The number of events accepted by the module as relevant to a diagnosis.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBwait\fR\fR
  70 .ad
  71 .RS 11n
  72 The average number of telemetry events waiting to be examined by the module.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBsvc_t\fR\fR
  79 .ad
  80 .RS 11n
  81 The average service time for telemetry events received by the module, in
  82 milliseconds.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB%w\fR\fR
  89 .ad
  90 .RS 11n
  91 The percentage of time that there were telemetry events waiting to be examined
  92 by the module.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB%b\fR\fR
  99 .ad
 100 .RS 11n
 101 The percentage of time that the module was busy processing telemetry events.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBopen\fR\fR
 108 .ad
 109 .RS 11n
 110 The number of active cases (open problem investigations) owned by the module.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBsolve\fR\fR
 117 .ad
 118 .RS 11n
 119 The total number of cases solved by this module since it was loaded.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBmemsz\fR\fR
 126 .ad
 127 .RS 11n
 128 The amount of dynamic memory currently allocated by this module.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBbufsz\fR\fR
 135 .ad
 136 .RS 11n
 137 The amount of persistent buffer space currently allocated by this module.
 138 .RE
 139
 140 .sp
 141 .LP
 142 The \fBfmstat\fR utility requires the user to posses the \fBSYS_CONFIG\fR
 143 privilege. Refer to the \fI\fR for more information about how to configure
 144 Solaris privileges.
 145 .SH OPTIONS
 146 .sp
 147 .LP
 148 The following options are supported:
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fB-a\fR\fR
 153 .ad
 154 .RS 13n
 155 Print all statistics for a module, including those kept on its behalf by
 156 \fBfmd\fR. If the \fB-a\fR option is not present, only those statistics kept by
 157 the module are reported. If the \fB-a\fR option is used without the \fB-m\fR
 158 \fImodule\fR, a set of global statistics associated with \fBfmd\fR are
 159 displayed.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fB-d\fR \fBu\fR | \fBd\fR\fR
 166 .ad
 167 .RS 13n
 168 Display a time stamp.
 169 .sp
 170 Specify \fBu\fR for a printed representation of the internal representation of
 171 time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See
 172 \fBdate\fR(1).
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fB-m\fR \fImodule\fR\fR
 179 .ad
 180 .RS 13n
 181 Print a report on the statistics associated with the specified fault management
 182 module, instead of the default statistics report. Modules can publish an
 183 arbitrary set of statistics to help Sun service the fault management software
 184 itself. The module statistics constitute a Private interface. See
 185 \fBattributes\fR(5) for information on Sun's rules for Private interfaces.
 186 Scripts should not be written that depend upon the values of fault management
 187 module statistics as they can change without notice.
 188 .RE
 189
 190 .sp
 191 .ne 2
 192 .na
 193 \fB\fB-s\fR\fR
 194 .ad
 195 .RS 13n
 196 Print a report on Soft Error Rate Discrimination (SERD) engines associated with
 197 the module instead of the default module statistics report. A SERD engine is a
 198 construct used by fault management software to determine if a statistical
 199 threshold measured as \fIN\fR events in some time \fIT\fR has been exceeded.
 200 The \fB-s\fR option can only be used in combination with the \fB-m\fR option.
 201 .RE
 202
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fB-t\fR\fR
 207 .ad
 208 .RS 13n
 209 Print a report on the statistics associated with each fault management event
 210 transport. Each fault management module can provide the implementation of one
 211 or more event transports.
 212 .RE
 213
 214 .sp
 215 .ne 2
 216 .na
 217 \fB\fB-T\fR\fR
 218 .ad
 219 .RS 13n
 220 Print a table of the authority information associated with each fault
 221 management event transport. If the \fB-m\fR option is present, only transports
 222 associated with the specified module are displayed.
 223 .RE
 224
 225 .sp
 226 .ne 2
 227 .na
 228 \fB\fB-z\fR\fR
 229 .ad
 230 .RS 13n
 231 Omit statistics with a zero value from the report associated with the specified
 232 fault management module. The \fB-z\fR option can only be used in combination
 233 with the \fB-m\fR option.
 234 .RE
 235
 236 .SH OPERANDS
 237 .sp
 238 .LP
 239 The following operands are supported:
 240 .sp
 241 .ne 2
 242 .na
 243 \fB\fIcount\fR\fR
 244 .ad
 245 .RS 12n
 246 Print only count reports, and then exit.
 247 .RE
 248
 249 .sp
 250 .ne 2
 251 .na
 252 \fB\fIinterval\fR\fR
 253 .ad
 254 .RS 12n
 255 Print a new report every \fIinterval\fR seconds.
 256 .RE
 257
 258 .sp
 259 .LP
 260 If no \fIinterval\fR and no \fIcount\fR are specified, a single report is
 261 printed and \fBfmstat\fR exits. If an \fIinterval\fR is specified but no
 262 \fIcount\fR is specified, \fBfmstat\fR prints reports every \fIinterval\fR
 263 seconds indefinitely until the command is interrupted.
 264 .SH EXIT STATUS
 265 .sp
 266 .LP
 267 The following exit values are returned:
 268 .sp
 269 .ne 2
 270 .na
 271 \fB\fB0\fR\fR
 272 .ad
 273 .RS 5n
 274 Successful completion.
 275 .RE
 276
 277 .sp
 278 .ne 2
 279 .na
 280 \fB\fB1\fR\fR
 281 .ad
 282 .RS 5n
 283 A fatal error occurred. A fatal error could be the failure to communicate with
 284 \fBfmd\fR(1M). It could also be that insufficient privileges were available to
 285 perform the requested operation.
 286 .RE
 287
 288 .sp
 289 .ne 2
 290 .na
 291 \fB\fB2\fR\fR
 292 .ad
 293 .RS 5n
 294 Invalid command-line options were specified.
 295 .RE
 296
 297 .SH ATTRIBUTES
 298 .sp
 299 .LP
 300 See \fBattributes\fR(5) for descriptions of the following attributes:
 301 .sp
 302
 303 .sp
 304 .TS
 305 box;
 306 c | c
 307 l | l .
 308 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 309 _
 310 Interface Stability     See below.
 311 .TE
 312
 313 .sp
 314 .LP
 315 The command-line options are Evolving. The human-readable default report is
 316 Unstable. The human-readable module report is Private.
 317 .SH SEE ALSO
 318 .sp
 319 .LP
 320 \fBfmadm\fR(1M), \fBfmd\fR(1M), \fBfmdump\fR(1M), \fBattributes\fR(5)
 321 .sp
 322 .LP
 323 \fI\fR