From 43c3fca48657172be97aca59db4a48720161451c Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Fri, 22 Dec 2023 14:03:14 +0100
Subject: [PATCH] add docs for check_proc_mem

---
 docs/20_Checks/_index.md         |  2 +-
 docs/20_Checks/check_proc_mem.md | 72 ++++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+), 1 deletion(-)
 create mode 100644 docs/20_Checks/check_proc_mem.md

diff --git a/docs/20_Checks/_index.md b/docs/20_Checks/_index.md
index c086de8..fb67665 100644
--- a/docs/20_Checks/_index.md
+++ b/docs/20_Checks/_index.md
@@ -37,7 +37,7 @@ There is one include script used by all checks:
 * [check_opencpu](check_opencpu.md)
 * [check_packages2install](check_packages2install.md)
 * [check_php-fpm-status](check_php-fpm-status.md)
-* check_proc_mem
+* [check_proc_mem](check_proc_mem.md)
 * check_proc_ressources
 * check_proc_zombie
 * [check_psqlserver](check_psqlserver.md)
diff --git a/docs/20_Checks/check_proc_mem.md b/docs/20_Checks/check_proc_mem.md
new file mode 100644
index 0000000..57623cc
--- /dev/null
+++ b/docs/20_Checks/check_proc_mem.md
@@ -0,0 +1,72 @@
+# Check memory consuming processes
+
+## Introduction
+
+Show processes that consume the most memory.
+You get a list with process name, total usage of all its processes, count of instances.
+
+## Requirements
+
+Nothing special.
+
+## Syntax
+
+```txt
+______________________________________________________________________
+
+CHECK_PROC_MEM
+v1.3
+
+(c) Institute for Medical Education - University of Bern
+Licence: GNU GPL 3
+
+https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_proc_mem.html
+______________________________________________________________________
+
+Show processes that consume the most memory.
+You get a list with processes consuming 
+
+  * more than the critical limit
+  * between warning and critical limit
+
+SYNTAX:
+
+  check_proc_mem [-h] [-c VALUE] [-w VALUE]
+
+OPTIONS:
+
+  -h, --help 
+      this help
+
+PARAMETERS:
+
+  -c, --critical VALUE
+      critical level in MB (default: 500)
+
+  -w. --warning VALUE
+      warning level in MB (default: 100)
+
+EXAMPLE:
+
+  check_proc_mem
+      Check processes with initial memory values
+
+  check_proc_mem -w 1000 -c 2000
+      Check processes consuming more than 1000 MB and mark those as critical
+      that use more than 2000 MB.
+
+```
+
+## Examples
+
+### Default options
+
+`./check_proc_mem` returns
+
+```txt
+CRITICAL: Memory consuming processes - 3 processes use 500 MB+ (critical) ... 1 processes use 100..500 MB
+Critical  mariadbd               2250 MB    1   2250.473 MB
+Critical  apache2                 861 MB   12     71.748 MB
+Critical  php-fpm8.2              645 MB   37     17.444 MB
+Warning   icinga2                 271 MB    3     90.365 MB
+```
-- 
GitLab