https://github.com/oracle/oled-tools
https://github.com/oracle/oled-tools
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/oracle/oled-tools
- Owner: oracle
- License: gpl-2.0
- Created: 2021-07-08T23:33:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T13:50:36.000Z (11 months ago)
- Last Synced: 2025-04-10T16:12:22.514Z (9 months ago)
- Language: Python
- Size: 392 KB
- Stars: 35
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# oled-tools
Oracle Linux Enhanced Diagnostic (OLED) tools is a collection of tools,
scripts, configs, etc. that collect and analyze data about the health of the
system in order to root cause and resolve any system issues.
## Components
The oled-tools repo includes the following debug tools/scripts that aid in
gathering additional debug data from the system. Please review the
corresponding man pages for more details.
- lkce: Extracts data from a vmcore or from within the kdump kernel after a
crash
- memstate: Captures and analyzes various memory usage statistics on the
running system
- filecache: List the paths of the biggest files present in the page cache
(note: this is present only on the x86-64 architecture)
- dentrycache: Lists a sample of file paths which have active dentries in the
dentry hash table
(note: this is present only on the x86-64 architecture)
- kstack: Collects the kernel stack trace for selected processes, based on
status or PID
- syswatch: Execute user-provided commands when CPU utilization reaches a
threshold
- scanfs: Scan KVM images for corruption, supports XFS and EXT4
- vmcore-utils: Estimating vmcore size before kernel dump
## Installation
### Build dependencies
- `make`
- `python3`
- `zlib-devel`
- `bzip2-devel`
- `elfutils-devel`
### Runtime dependencies
- `python3`
- `zlib`
- `bzip2-libs`
- `elfutils-libs`
### Build and install
```bash
$ git clone https://github.com/oracle/oled-tools.git
$ cd oled-tools
$ make
$ make install
```
`lkce` requires additional setup the first time - it is recommended to run
the following command after oled-tools is installed:
```bash
$ [ -f /etc/oled/lkce/lkce.conf ] || sudo oled lkce configure --default
```
## Usage
`oled-tools` must be run as root. After it has been installed, it can be run
with
```
sudo oled [args]
```
Run `sudo oled --help` to see a list of subcommands supported and other options
and `sudo oled {-h | --help}` to see help of specific commands.
You can also consult man pages `oled(8)` and `oled-(8)`.
## Contributing
This project welcomes contributions from the community. Before submitting a
pull request, please [review our contribution guide](./CONTRIBUTING.md)
## Security
Please consult the [security guide](./SECURITY.md) for our responsible security
vulnerability disclosure process
## License
oled-tools is licensed under [GPLv2](LICENSE.txt).