OOMAnalyser/README.md

# OOMAnalyser

## Introduction

OOMAnalyser is a small project to transform the OOM output of a Linux kernel
into a more human friendly format and show the information on a single web
page. All data will be processed locally in your browser - the data will not
transferred to foreign servers. Thereby the OOM webpage can be used without an
Internet connection also.

This project is written in Python and it uses [Transcrypt](https://www.transcrypt.org/) to
compile the Python sources into JavaScript.

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


## Installation

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

### Installation steps

 1. Create an own directory and add a `__javascript__` subdirectory
 2. Open https://www.carstengrohmann.de/oom/ in a browser 
 3. Browse down to the paragraph "Local Installation" at the end of the document
 4. Download the HTML file to the main directory and the javascript file to the 
 `__javascript__` subdirectory
 5. Open the file `OOMAnalyser.html` in your favourite browser.

 
## Building OOMAnalyser

### Requirements

 * [Python](http://www.python.org) 3.6 or later
 * [Transcrypt](https://www.transcrypt.org/) 3.6.101


### Prepare the build environment

 * Clone the repository:
 ```
# git clone https://github.com/CarstenGrohmann/OOMAnalyser
 ```

 * Setup 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

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.


## Resources

 * [Transcrypt](https://www.transcrypt.org/)
 * [Linux man pages online](https://man7.org/)
 * [Decoding the Linux kernel's page allocation failure messages](https://utcc.utoronto.ca/~cks/space/blog/linux/DecodingPageAllocFailures)
 * [Linux Kernel OOM Log Analysis](http://elearningmedium.com/linux-kernel-oom-log-analysis/)


## Known Bugs/Issues

Check the project [issue tracker](https://github.com/CarstenGrohmann/OOMAnalyser/issues)
for current open bugs. New bugs can be reported there also.


## License

This project is licensed under the MIT license.

```
Copyright (c) 2017-2019 Carsten Grohmann,  mail <add at here> carsten-grohmann.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