summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/mongo/db/process_health/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/mongo/db/process_health/README.md b/src/mongo/db/process_health/README.md
new file mode 100644
index 00000000000..db7367b8ae1
--- /dev/null
+++ b/src/mongo/db/process_health/README.md
@@ -0,0 +1,13 @@
+# Process Health Checking Library
+
+This module is capable to run server health checks and crash an unhealthy server.
+
+*Note:* in 4.4 release only the mongos proxy server is supported
+
+## Health Observers
+
+*Health Observers* are designed for every particular check to run. Each observer can be configured to be on/off and critical or not to be able to crash the serer on error. Each observer has a configurable interval of how often it will run the checks.
+
+
+
+