Differences

This shows you the differences between two versions of the page.

--- technical:whitepaper:automated_devshm_cleanup [2018-12-12 15:50] – created frey
+++ technical:whitepaper:automated_devshm_cleanup [2018-12-13 13:02] (current) – [Implementation] frey
@@ Line 62: / Line 62: @@
 The ''lsof'' utility must be present on a system for the procedure outlined above to work.  We implemented the procedure in Python and have a cron job executing the program on a fixed period.  The Python script is part of our [[https://github.com/jtfrey/ud_slurm_addons|Slurm additions project on Github]] (see the ''helpers'' directory).
+The program has various command line options available:
+<code bash>
+$ shm-cleanup.py --help
+usage: shm-cleanup.py [-h] [-v] [-q] [-n] [--show-log-timestamps]
+                      [--age <age-threshold>] [--no-special-treatment]
+                      [--log-file <filename>] [--daemon]
+                      [--daemon-period <period>] [--pid-file <filename>]
+Cleanup /dev/shm
+optional arguments:
+  -h, --help            show this help message and exit
+  -v, --verbose         increase level of verbosity
+  -q, --quiet           decrease level of verbosity
+  -n, --dry-run         do not remove any files, just display what would be
+                        done; this option sets the base verbosity level to
+                        INFO (as in -vv)
+  --show-log-timestamps, -t
+                        display timestamps on all messages logged by this
+                        program
+  --age <age-threshold>, -a <age-threshold>
+                        only items older than this will be removed; integer or
+                        floating-point values are acceptable with optional
+                        unit of s/m/h/d (default: d)
+  --no-special-treatment
+                        do not treat PSM2 and vader segment files any
+                        differently than other files
+  --log-file <filename>, -l <filename>
+                        send all logging to this file instead of to stderr;
+                        timestamps are always enabled when logging to a file
+  --daemon              run as a daemon, periodically waking to re-check
+  --daemon-period <period>
+                        wake to re-check on the given period; integer or
+                        floating-point values are acceptable with optional
+                        unit of s/m/h/d (default: s)
+  --pid-file <filename>
+                        in daemon mode, write our pid to this file (default:
+                        /var/run/shm-cleanup.pid)
+</code>
+On systems that lack cron (or a similar timed-execution mechanism), the ''--daemon'' mode may be helpful.