1 FMSTAT(1M)                   Maintenance Commands                   FMSTAT(1M)
   2 
   3 
   4 
   5 NAME
   6        fmstat - report fault management module statistics
   7 
   8 SYNOPSIS
   9        fmstat [-astTz] [-d u | d ] [-m module] [interval [count]]
  10 
  11 
  12 DESCRIPTION
  13        The fmstat utility can be used by administrators and service personnel
  14        to report statistics associated with the Fault Manager, fmd(1M) and its
  15        associated set of modules. The Fault Manager runs in the background on
  16        each system. It receives telemetry information relating to problems
  17        detected by the system software, diagnoses these problems, and
  18        initiates proactive self-healing activities such as disabling faulty
  19        components.
  20 
  21 
  22        You can use fmstat to view statistics for diagnosis engines and agents
  23        that are currently participating in fault management. The documentation
  24        for fmd(1M), fmadm(1M), and fmdump(1M) describes more about tools to
  25        observe fault management activities.
  26 
  27 
  28        If the -m option is present or the -t option is present, fmstat reports
  29        any statistics kept by the specified fault management module. The
  30        module list can be obtained using fmadm config.
  31 
  32 
  33        If the -m option is not present, fmstat reports the following
  34        statistics for each of its client modules:
  35 
  36        module
  37                   The name of the fault management module, as reported by
  38                   fmadm config.
  39 
  40 
  41        ev_recv
  42                   The number of telemetry events received by the module.
  43 
  44 
  45        ev_acpt
  46                   The number of events accepted by the module as relevant to a
  47                   diagnosis.
  48 
  49 
  50        wait
  51                   The average number of telemetry events waiting to be
  52                   examined by the module.
  53 
  54 
  55        svc_t
  56                   The average service time for telemetry events received by
  57                   the module, in milliseconds.
  58 
  59 
  60        %w
  61                   The percentage of time that there were telemetry events
  62                   waiting to be examined by the module.
  63 
  64 
  65        %b
  66                   The percentage of time that the module was busy processing
  67                   telemetry events.
  68 
  69 
  70        open
  71                   The number of active cases (open problem investigations)
  72                   owned by the module.
  73 
  74 
  75        solve
  76                   The total number of cases solved by this module since it was
  77                   loaded.
  78 
  79 
  80        memsz
  81                   The amount of dynamic memory currently allocated by this
  82                   module.
  83 
  84 
  85        bufsz
  86                   The amount of persistent buffer space currently allocated by
  87                   this module.
  88 
  89 
  90 
  91        The fmstat utility requires the user to possess the PRIV_SYS_ADMIN
  92        privilege. See privileges(5).
  93 
  94 OPTIONS
  95        The following options are supported:
  96 
  97        -a
  98                     Print all statistics for a module, including those kept on
  99                     its behalf by fmd. If the -a option is not present, only
 100                     those statistics kept by the module are reported. If the
 101                     -a option is used without the -m module, a set of global
 102                     statistics associated with fmd are displayed.
 103 
 104 
 105        -d u | d
 106                     Display a time stamp.
 107 
 108                     Specify u for a printed representation of the internal
 109                     representation of time. See time(2). Specify d for
 110                     standard date format. See date(1).
 111 
 112 
 113        -m module
 114                     Print a report on the statistics associated with the
 115                     specified fault management module, instead of the default
 116                     statistics report. Modules can publish an arbitrary set of
 117                     statistics to help Sun service the fault management
 118                     software itself. The module statistics constitute a
 119                     Private interface. See attributes(5) for information on
 120                     Sun's rules for Private interfaces.  Scripts should not be
 121                     written that depend upon the values of fault management
 122                     module statistics as they can change without notice.
 123 
 124 
 125        -s
 126                     Print a report on Soft Error Rate Discrimination (SERD)
 127                     engines associated with the module instead of the default
 128                     module statistics report. A SERD engine is a construct
 129                     used by fault management software to determine if a
 130                     statistical threshold measured as N events in some time T
 131                     has been exceeded.  The -s option can only be used in
 132                     combination with the -m option.
 133 
 134 
 135        -t
 136                     Print a report on the statistics associated with each
 137                     fault management event transport. Each fault management
 138                     module can provide the implementation of one or more event
 139                     transports.
 140 
 141 
 142        -T
 143                     Print a table of the authority information associated with
 144                     each fault management event transport. If the -m option is
 145                     present, only transports associated with the specified
 146                     module are displayed.
 147 
 148 
 149        -z
 150                     Omit statistics with a zero value from the report
 151                     associated with the specified fault management module. The
 152                     -z option can only be used in combination with the -m
 153                     option.
 154 
 155 
 156 OPERANDS
 157        The following operands are supported:
 158 
 159        count
 160                    Print only count reports, and then exit.
 161 
 162 
 163        interval
 164                    Print a new report every interval seconds.
 165 
 166 
 167 
 168        If no interval and no count are specified, a single report is printed
 169        and fmstat exits. If an interval is specified but no count is
 170        specified, fmstat prints reports every interval seconds indefinitely
 171        until the command is interrupted.
 172 
 173 EXIT STATUS
 174        The following exit values are returned:
 175 
 176        0
 177             Successful completion.
 178 
 179 
 180        1
 181             A fatal error occurred. A fatal error could be the failure to
 182             communicate with fmd(1M). It could also be that insufficient
 183             privileges were available to perform the requested operation.
 184 
 185 
 186        2
 187             Invalid command-line options were specified.
 188 
 189 
 190 ATTRIBUTES
 191        See attributes(5) for descriptions of the following attributes:
 192 
 193 
 194 
 195 
 196        +--------------------+-----------------+
 197        |  ATTRIBUTE TYPE    | ATTRIBUTE VALUE |
 198        +--------------------+-----------------+
 199        |Interface Stability | See below.      |
 200        +--------------------+-----------------+
 201 
 202 
 203        The command-line options are Evolving. The human-readable default
 204        report is Unstable. The human-readable module report is Private.
 205 
 206 SEE ALSO
 207        fmadm(1M), fmd(1M), fmdump(1M), attributes(5), privileges(5)
 208 
 209 
 210 
 211                                 August 26, 2019                     FMSTAT(1M)