sanfstrace

Enables and disables tracing.

Read syntax diagramSkip visual syntax diagram
>>-sanfstrace--help--------------------------------------------><

or

Read syntax diagramSkip visual syntax diagram
>>-sanfstrace--list--------------------------------------------><

or

Read syntax diagramSkip visual syntax diagram
>>-sanfstrace--log--+----------------+-------------------------->
                    '- -delay=--time-'

>--+----------------------+------------------------------------><
   '- -f=--trace_log_file-'

or

Read syntax diagramSkip visual syntax diagram
>>-sanfstrace--ringsize--size----------------------------------><

or

Read syntax diagramSkip visual syntax diagram
>>-sanfstrace--set--+--------------------------+---------------->
                    |           .-,----------. |
                    |           V            | |
                    '- -class=----class_name-+-'

>--+------------------------+----------------------------------><
   '- -level=--level_number-'

or

Read syntax diagramSkip visual syntax diagram
>>-sanfstrace--stats-------------------------------------------><

Parameters

help
Displays a description of this command.
list
Lists trace status, that is, the trace class names and IDs of client driver debugging messages and the current tracing level for each class. A tracing level of zero indicates that the trace class is disabled.
log
Specifies that the trace utility continuously log trace messages in a specified trace file or to the standard output stream. After the trace utility has logged a message, it will not be able to retrieve it again. To end this function use Ctrl+C, when the function is running in the foreground, or use the kill -9 process_id command, when it is running in the background.
ringsize size
Sets the size, in kilobytes, of the trace ring buffer. You can specify a size of 4 to 512.
set
Sets the tracing level for one or more specified trace classes of client driver debugging messages or all trace classes.
stats
Displays trace statistics.
–class=class_name
Identifies one or more classes for which to set the tracing level. The –level parameter must immediately follow a –class parameter. When you specify more than one class name, separate the names with a comma or a space. A maximum of 20 class names can be specified for each –class parameter.
–delay=time
Limits the frequency that the sanfstrace log command queries the driver for new messages. This parameter specifies the minimum time between successive retrieval requests in order to prevent the trace utility from affecting driver performance. It creates a delay that is at least as long as the specified delay time or as long as it takes to process previously retrieved data, whichever is longer. The default is one second. The minimum value is zero, which disables the delay option, and the maximum value is 360. All delay values are in seconds by default unless the 'ms' (millisecond) quantifier is specified.
Tip: If the log reports lost messages, try reducing the value of the –delay parameter.
–f=trace_log_file
Specifies the file path and output file name for trace logging. The default is the standard output device. If the specified trace log file exists, the trace utility opens the file and appends messages to it. If the trace log file does not already exist, the utility creates the file.
–level=level_number
Specifies the tracing level of the classes that are specified by a –class parameter that immediately proceeds the –level parameter. If a –class parameter does not proceed the –level parameter, all classes are set to the specified level. Possible values for the level number are 0 through 9. Setting the level to 0 turns off tracing for the specified class.
Restriction: Although values for the –level parameter can be specified in the range 0 through 9, the current implementation for CSM classes uses a maximum value of 5, and the non-CSM classes only differentiate zero (disabled) from non-zero (enabled).
Note: A trace level of 0 disables tracing, and any nonzero trace level enables tracing and is reported as 1 (enabled).
Tip: You can specify multiple sets of –class and –level parameters in a single command. If a command affects the same class multiple times, the last occurrence in the command line applies.

Prerequisites

This task must be performed only by trained service technicians. You must have root or Administrator privileges to use this command. On UNIX clients, you must have super-user privileges to use this command.

Description

The sanfstrace set command enables you to set on or off trace classes of client driver debugging messages. The First Failure Data Capture (FFDC) class of driver trace messages is always enabled and cannot be disabled. On Windows, the DBG_ERROR class of trace messages are also enabled in a typical client configuration. All other trace classes are disabled by default when the client driver is loaded. Use the sanfstrace list command to view the status of trace classes.

The sanfstrace log command enables you to display or write to a log file accumulated trace messages from the client driver.

Example

List trace levels The following example lists traces on a Solaris client with no tracing enabled:
sanfstrace list

        Class Name                      Level
        ----------                      -----
        CSM:LEASE            (ID=0  )     0
        CSM_XMTRCV           (ID=1  )     0
        CSM:OBJECT           (ID=2  )     0
        CSM:CACHE            (ID=3  )     0
        CSM:MC_SES           (ID=4  )     0
        CSM:CSM_SES          (ID=5  )     0
        CSM:MC_DATA          (ID=6  )     0
        CSM:MC_RNGE          (ID=7  )     0
        CSM:MC_RNGE          (ID=8  )     0
        CSM:CSM_RNGE         (ID=9  )     0
        CSM:ALLOC            (ID=10 )     0
        CSM:OBJATTR          (ID=11 )     0
        CSM:SOCKET           (ID=12 )     0
        CSM:MISC             (ID=13 )     0
        CSM:MSG              (ID=141)     0
        ULD:CONFIG           (ID=127)     0
        ULD:MOUNT            (ID=128)     0
        ULD:DISK             (ID=129)     0
        ULD:PAGER            (ID=130)     0
        ULD:VFSOP            (ID=131)     0
        ULD:VNODEOP          (ID=132)     0
        ULD:IO               (ID=133)     0
        ULD:VNODE            (ID=134)     0
        ULD:RNGLOCK          (ID=135)     0
        ULD:RDWR             (ID=136)     0
        ULD:ATTR             (ID=137)     0
        ULD:LOOKUP           (ID=138)     0
        ULD:CLEANER          (ID=139)     0
        ULD:CAPTURE          (ID=140)     0
        ULD:FFDC             (ID=143)     0

Parent topic: Service commands and utilities

Library | Support | Terms of use | Feedback
(C) Copyright IBM Corporation 2003, 2004. All Rights Reserved.
IBM TotalStorage SAN File System v2.2