From cb3d2fd6c3269817de84f77c59415e12bdfb06f9 Mon Sep 17 00:00:00 2001
From: Zaiming Shi <zmstone@gmail.com>
Date: Thu, 28 Oct 2021 21:08:07 +0200
Subject: [PATCH] chore: refine -heart option document

---
 etc/emqx.conf | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/etc/emqx.conf b/etc/emqx.conf
index 6043dc361..152f28215 100644
--- a/etc/emqx.conf
+++ b/etc/emqx.conf
@@ -199,6 +199,16 @@ node.data_dir = {{ platform_data_dir }}
 ## Heartbeat monitoring of an Erlang runtime system. Comment the line to disable
 ## heartbeat, or set the value as 'on'
 ##
+## Turning this on may cause the node to restart if it becomes unresponsive to
+## the heartbeat pings.
+##
+## NOTE: When managed by systemd (or other supervision tools like systemd),
+##       heart will probably only cause EMQ X to stop, but restart or not will
+##       depend on systemd's restart strategy.
+## NOTE: When running in docker, the container will die as soon as the the
+##       heart process kills EMQ X, but restart or not will depend on container
+##       supervision strategy, such as k8s restartPolicy.
+##
 ## Value: on
 ##
 ## vm.args: -heart