- -global
- Specifies that all the db2diag log files from
all the database partitions on all the hosts are included in the log
file processing.
Note: This command parameter is available in DB2® Version 9.7 Fix Pack 1 and later
fix packs. This option supports rotating diagnostic log files and
files located in split diagnostic data directories. In DB2 Version 9.7 Fix Pack 1, this option cannot
be used in combination with the -follow option.
In DB2 Version 9.7 Fix Pack
2 and later fix packs, this option can be used in combination with
the -follow option.
- -merge
- Merges diagnostic log files and sorts the
records based on the timestamp. This option supports rotating diagnostic
log files and files located in split diagnostic data directories.
If
this command parameter is not followed by two or more space-separated filename values,
the db2diag log files in the directory or directories
specified by the diagpath database manager configuration
parameter and alt_diagpath database manager configuration
parameter are merged. If the diagnostic data directory path is split
across multiple database partitions, only the db2diag log
files in the database partitions of the current host are merged.
If
only one filename is specified, or only one diagnostic
file exists in the path specified in the diagpath database
manager configuration parameter and if alt_diagpath database
manager configuration parameter is not set, then the single diagnostic
log file is processed by the command as though the -merge command
parameter was not specified.
Note: This command parameter is available
in DB2 Version 9.7 Fix Pack
1 and later fix packs. It cannot be used in combination with -facility, -follow,
or -archive options. Starting from DB2 Version 9.7 Fix Pack 7, the -merge option
will support automatically merging db2diag.log files
from alt_diagpath directory
- -global -merge -sdir sharedDirPathname
- Specifying the -global and -merge options
together results in all the db2diag log files from
all the database partitions on all the hosts to be merged, and the
records sorted based on the timestamp. This option supports rotating
diagnostic log files and files located in split diagnostic data directories.
Note: The -sdir sharedDirPathname option
must be specified to temporarily store the merged diagnostic log files
obtained from the different hosts. The temporary merged diagnostic
log files are deleted after processing has been completed. The sharedDirPathname must
specify a shared directory to which all hosts have access and write
permission.
- filename
- Specifies one or more space-separated path names
of DB2 diagnostic logs to be
processed. If the file name is omitted, the db2diag log
file from the current directory is processed. If the file is not
found, the directory or directories set by the diagpath database
manager configuration parameter is searched.
- -facility | -fac
- Reads the files from the corresponding facility. A facility is
a logical grouping of records. For example, all optimizer statistics
records are grouped into the OPTSTATS facility. The output will be
in text format by default. Valid facility options are the following:
- ALL
- Returns records from all facilities.
- MAIN
- Returns records from DB2 general diagnostic logs, such as the db2diag log
file, and rotating event logs.
- OPTSTATS
- Returns records related to optimizer statistics.
- -fmt formatString
- Formats the db2diag output using a format string, formatString,
containing record fields in the form %field, %{field}, @field,
or @{field}. The %{field} and @{field} are
used to separate a field name from the alphanumeric (or any other
allowed character) that may follow the field name. All field names
are case-insensitive. Field names can be shortened to the several
first characters that are necessary to recognize a field name without
ambiguity. In addition, aliases can be used for fields with long names.
A prefix before a field name, %, or @, specifies whether a text preceding
the field will be displayed (%) or not (@), if the field is empty.
The
following fields are currently available:
- timestamp | ts
- Time stamp. This field can be divided into its constituent fields: %tsyear, %tsmonth, %tsday, %tshour, %tsmin (minute), %tssec (second), %tsmsec (microsecond
for UNIX operating systems,
millisecond for Windows operating
systems).
- timezone | tz
- Number of minutes difference from UTC (Universal Coordinated Time).
For example, -300 is Eastern Time.
- recordid | recid
- A unique alphanumeric identifier for a record, such as I11455A696.
- audience
- Intended audience for a logged message. 'E' indicates
external users (IBM customers,
service analysts, and developers). 'I' indicates
internal users (service analysts and developers). 'D' indicates
debugging information for developers.
- level
- The
diagnostic level of a message. The levels are Info, Warning, Error, Severe, Critical,
and Event.
- source
- Location from which the logged error originated: Origin, OS, Received,
or Sent.
- instance | inst
- Instance name.
- node
- Database partition server number.
- database | db
- Database name.
- pid
- Process ID.
- tid
- Thread ID.
- eduid
- EDU ID.
- eduname
- EDU name.
- process
- Name associated with the process ID, in double quotation marks.
For example, "db2sysc.exe".
- product
- Product name. For example, DB2 COMMON.
- component
- Component name.
- funcname
- Function name.
- probe
- Probe number.
- function
- Full function description: %prod, %comp, %funcname, probe:%probe.
- appid
- The application ID. This value is the same as the appl_id monitor
element data. For detailed information about how to interpret this
value, see "appl_id - Application ID monitor element".
- coordnode
- Coordinator partition.
- coordindex
- Coordinator index.
- apphdl
- Application handle: %coordnode - %coordindex.
- message | msg
- Error message.
- calledprod
- Product name of the function that returned an error.
- calledcomp
- Component name of the function that returned an error.
- calledfunc
- Name of the function that returned an error.
- called
- Full description of the function that returned an error: %calledprod,
%calledcomp, %calledfunc.
- rcval
- Return code value (32 bytes).
- rcdesc
- Error description.
- retcode | rc
- Return code returned by the function called: %rcval %rcdesc.
- errno
- System error number.
- errname
- System-specific error name.
- oserror
- Operating system error returned by a system call: %errno
%errname.
- callstack
- Call stack.
- datadesc
- Data description.
- dataobject
- Data object.
- data
- Full data section of a message: %datadesc %dataobject.
- argdesc
- Argument description.
- argobject
- Argument object.
- arg
- Arguments of a function call that returned an error: %argdesc
%argobject.
- Event descriptions:
- impact
- User impact (for events only).
- startevent
- Start event description (*).
- stopevent
- Stop event description (*).
- changeevent
- Change event description (*).
- init
- Initialization event description (*).
- fini
- Finish/finalize event description (*).
- startup
- Startup event description (*).
- terminate
- Terminate event description (*).
- bringdown
- Bringdown event description (*).
- interrupt
- Interrupt event description (*).
- associate
- Associate event description (*).
- disassociate
- Disassociate event description (*).
- changecfg
- Change configuration event description (*).
- transfer
- Transfer event description (*).
- dispatch
- Dispatch event description (*).
- switch
- Switch event description (*).
- report
- Report event description (*).
- get
- Get event description (*).
- free
- Free event description (*).
- open
- Open event description (*).
- close
- Close event description (*).
- work
- Work event description (*).
- wait
- Wait event description (*).
- available
- Available event description (*).
- connect
- Connect event description (*).
- disconnect
- Disconnect event description (*).
- accept
- Accept event description (*).
- recv
- Receive event description (*).
- send
- Send event description (*).
- create
- Create event description (*).
- destroy
- Destroy event description (*).
- request
- Request event description (*).
- reply
- Reply event description (*).
- dependency
- Dependency event description (*).
- write
- Write event description (*).
- read
- Read event description (*).
- reset
- Reset event description (*).
- collect
- Collect event description (*).
- add
- Add event description (*).
- alter
- Alter event description (*).
- drop
- Drop event description (*).
- invalidate
- Invalidate event description (*).
- grant
- Grant event description (*).
- revoke
- Revoke event description (*).
- (*) Each event field has the following subfields:
- {event}type
- Event type (START, STOP, READ, WRITE, GET).
- {event}desc
- Event description (header with event information).
- {event}state
- Event state (success, failure, start, stop, in progress, idle)
or event progress (in %).
- {event}attr
- Event attributes (business level, cached, sync, async, internal,
external, logical, physical, auto, manual, temporary, permanent).
- {event}objid
- Unique object identifier (TABLE, CFG, DBM).
- {event}objname
- Event object name (for example, "schema.tablename").
- {event}objdata
- Object data (used if object is not a string or simple integer
type, for example, data structure or some complex type).
- {event}qtype
- Event qualifier type (FROM, TO, ON, FOR, AT, BY, CONTEXT).
- {event}qname
- Event qualifier name/value (for example, FOR "DB ABC").
- {event}qdhdr
- Event qualifier data header (contains type, text description and
size of data). Used together with the %{event}qdata field.
- {event}qdata
- Event qualifier data (used if qualifier is not a string or simple
integer type, for example, some data structure or complex type).
In the above, keyword {event} should
be substituted by event type for a specific event (for example, start,
stop, change, read, write).
To always display the text preceding a field name
(for example, for the required fields), the % field prefix should
be used. To display the text preceding a field name when this field
contains some data, the @ prefix should be used. Any combination of
required and optional fields with the corresponding text descriptions
is allowed.
The following special characters are recognized
within a format string: \n, \r, \f, \v,
and \t.
In contrast to other fields, the data
and argument fields can contain several sections. To output a specific
section, add the [n] after the
field name where n is a section number (1≤
n ≤64). For example, to output the first data object and
the second data description sections, use %{dataobj}[1] and %{datadesc}[2].
When [n] is not used, all sections
logged are output using pre-formatted logged data exactly as appears
in a log message, so there is no need to add the applicable text description
and separating newline before each data field, argument field, or
section.
- -filter fieldPatternList | -g fieldPatternList
- fieldPatternList is a comma-separated list
of field-pattern pairs in the following format: fieldName operator searchPattern.
The operator can be one of the following:
- =
- Selects only those records that contain matches that form whole
words. (Word search.)
- :=
- Selects those records that contain matches in which a search pattern
can be part of a larger expression.
- !=
- Selects only non-matching lines. (Invert word match.)
- !:=
- Selects only non-matching lines in which the search pattern can
be part of a larger expression.
- ^=
- Selects records for which the field value starts with the search
pattern specified.
- !^=
- Selects records for which the field value does not start with
the search pattern specified.
The same fields are available as described for
the -fmt option, except that the % and @ prefixes
are not used for this option.
- -gi fieldPatternList
- Same as -g, but case-insensitive.
- -gv fieldPatternList
- Searches for messages that do not match the specified pattern.
- -gvi | -giv fieldPatternList
- Same as -gv, but case-insensitive.
- -lastrecords number-of-records
- Displays and filters the last number of records specified from
the db2diag log file. For each db2diag log file, this parameter checks
whether the number of records specified are available. If the number
of records available in the log file is less than the number of records
you specified, the db2diag command processes all
the records available in the file. If split diagnostic data directory
paths are used, the last number of records specified is returned for
each db2diag log file in each path.
- -pid processIDList
- Displays only log messages with the process IDs listed.
- -tid threadIDList
- Displays only log messages with the thread IDs listed.
- -eduid EduIDList
- Finds all records with a specified EDU ID from a list of EDU IDs
containing one or more comma separated numeric values.
- -n | -node nodeList
- Displays only log messages with the database partition numbers
listed.
- -e | -error errorList
- Displays only log messages with the error numbers listed.
- -l | -level levelList
- Finds all records with a specified severity level from a list
of severity levels containing one or more comma separated text values,
namely: Info, Warning, Error, Severe, Critical and Event.
- -c | -count
- Displays the number of records found.
- -v | -invert
- Inverts the pattern matching to select all records that do not
match the specified pattern
- -strict
- Displays records using only one field: value pair
per line. All empty fields are skipped. This can be used for scripts
to simplify parsing.
- -V | -verbose
- Outputs all fields, including empty fields.
- -exist
- Defines how fields in a record are processed when a search is
requested. If this option is specified, a field must exist in order
to be processed.
- -cbe
- Common Base Event (CBE) Canonical Situation Data.
- -o | -output pathName
- Saves the output to a file specified by a fully qualified pathName.
- -f | -follow
- If the input file is a single or rotating db2diag log
file, specifies that the tool will not terminate after the last record
of the input file has been processed. Instead, it sleeps for a specified
interval of time (sleepInterval), and then attempts
to read and process further records from the input file as they become
available. As of Version 9.7 Fix Pack 2, only the records from the
last 8 kilobytes of the input file are processed.
The
follow mode will also handle rotating db2diag log
files. For example, the command will read the latest rotating diagnostic
log file in use (db2diag.23.log) and follow along
to the next created rotating log file (db2diag.24.log)
when the db2diag.23.log log file meets its size
limit.
This option can be used when monitoring records being
written to a file by another process. The
startTime option
can be specified to show all the records logged after this time. The
startTime option
is specified using the following format:
YYYY-MM-DD-hh.mm.ss.nnnnnn,
where
- YYYY
- Specifies a year.
- MM
- Specifies a month of a year (01 through 12).
- DD
- Specifies a day of a month (01 through 31).
- hh
- Specifies an hour of a day (00 through 23).
- mm
- Specifies a minute of an hour (00 through 59).
- ss
- Specifies a second of a minute (00 through 59).
- nnnnnn
- Specifies microseconds on UNIX operating
systems, or milliseconds on Windows
operating systems.
Some or all of the fields that follow the year field
can be omitted. If they are omitted, the default values will be used.
The default values are
1 for the month and day,
and
0 for all other fields.
If an exact match
for the record time stamp does not exist in the diagnostic log file,
the closest time earlier than the specified time stamp will be used.
The sleepInterval option
specifies a sleep interval in seconds. If a smaller time unit is
required, it can be specified as a floating point value. The default
value is 2 seconds
- -H | -history
- Displays the history of logged messages for the specified time
interval. This option can be specified with the following options:
- historyPeriod
- Specifies that logged messages are displayed starting from the
most recent logged record, for the duration specified by historyPeriod.
The historyPeriod option is specified using the
following format: Number timeUnit,
where Number is the number of time units and timeUnit indicates
the type of time unit: M (month), d (day), h (hour), m (minute),
and s (second). The default value for Number is 30,
and for timeUnit is m.
- historyPeriod:historyReference
- Specifies that logged messages are displayed that
were recorded within the time period after the start time specified
by historyReference (if an explicit positive value
for historyPeriod is given), or logged messages
are displayed that were recorded within the time period before the
end time specified by historyReference (if a negative
value for historyPeriod is given, or by default).
The
format is
YYYY-
MM-
DD-
hh.
mm.
ss.
nnnnnn,
where:
- YYYY
- Specifies a year.
- MM
- Specifies a month of a year (01 through 12).
- DD
- Specifies a day of a month (01 through 31).
- hh
- Specifies an hour of a day (00 through 23).
- mm
- Specifies a minute of an hour (00 through 59).
- ss
- Specifies a second of a minute (00 through 59).
- nnnnnn
- Specifies microseconds (UNIX operating
systems) or milliseconds (Windows operating
systems).
- -t | -time
- Specifies a time stamp value. This option can be specified with
one or both of the following options:
- startTime
- Displays all messages that are logged at startTime and
after the startTime.
- :endTime
- Displays all messages that are logged before endTime and
at endTime.
To display messages that are logged from startTime to endTime,
specify -t startTime:endTime. The
format is
YYYY-
MM-
DD-
hh.
mm.
ss.
nnnnnn,
where:
- YYYY
- Specifies a year.
- MM
- Specifies a month of a year (01 through 12).
- DD
- Specifies a day of a month (01 through 31).
- hh
- Specifies an hour of a day (00 through 23).
- mm
- Specifies a minute of an hour (00 through 59).
- ss
- Specifies a second of a minute (00 through 59).
- nnnnnn
- Specifies microseconds (UNIX operating
systems) or milliseconds (Windows operating
systems).
Some or all of the fields that follow the year field
can be omitted. If they are omitted, the default values will be used.
The default values are
1 for the month and day,
and
0 for all other fields.
If an exact match
for the record time stamp does not exist in the diagnostic log file,
the time closest to the time stamp specified will be used.
- -A | -archive dirName
- Archives both single and rotating
diagnostic log files. When this option is specified, all other options
are ignored. If one or more file names are specified, each file is
processed individually. A timestamp, in the format YYYY-MM-DD-hh.mm.ss,
is appended to the file name.
You can specify the name of the
file and directory where it is to be archived. If the directory is
not specified, the file is archived in the directory where the file
is located and the directory name is extracted from the file name.
If you specify a directory but no file name, the
current directory is searched for the db2diag log
file. If found, the file will be archived in the specified directory.
If the file is not found, the directories specified by the diagpath and alt_diagpath configuration
parameters are searched for the db2diag log file.
If found, it is archived in the directory specified.
If you do not specify a file or a directory, the
current directory is searched for the db2diag log
file. If found, it is archived in the current directory. If the file
is not found, the directories specified by the diagpath and alt_diagpath configuration
parameters are searched for the db2diag log file.
If found, it is archived in the directory specified by the diagpath or alt_diagpath configuration
parameter.
Starting with Version 9.7,
Fixpack 4, the
db2diag –archive option
is available with IBM® Data Server
Driver Package and IBM Data
Server for ODBC and CLI. This option enables you to archive the diagnostic
log file on an instance-less client. For example:
$ db2diag -A
db2diag: Moving "/home/usr1/clidriver/db2dump/db2diag.log"
to "/home/usr1/clidriver/db2dump/db2diag.log_2010-09-14-01.16.26"
- -readfile
- Forces reading from a diagnostic log file
ignoring any terminal input. This option can be used in scripts to
guarantee that db2diag will read from a file and
not from a terminal, especially in situations when stdin is
disabled or when automated tools are used. Running the db2diag command
using rah or db2_all also requires
the -readfile option to be used.
- -rc rcList | switch
- Displays descriptions of DB2 internal
error return codes for a space separated list, rcList,
of the particular ZRC or ECF hexadecimal or negative decimal return
codes. A full list of ZRC or ECF return codes can be displayed by
specifying one of the following switches:
- zrc
- Displays short descriptions of DB2 ZRC
return codes.
- ecf
- Displays short descriptions of DB2 ECF
return codes.
- html
- Displays short descriptions of DB2 ZRC
return codes in the HTML format.
When this option is specified, all other options
are ignored and output is directed to a display.
- -ecfid ecfId
- Displays function information extracted from the numeric ecfId.
When this option is specified, all other options are ignored.
- -h | -help | ?
- Displays help information. When this option is specified, all
other options are ignored, and only the help information is displayed.
If a list of options, optionList, containing one
or more comma separated command parameters is omitted, a list of all
available options with short descriptions is displayed. For each option
specified in the optionList, more detailed information
and usage examples are displayed. Help output can be modified by using
one of the following switches in place of the optionList argument
to display more information about the tool and its usage:
- brief
- Displays help information for all options without examples.
- examples
- Displays a few typical examples to assist in using the tool.
- tutorial
- Displays examples that describe advanced features.
- notes
- Displays usage notes and restrictions.
- all
- Displays complete information about all options, including usage
examples for each option.
- -lastlines number-of-lines
- Displays and filters the last number of lines specified from the
db2diag log file. For each db2diag log file, this parameter checks
whether the number of lines specified are available. If the number
of lines available in the log file is less than the number of records
you specified, the db2diag command processes all the lines available
in the file. If split diagnostic data directory paths are used, the
last number of lines specified is returned for each db2diag log file
in each path.
DB2 Version 9.7 for Linux, UNIX, and Windows
>>-db2diag--+----------+--+---------+---------------------------> '- -global-' '- -merge-' >--+---------------------------+--------------------------------> '- -sdir--sharedDirPathname-' .----------------------------------. V | >----+------------------------------+-+-------------------------> +-filename---------------------+ '-+- -facility-+--+-ALL------+-' '- -fac------' +-MAIN-----+ '-OPTSTATS-' >--+--------------------------------+---------------------------> '-+- -g--fieldPatternList------+-' +- -filter--fieldPatternList-+ +- -gi--fieldPatternList-----+ +- -gv--fieldPatternList-----+ +- -giv--fieldPatternList----+ '- -gvi--fieldPatternList----' >--+----------------------------------+-------------------------> '- -lastrecords--number-of-records-' >--+----------------------+--+---------------------+------------> '- -pid--processIDList-' '- -tid--threadIDList-' >--+--------------------+--+----------------------+-------------> '- -eduid--EduIDList-' '-+- -n----+--nodeList-' '- -node-' >--+------------------------+--+------------------------+-------> '-+- -e-----+--errorList-' '-+- -l-----+--levelList-' '- -error-' '- -level-' >--+-------------+--+---------------+--+-------+----------------> '-+- -c-----+-' '-+- -V-------+-' '- -cbe-' '- -count-' '- -verbose-' >--+----------+--+---------+--+----------+----------------------> +- -v------+ '- -exist-' '- -strict-' '- -invert-' >--+------------------+--+---------------------+----------------> '- -rc--+-rcList-+-' '- -fmt--formatString-' '-switch-' >--+------------------------+-----------------------------------> '-+- -o------+--pathName-' '- -output-' >--+-----------------------------------------------+------------> '-+- -f------+--+-----------------------------+-' '- -follow-' +-startTime-------------------+ +-:--sleepInterval------------+ '-startTime--:--sleepInterval-' >--+-------------------------------------------------------+----> '-+- -H-------+--+------------------------------------+-' '- -history-' +-historyPeriod----------------------+ +-:--historyReference----------------+ '-historyPeriod--:--historyReference-' >--+---------------------------------------+--------------------> '-+- -t----+--+-startTime-------------+-' '- -time-' +-:--endTime------------+ '-startTime--:--endTime-' >--+----------------------------+--+------------+---------------> '-+- -A-------+--+---------+-' '- -readfile-' '- -archive-' '-dirName-' >--+---------+--+---------------------------------------+-------> '- -ecfid-' +- -h-- -optionList---------------------+ '- -help-- -optionList--?-- -optionList-' >--+------------------------------+---------------------------->< '- -lastlines--number-of-lines-'