OOMAnalyser

Introduction

OOMAnalyser is a web page to analyse and explain the OOM message of a Linux kernel. The analysis is performed automatically in the browser. You get a summary and a list of (almost) all parameters with their values and a short explanation. Among them are also 2 diagrams that illustrate the memory usage.

OOMAnalyser consists of a web page where the OOM message is copied into the input field. JavaScript code extracts the data and displays the details. All processing takes place in the browser. No data is transferred to any server. Therefore, confidential OOM messages can also be analyzed, and the analysis can be performed in environments without an Internet connection.

This project is written in Python and uses Transcrypt to translate Python code into JavaScript.

The current online version is available at https://www.carstengrohmann.de/oom/ .

Installation

Installing OOMAnalyser is quite easy since OOMAnalyser consists only of two files, an HTML file and a JavaScript file. Both can be stored locally to use OOMAnalyser without an Internet connection.

Installation steps

Open https://www.carstengrohmann.de/oom/ in a browser
Browse down to the paragraph "Local Installation" at the end of the document
Download the HTML file and the JavaScript file to the main directory
Open the file OOMAnalyser.html in your favourite browser

Building OOMAnalyser

Requirements

Prepare the build environment

Clone the repository:

  # git clone https://git.sr.ht/~carstengrohmann/OOMAnalyser

Set up the Python virtual environment:

  # virtualenv env
  # . env/bin/activate
  # env/bin/pip install -Ur requirements.txt

  or

  # make venv

Build OOMAnalyser

# . env/bin/activate
# transcrypt --build --map --nomin -e 6 OOMAnalyser.py
# rollup --config rollup.config.mjs

or

# make build

Usage

Change into the source directory and start your own small web server.

Start Python built-in web server:

  # python3 -m http.server 8080 --bind 127.0.0.1

  or

  # make websrv

Open the URL http://localhost:8080/OOMAnalyser.html in your favorite browser.

Publish a new release

Naming

NEW_VERSION - Version string of the new version e.g. 0.5.0
NEW_GIT_VERSION - Git version string of the new version e.g. v0.5.0

Steps

Commit all open changes
Finalise changelog and add a new "Note" section to OOMAnalyser.html
Updating the documentation in README.md and OOMAnalyser.html

Commit changes

 # git commit -m "Update documentation"

Update version number in OOMAnalyser.py, OOMAnalyser.html and Makefile
```
 # git commit -m "Bump version number to <NEW_VERSION>"
```

Create a new annotated git tag with shortened changelog

 # git tag -a <NEW_GIT_VERSION>

 Template:

 Version <NEW_VERSION>

 OMAnalyser is a small project to transform the OOM message of a Linux
 kernel into a more user-friendly format.

 The current online version is available at
 https://www.carstengrohmann.de/oom/.

 Changelog:
  * <add all change log entries from OOMAnalyser.html>

Push changes into public repositories
```
 # git push
 # git push origin --tags
```
Create release packages in zip and tar.gz format
```
 # make release
```
Create release on SourceHut & GitHub
Start a new development cycle by setting new version numbers

Start new changelog block in OOMAnalyser.html

# Template

<h3>Version <next version> - 2024-XX-XX:</h3>

<h4>General</h4>
<ol>
    <li>...</li>
</ol>

Commit changes

# git commit -m "Start new development cycle"

Resources

Project Page
Source Code (mirrored on GitHub)
Transcrypt
Linux man pages online
How to read and decode OOM messages
Kernel Source code starting points:
- mm/omm_kill.c at kernel.org or more comfortable mm/omm_kill.c at elixir.bootlin.com
- mm/page_alloc.c:zone_watermark_ok() at kernel.org or more comfortable mm/page_alloc.c:zone_watermark_ok() at elixir.bootlin.com

Known Bugs/Issues

Check the project issue tracker for current open bugs. New bugs can be reported there also.

License

This project is licensed under the MIT license.

Copyright (c) 2017-2024 Carsten Grohmann, mail <add at here> carstengrohmann.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Enjoy!

Carsten Grohmann