Introduction to the dfstrace command suite
Options
The following options are used with many dfstrace commands. They are also listed with the commands that use them.
-set set_name
Specifies the name of an event set to be utilized by the command. An event set is a module designed to track specific events within the DFS kernel or
within one or more server processes. Each event set generates trace messages relative to the type of events that it tracks and writes information on each event to from one to eight trace logs.
Tracing by event set allows users of the dfstrace commands to more quickly isolate and diagnose a problem.
Following are some of the DFS kernel event sets that you can see:
· cm - Cache Manager package
· fshost - File exporter host package
· fx - File exporter package
· episode/anode - LFS anode package
· episode/logbuf - LFS buffer/logging package
· episode/vnops - LFS vnode package
· tkc - Token cache package
· tkm - Token manager package
· tpq - Thread pool queue package
· xops - Vnode-to-fileset synchronization package
Following are some of the server process event sets that you can see:
· bosserver - bosserver package
· dacl - DFS ACL package
· dfsauth - DFS security package
· flserver - flserver package
· ftserver - ftserver package
· ftutil - Fileset utility package
· ubikdisk - Disk I/O subset of Ubik package
· ubikvote - Sync site election subset of Ubik package
-log log_name
Specifies the name of a server process or kernel trace log to be utilized by the command. All logs are stored in kernel or server process memory that
is allocated on the initialization of the kernel or server process. The default size of a log, which is measured in 4-kilobyte units (kwords), is predefined; however, this size can be changed by a
system administrator. Any number of event sets can write to a single log.
-cdsentry server_entry_in_CDS
Specifies the name of a server process to which to connect. This option is required when performing operations on server process logs and
event sets; it must be omitted when performing operations on kernel logs and event sets. The full DCE path name of a server process must be specified with this option
(/.:/hosts/machine/process_name).
-help
Prints the online help for the command. All other valid options specified with this option are ignored. For complete details about receiving help, see the
dfs_intro(8dfs) reference page.
Description
Command in the dfstrace command suite are used by system administrators to diagnose problems within the DFS kernel or within the server processes that
interface with the dfstrace command suite. This diagnosis is performed by reading the output of trace logs containing diagnostic messages written by event sets that track specific actions
performed by the DFS kernel or a server process.
The commands in the dfstrace command suite allow you to perform the following functions:
· List information about event sets (using the dfstrace lsset command)
· Set an event set's state (using the dfstrace setset command)
· List information about trace logs (using the dfstrace lslog command)
· Change the size of trace logs (using the dfstrace setlog command)
· Dump the contents of trace logs (using the dfstrace dump command)
· Clear trace logs (using the dfstrace clear command)
Receiving Help
There are several different ways to receive help about DFS commands. The following examples summarize the syntax for the different help options:
$ man dfstrace
Displays the reference page for the command suite.
$ man dfstrace_command
Displays the reference page for an individual command. You must use an _ (underscore) to connect the command suite to the command name.
Do not use the underscore when issuing the command in DFS.
$ dfstrace help
Displays a list of commands in a command suite.
$ dfstrace help command
Displays the syntax for a single command.
$ dfstrace apropos -topic string
Displays a short description of any commands that match the specified string.
Consult the dfs_intro(8dfs) reference page for complete information about the DFS help facilities.
Privilege Required
Except for the dfstrace help and dfstrace apropos commands, which require no privilege, executing the dfstrace commands require one
of the following two types of privilege, depending on the operation being performed:
· If the dfstrace command is executed on a kernel log or event set, the issuer must be logged in as root on the local machine.
· If the dfstrace command is executed on a server process log or event set, the issuer must be listed in the admin list associated with that process on the machine specified with the -cdsentry option (for example, admin.fl for the flserver process and admin.ft for the ftserver process).
Specific privilege information is listed with each command's description. In addition, if the BOS Server, on the same machine as a server process, is running with DFS authorization checking disabled, no privilege is required to issue dfstrace commands on the event sets and logs associated with that server process.
Related Information
Commands: dfs_intro(8dfs)