mirror of
https://github.com/ibm-s390-linux/s390-tools.git
synced 2026-08-05 02:14:52 +00:00
b8cf861aea
generalize the collection step name from "docker" to "container host" initial version of adding data collection for OCP. all log file content might be too much for most installations Reviewed-by: Alexander Klein <alkl@de.ibm.com> Reviewed-by: Mario Held <mario.held@de.ibm.com> Reviewed-by: Mike Storzer <mstorzer@de.ibm.com> Signed-off-by: Joern Siglen <siglen@de.ibm.com> Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
126 lines
3.2 KiB
Groff
126 lines
3.2 KiB
Groff
.TH DBGINFO.SH 8 "Sep 2022" "s390-tools"
|
|
|
|
.SH NAME
|
|
dbginfo.sh \- collect runtime, configuration and trace information
|
|
for debugging Linux on IBM Z
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
\fBdbginfo.sh\fP [OPTIONS]
|
|
.br
|
|
\fBdbginfo.sh\fP {\-h|\-v}
|
|
|
|
.SH DESCRIPTION
|
|
This script collects runtime, configuration and trace information that can
|
|
be used to debug a Linux on IBM Z instance.
|
|
For Linux on z/VM, the script also traces information about the z/VM system.
|
|
Virtualization platform data is collected on a host serving this.
|
|
|
|
The debug information is written to a file
|
|
/<DIRECTORY>/DBGINFO\-<date>\-<time>\-<hostname>\-<processorid>.tgz
|
|
where [date] and [time] are the date and time when the debug data was
|
|
collected. [hostname] indicates the hostname of the system the data was
|
|
collected from. The [processorid] is taken from the processor 0 and indicates
|
|
the processor identification.
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-h\fP, \fB\-\-help\fP
|
|
Print usage information, then exit.
|
|
|
|
.TP
|
|
\fB\-v\fP, \fB\-\-version\fP
|
|
Print version information, then exit.
|
|
|
|
.TP
|
|
\fB\-d <DIRECTORY>\fP, \fB\-\-directory <DIRECTORY>\fP
|
|
Specify the DIRECTORY where the data collection stores the temporary data and the final archive.
|
|
The specified directory must already exist. If this parameter is not specified, /tmp is used by default.
|
|
|
|
.TP
|
|
\fB\-c\fP, \fB\-\-check\fP
|
|
Print online quick check (not saving any data) - can be combind with a preceding -d option.
|
|
|
|
.SH FILES
|
|
A .tgz file of the form
|
|
.PP
|
|
.nf
|
|
.fam C
|
|
DBGINFO\-<year>\-<month>\-<day>\-<hours>\-<minutes>\-<seconds>\-<hostname>\-<processorid>.tgz
|
|
|
|
.fam T
|
|
.fi
|
|
is generated and placed in the /tmp directory or in the directory specified by the -d option.
|
|
|
|
.SH EXAMPLE
|
|
Sample invocation:
|
|
.P
|
|
[root@host]# dbginfo.sh \-d /data\-collection
|
|
.br
|
|
dbginfo.sh: Debug information script version %S390_TOOLS_VERSION%
|
|
.br
|
|
Copyright IBM Corp. 2002, 2022
|
|
.PP
|
|
Hardware platform = s390x
|
|
.br
|
|
Runtime environment = z/VM
|
|
.br
|
|
Kernel version = 4.18.0 (4.18.0-305.el8.s390x)
|
|
.br
|
|
OS version / distro = Red Hat Enterprise Linux 8.4 (Ootpa)
|
|
.br
|
|
Date and time of info = 2021-08-26-15-27-58
|
|
.PP
|
|
1 of 18: Collecting sysfs
|
|
.PP
|
|
2 of 18: Collecting procfs
|
|
.PP
|
|
3 of 18: Collecting config files
|
|
.PP
|
|
4 of 18: Collecting command output
|
|
.PP
|
|
5 of 18: Collecting hyptop for z/VM - 5s output
|
|
.PP
|
|
6 of 18: Collecting z/VM output
|
|
.PP
|
|
7 of 18: Collecting network output
|
|
.PP
|
|
8 of 18: Collecting osa oat output
|
|
.PP
|
|
9 of 18: Collecting ethtool output
|
|
.PP
|
|
10 of 18: Collecting Trafic Control output
|
|
.PP
|
|
11 of 18: Collecting bridge output
|
|
.PP
|
|
12 of 18: Skip OpenVSwitch: ovs-vsctl not available
|
|
.PP
|
|
13 of 18: Skip KVM: no virsh command
|
|
.PP
|
|
14 of 18: Collecting container host output
|
|
.PP
|
|
Kubernetes ...
|
|
.br
|
|
15 of 18: Collecting NVME storage output
|
|
.PP
|
|
16 of 18: Collecting log files
|
|
.PP
|
|
0 logfiles over 50 MB
|
|
.PP
|
|
17 of 18: Postprocessing
|
|
.PP
|
|
18 of 18: Finalizing: Creating archive with collected data
|
|
.PP
|
|
Collected data was saved to:
|
|
.br
|
|
>> /data\-collection/DBGINFO\-2021\-08\-26\-15\-27\-58\-host\-012345.tgz <<
|
|
.br
|
|
Please review all collected data before sending to your service organization.
|
|
.SH HINTS
|
|
Run the script with root authority.
|
|
.br
|
|
For Linux on z/VM, only z/VM guest virtual machines with class B privileges
|
|
yield the complete debug information.
|
|
.SH AUTHOR
|
|
Linux on IBM Z development <linux390@de.ibm.com>
|