fmdump.8 (bbf215553c7233fbab8a0afdf1fac74c44781867) fmdump.8 (8efd981e8468a29f137fe78d8fe4a739aa206fb0)
1'\" te
2.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3.\" Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
1'\" te
2.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3.\" Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
4.\" Copyright 2024 Oxide Computer Co.
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 the
6.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
5.\" 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.
6.\" 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 the
7.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7.TH FMDUMP 8 "Jan 14, 2020"
8.TH FMDUMP 8 "April 1, 2024"
8.SH NAME
9fmdump \- fault management log viewer
10.SH SYNOPSIS
11.nf
9.SH NAME
10fmdump \- fault management log viewer
11.SH SYNOPSIS
12.nf
12\fBfmdump\fR [\fB-efmvV\fR] [\fB-c\fR \fIclass\fR] [\fB-R\fR \fIdir\fR] [\fB-t\fR \fItime\fR] [\fB-T\fR \fItime\fR]
13 [\fB-u\fR \fIuuid\fR] [\fB-n\fR \fIname\fR[.\fIname\fR]*[=\fIvalue\fR]] [\fIfile\fR]
13\fBfmdump\fR [\fB-aAefHiIjmpvV\fR] [\fB-c\fR \fIclass\fR] [\fB-R\fR \fIdir\fR] [\fB-t\fR \fItime\fR] [\fB-T\fR \fItime\fR]
14 [\fB-u\fR \fIuuid\fR] [\fB-n\fR \fIname\fR[.\fIname\fR]*[=\fIvalue\fR]]
15 [\fB-N\fR \fIname\fR[.\fIname\fR]*[=\fIvalue\fR][;\fIname\fR[.\fIname\fR]*[=\fIvalue\fR]]*] [\fIfile\fR]
14.fi
15
16.SH DESCRIPTION
17The \fBfmdump\fR utility can be used to display the contents of any of the log
18files associated with the Fault Manager, \fBfmd\fR(8). The Fault
19Manager runs in the background on each system. It receives telemetry
20information relating to problems detected by the system software, diagnoses
21these problems, and initiates proactive self-healing activities such as

--- 18 unchanged lines hidden (view full) ---

40\fBfault log\fR
41.ad
42.RS 13n
43A log which records fault diagnosis information, the problems believed to
44explain these symptoms.
45.RE
46
47.sp
16.fi
17
18.SH DESCRIPTION
19The \fBfmdump\fR utility can be used to display the contents of any of the log
20files associated with the Fault Manager, \fBfmd\fR(8). The Fault
21Manager runs in the background on each system. It receives telemetry
22information relating to problems detected by the system software, diagnoses
23these problems, and initiates proactive self-healing activities such as

--- 18 unchanged lines hidden (view full) ---

42\fBfault log\fR
43.ad
44.RS 13n
45A log which records fault diagnosis information, the problems believed to
46explain these symptoms.
47.RE
48
49.sp
50.ne 2
51.na
52\fBinformational logs\fR
53.ad
54.RS 13n
55A pair of logs that record informational events that may not lead directly to
56a fault diagnosis but can assist in interpreting system state should one
57occur. These events are separated into a log containing informational events
58("ireports") with high priority and sysevents ("high-value" informational
59events), and another containing other ireports.
60.RE
61
62.sp
48.LP
49By default, \fBfmdump\fR displays the contents of the fault log, which records
50the result of each diagnosis made by the fault manager or one of its component
51modules.
52.sp
53.LP
54An example of a default \fBfmdump\fR display follows:
55.sp

--- 61 unchanged lines hidden (view full) ---

117.sp
118
119.sp
120.LP
121selects events whose attributes are \fB(uuid1 OR uuid2\fR) \fBAND\fR (time on
122or after 02Dec03).
123.SH OPTIONS
124The following options are supported:
63.LP
64By default, \fBfmdump\fR displays the contents of the fault log, which records
65the result of each diagnosis made by the fault manager or one of its component
66modules.
67.sp
68.LP
69An example of a default \fBfmdump\fR display follows:
70.sp

--- 61 unchanged lines hidden (view full) ---

132.sp
133
134.sp
135.LP
136selects events whose attributes are \fB(uuid1 OR uuid2\fR) \fBAND\fR (time on
137or after 02Dec03).
138.SH OPTIONS
139The following options are supported:
140
125.sp
126.ne 2
141.sp
142.ne 2
143\fB\fB-a\fR\fR
144.ad
145.sp .6
146.RS 4n
147Include all events from the requested file(s), including events that are
148ordinarily silent.
149.sp
150Silent events may contain Private telemetry information, and their existence
151may be Private also. The presence of silent events and the data they contain
152should not be parsed or relied upon in the development of scripts or other
153tools, and their presence or absence should not be relied upon to indicate
154whether an error or fault condition exists.
155.RE
156
157.sp
158.ne 2
159\fB\fB-A\fR\fR
160.ad
161.sp .6
162.RS 4n
163Aggregate the data from the file(s) specified or, if no file(s) are specified,
164all known logs. Output may include events from fault, error, and
165informational logs, including older logs that have previously been rotated
166out. The order in which events are displayed is unspecified. As this option
167displays data from log files that would be selected by the \fB-e\fR, \fB-i\fR,
168and \fB-I\fR options, the same caveats listed with respect to those options
169also apply to \fB-A\fR.
170.RE
171
172.sp
173.ne 2
127.na
128\fB\fB-c\fR \fIclass\fR\fR
129.ad
130.sp .6
131.RS 4n
132Select events that match the specified class. The class argument can use the
133glob pattern matching syntax described in \fBsh\fR(1). The class represents a
134hierarchical classification string indicating the type of telemetry event.

--- 26 unchanged lines hidden (view full) ---

161enters an infinite loop where it will sleep for a second, attempt to read and
162format new data from the log file, and then go back to sleep. This loop can be
163terminated at any time by sending an interrupt (\fBControl-C\fR).
164.RE
165
166.sp
167.ne 2
168.na
174.na
175\fB\fB-c\fR \fIclass\fR\fR
176.ad
177.sp .6
178.RS 4n
179Select events that match the specified class. The class argument can use the
180glob pattern matching syntax described in \fBsh\fR(1). The class represents a
181hierarchical classification string indicating the type of telemetry event.

--- 26 unchanged lines hidden (view full) ---

208enters an infinite loop where it will sleep for a second, attempt to read and
209format new data from the log file, and then go back to sleep. This loop can be
210terminated at any time by sending an interrupt (\fBControl-C\fR).
211.RE
212
213.sp
214.ne 2
215.na
216\fB\fB-H\fR\fR
217.ad
218.sp 6
219.RS 4n
220Instead of displaying the events contained in the selected log file, display
221its header attributes. The names and values of these attributes are Private
222and should not be parsed or relied upon for the development of scripts or
223other tools. This option is provided primarily for debugging the fault
224management system, but it may also be used to determine the type and origin of
225a log file that has been renamed or moved from the system on which it was
226originally produced.
227.RE
228
229.sp
230.ne 2
231\fB\fB-i\fR\fR
232.ad
233.sp .6
234.RS 4n
235Display events from the ordinary information log instead of the fault log.
236This option is shorthand for specifying the pathname of the ordinary
237information log file.
238.sp
239The ordinary information log file, like the error log file, contains Private
240telemetry information and the same caveats apply with respect to
241interpretation or parsing of this data.
242.RE
243
244.sp
245.ne 2
246\fB\fB-I\fR\fR
247.ad
248.sp .6
249.RS 4n
250Display events from the high-value information log instead of the fault log.
251This option is shorthand for specifying the pathname of the high-value
252information log file.
253.sp
254The high-value information log file, like the error and ordinary information
255log files, contains Private telemetry information and the same caveats apply
256with respect to interpretation or parsing of this data.
257.RE
258
259.sp
260.ne 2
261\fB\fB-j\fR\fR
262.ad
263.sp .6
264.RS 4n
265Output events in JSON format, when used with the \fB-V\fR option.
266.RE
267
268.sp
269.ne 2
270.na
169\fB\fB-m\fR\fR
170.ad
171.sp .6
172.RS 4n
173Print the localized diagnosis message associated with each entry in the fault
174log.
175.RE
176
177.sp
178.ne 2
179.na
180\fB\fB-n\fR \fIname\fR[.\fIname\fR]*[=\fIvalue\fR]\fR
181.ad
182.sp .6
183.RS 4n
271\fB\fB-m\fR\fR
272.ad
273.sp .6
274.RS 4n
275Print the localized diagnosis message associated with each entry in the fault
276log.
277.RE
278
279.sp
280.ne 2
281.na
282\fB\fB-n\fR \fIname\fR[.\fIname\fR]*[=\fIvalue\fR]\fR
283.ad
284.sp .6
285.RS 4n
184Select fault log or error log events, depending on the \fB-e\fR option, that
185have properties with a matching name (and optionally a matching value). For
186string properties the value can be a regular expression match. Regular
187expression syntax is described in the EXTENDED REGULAR EXPRESSIONS section of
188the \fBregex\fR(7) manual page. Be careful when using the characters:
286Select log events that have properties with a matching name (and optionally a
287matching value). For string properties the value can be a regular expression
288match. Regular expression syntax is described in the EXTENDED REGULAR
289EXPRESSIONS section of the \fBregex\fR(7) manual page. Be careful when using
290the characters:
189.sp
190.in +2
191.nf
192$ * { ^ | ( ) \e
193.fi
194.in -2
195.sp
196
197\&...or a regular expression, because these are meaningful to the shell. It is
198safest to enclose any of these in single quotes. For numeric properties, the
199value can be octal, hex, or decimal.
200.RE
201
202.sp
203.ne 2
204.na
291.sp
292.in +2
293.nf
294$ * { ^ | ( ) \e
295.fi
296.in -2
297.sp
298
299\&...or a regular expression, because these are meaningful to the shell. It is
300safest to enclose any of these in single quotes. For numeric properties, the
301value can be octal, hex, or decimal.
302.RE
303
304.sp
305.ne 2
306.na
307\fB\fB-N\fR
308\fIname\fR[.\fIname\fR]*[=\fIvalue\fR][;\fIname\fR[.\fIname\fR]*[=\fIvalue\fR]]*\fR
309.ad
310.sp .6
311.RS 4n
312Select log events that have multiple properties with a matching name (and
313optionally a matching value), all of which must match the event. Multiple
314properties are separated by the \fB;\fR character and any number may be
315specified; each is interpreted as if supplied with the \fB-n\fR option. If
316the \fB;\fR character must appear in a value to be matched, it must be
317doubled as \fB;;\fR. If the \fB-N\fR option appears on the command line
318multiple times, each supplied list of properties is treated as a separate
319selector like any other selector option, so that every event matching all
320properties of any one of several property lists will be selected.
321.RE
322
323.sp
324.ne 2
325.na
326\fB\fB-p\fR\fR
327.ad
328.sp 6
329.RS 4n
330Prettifies output when used with \fB-V\fR, including displaying FMRIs as
331strings instead of embedded name-value lists.
332.RE
333
334.sp
335.ne 2
336.na
205\fB\fB-R\fR \fIdir\fR\fR
206.ad
207.sp .6
208.RS 4n
209Use the specified root directory for the log files accessed by \fBfmdump\fR,
210instead of the default root (\fB/\fR).
211.RE
212

--- 389 unchanged lines hidden (view full) ---

602.ne 2
603.na
604\fB\fB/var/fm/fmd/fltlog\fR\fR
605.ad
606.RS 22n
607Fault management fault log
608.RE
609
337\fB\fB-R\fR \fIdir\fR\fR
338.ad
339.sp .6
340.RS 4n
341Use the specified root directory for the log files accessed by \fBfmdump\fR,
342instead of the default root (\fB/\fR).
343.RE
344

--- 389 unchanged lines hidden (view full) ---

734.ne 2
735.na
736\fB\fB/var/fm/fmd/fltlog\fR\fR
737.ad
738.RS 22n
739Fault management fault log
740.RE
741
742.sp
743.ne 2
744.na
745\fB\fB/var/fm/fmd/infolog\fR\fR
746.ad
747.RS 22n
748Fault management informational report log
749.RE
750
751.sp
752.ne 2
753.na
754\fB\fB/var/fm/fmd/infolog_hival\fR\fR
755.ad
756.RS 22n
757Fault management high-value informational report log
758.RE
759
610.SH ATTRIBUTES
611See \fBattributes\fR(7) for descriptions of the following attributes:
612.sp
613
614.sp
615.TS
616box;
617c | c

--- 33 unchanged lines hidden --- 		760.SH ATTRIBUTES
761See \fBattributes\fR(7) for descriptions of the following attributes:
762.sp
763
764.sp
765.TS
766box;
767c | c

--- 33 unchanged lines hidden ---