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