Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mnutt/memory-monitor


https://github.com/mnutt/memory-monitor

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
# memory-monitor



## Motivation



When monitoring applications that might use _all_ your memory, your memory monitor may end up unable to kill

the process if the monitor itself requires memory allocations to do so. `memory-monitor` does no memory allocations

after startup.



`memory-monitor` is intended to be used as a companion process for a service running under systemd. systemd has

the ability to set memory limits on a service, but it only results in `oomkiller` sending a `SIGKILL`. With

`memory-monitor`, you can notice that your process is using too much memory and ask it to gracefully restart. If

the process receives the signal but doesn't stop, `memory-monitor` will continue periodically sending the signal

but will not take further action. Use systemd to hard-kill unresponsive processes.



## Requirements



MacOS or Linux. Rust 1.74+ for building from source.



## Usage



This tool monitors a process or processes by prefix, checking its memory usage at regular intervals. If the memory

usage exceeds a defined threshold, the tool sends a specified signal to the process.



### Command-Line Arguments



```bash

memory-monitor [OPTIONS] 

```



### Arguments



- **name**: The name of the process(es) to monitor. **This is a required argument.**



### Options



- **`-m, --max-memory `**: The maximum memory usage threshold in MB. If the process exceeds this memory usage, the specified signal will be sent. **This is a required option.**

- **`-i, --interval `**: The polling interval in seconds. This defines how frequently the tool checks the memory usage of the process. The default value is `2` seconds.

- **`-s, --signal `**: The signal to send to the process when the memory threshold is exceeded. The default value is `SIGTERM`.



### Examples



Monitor a process named `example-process` with a memory limit of 500 MB, checking every 3 seconds, and sending

`SIGUSR1` if the threshold is exceeded:



```bash

memory-monitor -m 500 -i 3 -s SIGUSR1 example-process

```



Monitor a process named `my-app` with a memory limit of 100 MB, using the default interval and signal:



```bash

memory-monitor -m 100 my-app

```



## Debugging Memory Allocations



You'll first need to codesign your binary with the right entitlements:



```

$ codesign -s - -v -f --entitlements debug.plist ./target/debug/memory-monitor

```



Then, create a trace:



```

$ xctrace record --template Allocations --launch -- ./target/debug/memory-monitor --max-memory 100 tyson_api

```



Then open the trace with Instruments.app:



```

$ open Launch*

```



## License



Copyright 2024 Michael Nutt



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.