oled.man

.TH OLED 8 "Nov 2024" "Oracle Linux Enhanced Diagnostics"

.SH NAME
oled - Interface to invoke other diagnostic tools

.SH SYNOPSIS
oled [-h | --help | -v | --version] [sub_command] [options]

.SH DESCRIPTION
OLED (Oracle Linux Enhanced Diagnostics) is a collection of diagnostic tools
and scripts. The \fBoled\fR command is used to invoke these other tools/scripts.
See usage below, for available options.

.TP
# oled --help
usage: oled {-h | -v | COMMAND [ARGS]}

Valid commands:
     kstack      -- Gather kernel stack based on the process status or PID
     lkce        -- Linux Kernel Core Extractor
     memstate    -- Capture and analyze memory usage statistics
     oscheck     -- Check OS configuration
     scanfs      -- Scan KVM images for corruption, supports XFS and EXT4
     scripts     -- Run additional oled-tools scripts
     sosdiff     -- Compare two sos reports
     syswatch    -- Execute user-provided commands based on the CPU utilization
     vmcore_sz   -- Estimating vmcore size before kernel dump
     trace       -- trace a workload
     neighbrwatch -- Read and process ip-neighbor entries

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit

NOTE: Must run as root.

Please check the man page of each sub-command to learn more about that tool and
its usage.

.SH EXAMPLES
.TP

# oled memstate -h
usage: oled memstate [-h] [-p [PID]] [-s] [-n [FILE]] [-v] [-f [INTERVAL]]

memstate: Capture and analyze memory usage data on this system.

optional arguments:
  -h, --help            show this help message and exit
  -p [PID], --pss [PID]
                        display per-process memory usage
  -s, --slab            analyze/display slab usage
  -n [FILE], --numa [FILE]
                        analyze/display NUMA stats
  -v, --verbose         verbose data capture; combine with other options
  -f [INTERVAL], --frequency [INTERVAL]
                        interval at which data should be collected (default:
                        30s)

.SH SEE ALSO
.TP
additional-scripts(8), oled-kstack(8), oled-lkce(8), oled-memstate(8), oled-oomwatch(8), oled-oscheck(8), oled-scanfs(8), oled-scripts(8), oled-sosdiff(8) oled-syswatch(8), oled-vmcore_sz(8), oled-neighbrwatch(8)

.SH REPORTING BUGS
.TP
Please contact Oracle Linux Support to report any bugs for OLED tools.