summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Klishin <mklishin@pivotal.io>2020-06-05 00:59:14 +0300
committerGitHub <noreply@github.com>2020-06-05 00:59:14 +0300
commit9632c28e977c9e9c576d96fb692a8b2c5af9c44b (patch)
treeb6c8eaa022b446f68177c3af4ede5a71d7e34cf5
parent58fb774f8ad9ba119f2dab097753014a478d5029 (diff)
parentde80a953a260dfd75d91bd5083d59584e6456b78 (diff)
downloadrabbitmq-server-git-9632c28e977c9e9c576d96fb692a8b2c5af9c44b.tar.gz
Merge pull request #2366 from rabbitmq/rabbitmq-cli-426
Deprecate 'ctl node_health_check'
-rw-r--r--docs/rabbitmqctl.86
-rw-r--r--src/rabbit_health_check.erl2
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/rabbitmqctl.8 b/docs/rabbitmqctl.8
index b98e871f9e..f524e3e084 100644
--- a/docs/rabbitmqctl.8
+++ b/docs/rabbitmqctl.8
@@ -1440,9 +1440,11 @@ is located on the current node.
.\" ------------------------------------------------------------------
.It Cm node_health_check
.Pp
-Performs several health checks of the target node.
+DEPRECATED. Performs intrusive, opinionated health checks on a fully booted node.
+To learn more, see the
+.Lk https://www.rabbitmq.com/monitoring.html#health-checks "Health Checks documentation"
.Pp
-Verifies the rabbit application is running and alarms are not set,
+Verifies the RabbitMQ application is running and alarms are not set,
then checks that every queue and channel on the node can emit basic stats.
.sp
Example:
diff --git a/src/rabbit_health_check.erl b/src/rabbit_health_check.erl
index d384354dc8..f41c1e6e1b 100644
--- a/src/rabbit_health_check.erl
+++ b/src/rabbit_health_check.erl
@@ -36,6 +36,8 @@ node(Node, Timeout) ->
-spec local() -> ok | {error_string, string()}.
local() ->
+ rabbit_log:warning("rabbitmqctl node_health_check and its HTTP API counterpart are DEPRECATED. "
+ "See https://www.rabbitmq.com/monitoring.html#health-checks for replacement options."),
run_checks([list_channels, list_queues, alarms, rabbit_node_monitor]).
%%----------------------------------------------------------------------------