fmdump(1m) - osol9

1fmdump(1M)              System Administration Commands              fmdump(1M)
2
3
4

NAME

6       fmdump - fault management log viewer
7

SYNOPSIS

9       fmdump [-efmvV] [-c class] [-R dir] [-t time] [-T time]
10            [-u uid] [-n name[.name]*[=value]] [file]
11
12

DESCRIPTION

14       The  fmdump  utility  can be used to display the contents of any of the
15       log files associated with the Solaris Fault Manager, fmd(1M). The Fault
16       Manager  runs  in  the  background  on each Solaris system. It receives
17       telemetry information relating to problems detected by the system soft‐
18       ware,  diagnoses  these  problems, and initiates proactive self-healing
19       activities such as disabling faulty components.
20
21
22       The Fault Manager maintains two sets of log files for use  by  adminis‐
23       trators and service personnel:
24
25       error log    A log which records error telemetry, the symptoms of prob‐
26                    lems detected by the system.
27
28
29       fault log    A log which records fault diagnosis information, the prob‐
30                    lems believed to explain these symptoms.
31
32
33
34       By  default,  fmdump  displays  the  contents  of  the fault log, which
35       records the result of each diagnosis made by the fault manager  or  one
36       of its component modules.
37
38
39       An example of a default fmdump display follows:
40
41         # fmdump
42         TIME                 UUID                                 SUNW-MSG-ID
43         Dec 28 13:01:27.3919 bf36f0ea-9e47-42b5-fc6f-c0d979c4c8f4 FMD-8000-11
44         Dec 28 13:01:49.3765 3a186292-3402-40ff-b5ae-810601be337d FMD-8000-11
45         Dec 28 13:02:59.4448 58107381-1985-48a4-b56f-91d8a617ad83 FMD-8000-OW
46         ...
47
48
49
50
51       Each problem recorded in the fault log is identified by:
52
53           o      The time of its diagnosis
54
55           o      A  Universal  Unique  Identifier  (UUID) that can be used to
56                  uniquely identify this particular problem across any set  of
57                  systems
58
59           o      A  message  identifier  that  can be used to access a corre‐
60                  sponding  knowledge  article  located  at  Sun's  web  site,
61                  http://www.sun.com/msg/
62
63
64       If  a problem requires action by a human administrator or service tech‐
65       nician or affects system behavior, the  Fault  Manager  also  issues  a
66       human-readable  message to syslogd(1M). This message provides a summary
67       of the problem and a reference to the knowledge article on the Sun  web
68       site, http://www.sun.com/msg/.
69
70
71       You  can use the -v and -V options to expand the display from a single-
72       line summary to increased levels of detail for each event  recorded  in
73       the  log. The -c, -t, -T, and -u options can be used to filter the out‐
74       put by selecting only those events  that  match  the  specified  class,
75       range of times, or uuid.
76
77
78       If  more  than  one  filter  option is present on the command-line, the
79       options combine to display only those events that are selected  by  the
80       logical  AND of the options. If more than one instance of the same fil‐
81       ter option is present on the command-line, the like options combine  to
82       display any events selected by the logical OR of the options. For exam‐
83       ple, the command:
84
85         # fmdump -u uuid1 -u uuid2 -t 02Dec03
86
87
88
89
90       selects events whose attributes are (uuid1 OR uuid2) AND  (time  on  or
91       after 02Dec03).
92

OPTIONS

94       The following options are supported:
95
96       -c class
97
98           Select  events  that  match the specified class. The class argument
99           can use the glob pattern matching syntax described  in  sh(1).  The
100           class  represents  a  hierarchical classification string indicating
101           the type of telemetry event. More information about Sun's telemetry
102           protocol is available at Sun's web site, http://www.sun.com/msg/.
103
104
105       -e
106
107           Display  events  from the fault management error log instead of the
108           fault log. This option is shorthand for specifying the pathname  of
109           the error log file.
110
111           The  error  log file contains Private telemetry information used by
112           Sun's automated diagnosis software. This information is recorded to
113           facilitate  post-mortem  analysis of problems and event replay, and
114           should not be parsed or relied upon for the development of  scripts
115           and  other  tools.  See  attributes(5)  for information about Sun's
116           rules for Private interfaces.
117
118
119       -f
120
121           Follow the growth of the log file by waiting for  additional  data.
122           fmdump  enters  an  infinite loop where it will sleep for a second,
123           attempt to read and format new data from the log file, and then  go
124           back  to  sleep. This loop can be terminated at any time by sending
125           an interrupt (Control-C).
126
127
128       -m
129
130           Print the localized diagnosis message associated with each entry in
131           the fault log.
132
133
134       -n name[.name]*[=value]
135
136           Select  fault  log or error log events, depending on the -e option,
137           that have properties with a matching name (and optionally a  match‐
138           ing  value).  For  string  properties  the  value  can be a regular
139           expression match. Regular expression syntax  is  described  in  the
140           EXTENDED  REGULAR  EXPRESSIONS section of the regex(5) manual page.
141           Be careful when using the characters:
142
143             $  *  {  ^  |  (  )  \
144
145
146           ...or a regular expression, because these  are  meaningful  to  the
147           shell.  It  is safest to enclose any of these in single quotes. For
148           numeric properties, the value can be octal, hex, or decimal.
149
150
151       -R dir
152
153           Use the specified root directory for  the  log  files  accessed  by
154           fmdump, instead of the default root (/).
155
156
157       -t time
158
159           Select  events  that  occurred  at or after the specified time. The
160           time can be specified using any of the following forms:
161
162           mm/dd/yy hh:mm:ss
163
164               Month, day, year, hour in 24-hour format, minute,  and  second.
165               Any  amount  of  whitespace can separate the date and time. The
166               argument should be quoted so that the shell interprets the  two
167               strings as a single argument.
168
169
170           mm/dd/yy hh:mm
171
172               Month,  day,  year,  hour  in  24-hour  format, and minute. Any
173               amount of whitespace can separate the date and time. The  argu‐
174               ment  should  be  quoted  so  that the shell interprets the two
175               strings as a single argument.
176
177
178           mm/dd/yy
179
180               12:00:00AM on the specified month, day, and year.
181
182
183           ddMonyy hh:mm:ss
184
185               Day, month name, year, hour in 24-hour format, minute, and sec‐
186               ond.  Any  amount of whitespace can separate the date and time.
187               The argument should be quoted so that the shell interprets  the
188               two strings as a single argument.
189
190
191           ddMonyy hh:mm
192
193               Day,  month name, year, hour in 24-hour format, and minute. Any
194               amount of whitespace can separate the date and time. The  argu‐
195               ment  should  be  quoted  so  that the shell interprets the two
196               strings as a single argument.
197
198
199           Mon dd hh:mm:ss
200
201               Month, day, hour in 24-hour format, minute, and second  of  the
202               current year.
203
204
205           yyyy-mm-dd [T hh:mm[:ss]]
206
207               Year,  month, day, and optional hour in 24-hour format, minute,
208               and second. The second, or hour, minute,  and  second,  can  be
209               optionally omitted.
210
211
212           ddMonyy
213
214               12:00:00AM on the specified day, month name, and year.
215
216
217           hh:mm:ss
218
219               Hour in 24-hour format, minute, and second of the current day.
220
221
222           hh:mm
223
224               Hour in 24-hour format and minute of the current day.
225
226
227           Tns | Tnsec
228
229               T nanoseconds ago where T is an integer value specified in base
230               10.
231
232
233           Tus |Tusec
234
235               T microseconds ago where T is an  integer  value  specified  in
236               base 10.
237
238
239           Tms | Tmsec
240
241               T  milliseconds  ago  where  T is an integer value specified in
242               base 10.
243
244
245           Ts | Tsec
246
247               T seconds ago where T is an integer value specified in base 10.
248
249
250           Tm |Tmin
251
252               T minutes ago where T is an integer value specified in base 10.
253
254
255           Th |Thour
256
257               T hours ago where T is an integer value specified in base 10.
258
259
260           Td |Tday
261
262               T days ago where T is an integer value specified in base 10.
263
264           You can append a decimal fraction of the form .n to any  -t  option
265           argument  to  indicate  a  fractional  number of seconds beyond the
266           specified time.
267
268
269       -T time
270
271           Select events that occurred at or before the specified  time.  time
272           can be specified using any of the time formats described for the -t
273           option.
274
275
276       -u uuid
277
278           Select fault diagnosis events  that  exactly  match  the  specified
279           uuid.  Each diagnosis is associated with a Universal Unique Identi‐
280           fier (UUID) for identification purposes. The -u option can be  com‐
281           bined  with  other  options  such  as -v to show all of the details
282           associated with a particular diagnosis.
283
284           If the -e option and -u option are both present, the  error  events
285           that are cross-referenced by the specified diagnosis are displayed.
286
287
288       -v
289
290           Display verbose event detail. The event display is enlarged to show
291           additional common members of the selected events.
292
293
294       -V
295
296           Display very verbose event detail. The event display is enlarged to
297           show  every member of the name-value pair list associated with each
298           event. In addition, for fault logs, the event  display  includes  a
299           list  of  cross-references  to  the  corresponding errors that were
300           associated with the diagnosis.
301
302

OPERANDS

304       The following operands are supported:
305
306       file    Specifies an alternate log file to display instead of the  sys‐
307               tem  fault  log.  The fmdump utility determines the type of the
308               specified log automatically and produces appropriate output for
309               the selected log.
310
311

EXAMPLES

313       Example 1 Retrieving Given Class from fmd Log
314
315
316       Use any of the following commands to retrieve information about a spec‐
317       ified class  from  the  fmd  log.  The  complete  class  name  is  ere‐
318       port.io.ddi.context.
319
320
321         # fmdump -Ve -c 'ereport.io.ddi.context'
322         # fmdump -Ve -c 'ereport.*.context'
323         # fmdump -Ve -n 'class=ereport.io.ddi.context'
324         # fmdump -Ve -n 'class=ereport.*.context'
325
326
327
328
329       Any of the preceding commands produces the following output:
330
331
332         Oct 06 2007 11:53:20.975021712 ereport.io.ddi.context
333                 nvlist version: 0
334                         class = ereport.io.ddi.context
335                         ena = 0x1b03a15ecf00001
336                         detector = (embedded nvlist)
337                         nvlist version: 0
338                                 version = 0x0
339                                 scheme = dev
340                                 device-path = /
341                         (end detector)
342
343                         __ttl = 0x1
344                         __tod = 0x470706b0 0x3a1da690
345
346
347
348       Example 2 Retrieving Specific Detector Device Path from fmd Log
349
350
351       The  following  command  retrieves  a detector device path from the fmd
352       log.
353
354
355         # fmdump -Ve -n 'detector.device-path=.*/disk@1,0$'
356         Oct 06 2007 12:04:28.065660760 ereport.io.scsi.disk.rqs
357         nvlist version: 0
358                class = ereport.io.scsi.disk.rqs
359                ena = 0x453ff3732400401
360                detector = (embedded nvlist)
361                         nvlist version: 0
362                                 version = 0x0
363                                 scheme = dev
364                                 device-path = /pci@0,0/pci1000,3060@3/disk@1,0
365                         (end detector)
366
367                         __ttl = 0x1
368                         __tod = 0x4707094c 0x3e9e758
369
370
371

EXIT STATUS

373       The following exit values are returned:
374
375       0    Successful completion. All records in the log file  were  examined
376            successfully.
377
378
379       1    A  fatal  error  occurred.  This  prevented any log file data from
380            being examined, such as failure to open the specified file.
381
382
383       2    Invalid command-line options were specified.
384
385
386       3    The log file was opened successfully, but one  or  more  log  file
387            records  were not displayed, either due to an I/O error or because
388            the records themselves were malformed.  fmdump  issues  a  warning
389            message for each record that could not be displayed, and then con‐
390            tinues on and attempts to display other records.
391
392

FILES

394       /var/fm/fmd           Fault management log directory
395
396
397       /var/fm/fmd/errlog    Fault management error log
398
399
400       /var/fm/fmd/fltlog    Fault management fault log
401
402

ATTRIBUTES

404       See attributes(5) for descriptions of the following attributes:
405
406
407
408
409       ┌─────────────────────────────┬─────────────────────────────┐
410       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
411       ├─────────────────────────────┼─────────────────────────────┤
412       │Availability                 │SUNWfmd                      │
413       ├─────────────────────────────┼─────────────────────────────┤
414       │Interface Stability          │See below.                   │
415       └─────────────────────────────┴─────────────────────────────┘
416
417
418       The command-line options are Evolving.  The  human-readable  error  log
419       output is Private. The human-readable fault log output is Evolving.
420

NOTES

432       Fault logs contain references to records stored in error logs that  can
433       be displayed using fmdump -V to understand the errors that were used in
434       the diagnosis of a particular fault. These links are  preserved  if  an
435       error  log  is  renamed  as part of log rotation. They can be broken by
436       removing an error log file, or  by  moving  it  to  another  filesystem
437       directory.  fmdump  can  not  display error information for such broken
438       links. It continues to display any and all information present  in  the
439       fault log.
440
441
442
443SunOS 5.11                        14 Apr 2009                       fmdump(1M)