emqx 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311
  1. #!/usr/bin/env bash
  2. # -*- tab-width:4;indent-tabs-mode:nil -*-
  3. # ex: ts=4 sw=4 et
  4. set -euo pipefail
  5. DEBUG="${DEBUG:-0}"
  6. if [ "$DEBUG" -eq 1 ]; then
  7. set -x
  8. fi
  9. if [ "$DEBUG" -eq 2 ]; then
  10. set -x
  11. export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
  12. fi
  13. # We need to find real directory with emqx files on all platforms
  14. # even when bin/emqx is symlinked on several levels
  15. # - readlink -f works perfectly, but `-f` flag has completely different meaning in BSD version,
  16. # so we can't use it universally.
  17. # - `stat -f%R` on MacOS does exactly what `readlink -f` does on Linux, but we can't use it
  18. # as a universal solution either because GNU stat has different syntax and this argument is invalid.
  19. # Also, version of stat which supports this syntax is only available since MacOS 12
  20. if [ "$(uname -s)" == 'Darwin' ]; then
  21. product_version="$(sw_vers -productVersion | cut -d '.' -f 1)"
  22. if [ "$product_version" -ge 12 ]; then
  23. # if homebrew coreutils package is installed, GNU version of stat can take precedence,
  24. # so we use absolute path to ensure we are calling MacOS default
  25. RUNNER_ROOT_DIR="$(cd "$(dirname "$(/usr/bin/stat -f%R "$0" || echo "$0")")"/..; pwd -P)"
  26. else
  27. # try our best to resolve link on MacOS <= 11
  28. RUNNER_ROOT_DIR="$(cd "$(dirname "$(readlink "$0" || echo "$0")")"/..; pwd -P)"
  29. fi
  30. else
  31. RUNNER_ROOT_DIR="$(cd "$(dirname "$(realpath "$0" || echo "$0")")"/..; pwd -P)"
  32. fi
  33. # shellcheck disable=SC1090,SC1091
  34. . "$RUNNER_ROOT_DIR"/releases/emqx_vars
  35. # defined in emqx_vars
  36. export RUNNER_ROOT_DIR
  37. export EMQX_ETC_DIR
  38. export REL_VSN
  39. export SCHEMA_MOD
  40. export IS_ENTERPRISE
  41. RUNNER_SCRIPT="$RUNNER_BIN_DIR/$REL_NAME"
  42. CODE_LOADING_MODE="${CODE_LOADING_MODE:-embedded}"
  43. REL_DIR="$RUNNER_ROOT_DIR/releases/$REL_VSN"
  44. WHOAMI=$(whoami)
  45. # hocon try to read environment variables starting with "EMQX_"
  46. export HOCON_ENV_OVERRIDE_PREFIX='EMQX_'
  47. export ERTS_DIR="$RUNNER_ROOT_DIR/erts-$ERTS_VSN"
  48. export BINDIR="$ERTS_DIR/bin"
  49. export EMU="beam"
  50. export PROGNAME="erl"
  51. export ERTS_LIB_DIR="$RUNNER_ROOT_DIR/lib"
  52. DYNLIBS_DIR="$RUNNER_ROOT_DIR/dynlibs"
  53. logerr() {
  54. if [ "${TERM:-dumb}" = dumb ]; then
  55. echo -e "ERROR: $*" 1>&2
  56. else
  57. echo -e "$(tput setaf 1)ERROR: $*$(tput sgr0)" 1>&2
  58. fi
  59. }
  60. logwarn() {
  61. if [ "${TERM:-dumb}" = dumb ]; then
  62. echo "WARNING: $*"
  63. else
  64. echo "$(tput setaf 3)WARNING: $*$(tput sgr0)"
  65. fi
  66. }
  67. logdebug() {
  68. if [ "$DEBUG" -eq 1 ]; then
  69. echo "DEBUG: $*"
  70. fi
  71. }
  72. die() {
  73. set +x
  74. logerr "$1"
  75. errno=${2:-1}
  76. exit "$errno"
  77. }
  78. assert_node_alive() {
  79. if ! relx_nodetool "ping" > /dev/null; then
  80. exit 1
  81. fi
  82. }
  83. usage() {
  84. local command="$1"
  85. case "$command" in
  86. start)
  87. echo "Start EMQX service in daemon mode"
  88. ;;
  89. stop)
  90. echo "Stop the running EMQX program"
  91. ;;
  92. console)
  93. echo "Boot up EMQX service in an interactive Erlang or Elixir shell"
  94. echo "This command needs a tty"
  95. ;;
  96. console_clean)
  97. echo "This command does NOT boot up the EMQX service"
  98. echo "It only starts an interactive Erlang or Elixir console with all the"
  99. echo "EMQX code available"
  100. ;;
  101. foreground)
  102. echo "Start EMQX in foreground mode without an interactive shell"
  103. ;;
  104. pid)
  105. echo "Print out EMQX process identifier"
  106. ;;
  107. ping)
  108. echo "Check if the EMQX node is up and running"
  109. echo "This command exit with 0 silently if node is running"
  110. ;;
  111. escript)
  112. echo "Execute a escript using the Erlang runtime from EMQX package installation"
  113. echo "For example $REL_NAME escript /path/to/my/escript my_arg1 my_arg2"
  114. ;;
  115. attach)
  116. echo "This command is applicable when EMQX is started in daemon mode."
  117. echo "It attaches the current shell to EMQX's control console"
  118. echo "through a named pipe."
  119. logwarn "try to use the safer alternative, remote_console command."
  120. ;;
  121. remote_console)
  122. echo "Start an interactive shell running an Erlang or Elixir node which "
  123. echo "hidden-connects to the running EMQX node".
  124. echo "This command is mostly used for troubleshooting."
  125. ;;
  126. ertspath)
  127. echo "Print path to Erlang runtime bin dir"
  128. ;;
  129. rpc)
  130. echo "Usage: $REL_NAME rpc MODULE FUNCTION [ARGS, ...]"
  131. echo "Connect to the EMQX node and make an Erlang RPC"
  132. echo "This command blocks for at most 60 seconds."
  133. echo "It exits with non-zero code in case of any RPC failure"
  134. echo "including connection error and runtime exception"
  135. ;;
  136. rpcterms)
  137. echo "Usage: $REL_NAME rpcterms MODULE FUNCTION [ARGS, ...]"
  138. echo "Connect to the EMQX node and make an Erlang RPC"
  139. echo "The result of the RPC call is pretty-printed as an "
  140. echo "Erlang term"
  141. ;;
  142. root_dir)
  143. echo "Print EMQX installation root dir"
  144. ;;
  145. eval)
  146. echo "Evaluate an Erlang expression in the EMQX node."
  147. ;;
  148. eval-ex)
  149. echo "Evaluate an Elixir expression in the EMQX node. Only applies to Elixir node"
  150. ;;
  151. versions)
  152. echo "List installed EMQX release versions and their status"
  153. ;;
  154. unpack)
  155. echo "Usage: $REL_NAME unpack [VERSION]"
  156. echo "Unpacks a release package VERSION, it assumes that this"
  157. echo "release package tarball has already been deployed at one"
  158. echo "of the following locations:"
  159. echo " releases/<relname>-<version>.tar.gz"
  160. ;;
  161. install)
  162. echo "Usage: $REL_NAME install [VERSION]"
  163. echo "Installs a release package VERSION, it assumes that this"
  164. echo "release package tarball has already been deployed at one"
  165. echo "of the following locations:"
  166. echo " releases/<relname>-<version>.tar.gz"
  167. echo ""
  168. echo " --no-permanent Install release package VERSION but"
  169. echo " don't make it permanent"
  170. ;;
  171. uninstall)
  172. echo "Usage: $REL_NAME uninstall [VERSION]"
  173. echo "Uninstalls a release VERSION, it will only accept"
  174. echo "versions that are not currently in use"
  175. ;;
  176. upgrade)
  177. echo "Usage: $REL_NAME upgrade [VERSION]"
  178. echo "Upgrades the currently running release to VERSION, it assumes"
  179. echo "that a release package tarball has already been deployed at one"
  180. echo "of the following locations:"
  181. echo " releases/<relname>-<version>.tar.gz"
  182. echo ""
  183. echo " --no-permanent Install release package VERSION but"
  184. echo " don't make it permanent"
  185. ;;
  186. downgrade)
  187. echo "Usage: $REL_NAME downgrade [VERSION]"
  188. echo "Downgrades the currently running release to VERSION, it assumes"
  189. echo "that a release package tarball has already been deployed at one"
  190. echo "of the following locations:"
  191. echo " releases/<relname>-<version>.tar.gz"
  192. echo ""
  193. echo " --no-permanent Install release package VERSION but"
  194. echo " don't make it permanent"
  195. ;;
  196. check_config)
  197. echo "Checks the EMQX config without generating any files"
  198. ;;
  199. *)
  200. echo "Usage: $REL_NAME COMMAND [help]"
  201. echo ''
  202. echo "Commonly used COMMANDs:"
  203. echo " start: Start EMQX in daemon mode"
  204. echo " console: Start EMQX in an interactive Erlang or Elixir shell"
  205. echo " foreground: Start EMQX in foreground mode without an interactive shell"
  206. echo " stop: Stop the running EMQX node"
  207. echo " ctl: Administration commands, execute '$REL_NAME ctl help' for more details"
  208. echo ''
  209. echo "More:"
  210. echo " Shell attach: remote_console | attach"
  211. # echo " Up/Down-grade: upgrade | downgrade | install | uninstall | versions" # TODO enable when supported
  212. echo " Install Info: ertspath | root_dir"
  213. echo " Runtime Status: pid | ping"
  214. echo " Validate Config: check_config"
  215. echo " Advanced: console_clean | escript | rpc | rpcterms | eval | eval-ex"
  216. echo ''
  217. echo "Execute '$REL_NAME COMMAND help' for more information"
  218. ;;
  219. esac
  220. }
  221. COMMAND="${1:-}"
  222. GREP='grep --color=never'
  223. if [ -z "$COMMAND" ]; then
  224. usage 'help'
  225. exit 1
  226. elif [ "$COMMAND" = 'help' ]; then
  227. usage 'help'
  228. exit 0
  229. fi
  230. if [ "${2:-}" = 'help' ]; then
  231. ## 'ctl' command has its own usage info
  232. if [ "$COMMAND" != 'ctl' ]; then
  233. usage "$COMMAND"
  234. exit 0
  235. fi
  236. fi
  237. ## IS_BOOT_COMMAND is set for later to inspect node name and cookie from hocon config (or env variable)
  238. case "${COMMAND}" in
  239. start|console|console_clean|foreground|check_config)
  240. IS_BOOT_COMMAND='yes'
  241. ;;
  242. ertspath)
  243. echo "$ERTS_DIR"
  244. exit 0
  245. ;;
  246. root_dir)
  247. echo "$RUNNER_ROOT_DIR"
  248. exit 0
  249. ;;
  250. *)
  251. IS_BOOT_COMMAND='no'
  252. ;;
  253. esac
  254. ## backward compatible
  255. if [ -d "$ERTS_DIR/lib" ]; then
  256. export LD_LIBRARY_PATH="$ERTS_DIR/lib:$LD_LIBRARY_PATH"
  257. fi
  258. # Simple way to check the correct user and fail early
  259. check_user() {
  260. # Validate that the user running the script is the owner of the
  261. # RUN_DIR.
  262. if [ "$RUNNER_USER" ] && [ "x$WHOAMI" != "x$RUNNER_USER" ]; then
  263. if [ "x$WHOAMI" != "xroot" ]; then
  264. echo "You need to be root or use sudo to run this command"
  265. exit 1
  266. fi
  267. CMD="DEBUG=$DEBUG \"$RUNNER_SCRIPT\" "
  268. for ARG in "$@"; do
  269. CMD="${CMD} \"$ARG\""
  270. done
  271. # This will drop privileges into the runner user
  272. # It exec's in a new shell and the current shell will exit
  273. exec su - "$RUNNER_USER" -c "$CMD"
  274. fi
  275. }
  276. # Make sure the user running this script is the owner and/or su to that user
  277. check_user "$@"
  278. ES=$?
  279. if [ "$ES" -ne 0 ]; then
  280. exit $ES
  281. fi
  282. # Make sure log directory exists
  283. mkdir -p "$EMQX_LOG_DIR"
  284. # turn off debug as this is static
  285. set +x
  286. COMPATIBILITY_CHECK='
  287. io:format("BEAM_OK~n", []),
  288. try
  289. [_|_] = L = crypto:info_lib(),
  290. io:format("CRYPTO_OK ~0p~n", [L])
  291. catch
  292. _ : _ ->
  293. %% so logger has the chance to log something
  294. timer:sleep(100),
  295. halt(1)
  296. end,
  297. try
  298. mnesia_hook:module_info(),
  299. io:format("MNESIA_OK~n", [])
  300. catch
  301. _ : _ ->
  302. io:format("WARNING: Mnesia app has no post-coommit hook support~n", []),
  303. halt(2)
  304. end,
  305. halt(0).
  306. '
  307. [ "$DEBUG" -eq 1 ] && set -x
  308. compatiblity_info() {
  309. # RELEASE_LIB is used by Elixir
  310. # set crash-dump bytes to zero to ensure no crash dump is generated when erl crashes
  311. env ERL_CRASH_DUMP_BYTES=0 "$BINDIR/$PROGNAME" \
  312. -noshell \
  313. -boot "$REL_DIR/start_clean" \
  314. -boot_var RELEASE_LIB "$ERTS_LIB_DIR/lib" \
  315. -eval "$COMPATIBILITY_CHECK"
  316. }
  317. # Collect Erlang/OTP runtime sanity and compatibility in one go
  318. maybe_use_portable_dynlibs() {
  319. # Read BUILD_INFO early as the next commands may mess up the shell
  320. BUILD_INFO="$(cat "${REL_DIR}/BUILD_INFO")"
  321. COMPATIBILITY_INFO="$(compatiblity_info 2>/dev/null || true)"
  322. if ! (echo -e "$COMPATIBILITY_INFO" | $GREP -q 'CRYPTO_OK'); then
  323. ## failed to start, might be due to missing libs, try to be portable
  324. export LD_LIBRARY_PATH="${LD_LIBRARY_PATH:-$DYNLIBS_DIR}"
  325. if [ "$LD_LIBRARY_PATH" != "$DYNLIBS_DIR" ]; then
  326. export LD_LIBRARY_PATH="$DYNLIBS_DIR:$LD_LIBRARY_PATH"
  327. fi
  328. ## Turn off debug, because COMPATIBILITY_INFO needs to capture stderr
  329. COMPATIBILITY_INFO="$(compatiblity_info 2>&1 || true)"
  330. if ! (echo -e "$COMPATIBILITY_INFO" | $GREP -q 'BEAM_OK'); then
  331. ## not able to start beam.smp
  332. logerr "$COMPATIBILITY_INFO"
  333. logerr "Please ensure it is running on the correct platform:"
  334. logerr "$BUILD_INFO"
  335. logerr "Version=$REL_VSN"
  336. logerr "Required dependencies: openssl-1.1.1 (libcrypto), libncurses and libatomic1"
  337. exit 1
  338. elif ! (echo -e "$COMPATIBILITY_INFO" | $GREP -q 'CRYPTO_OK'); then
  339. ## not able to start crypto app
  340. logerr "$COMPATIBILITY_INFO"
  341. exit 2
  342. fi
  343. logwarn "Using libs from '${DYNLIBS_DIR}' due to missing from the OS."
  344. fi
  345. }
  346. SED_REPLACE="sed -i "
  347. case $(sed --help 2>&1) in
  348. *GNU*) SED_REPLACE="sed -i ";;
  349. *BusyBox*) SED_REPLACE="sed -i ";;
  350. *) SED_REPLACE="sed -i '' ";;
  351. esac
  352. # Get node pid
  353. relx_get_pid() {
  354. if output="$(relx_nodetool rpcterms os getpid)"
  355. then
  356. # shellcheck disable=SC2001 # Escaped quote taken as closing quote in editor
  357. echo "$output" | sed -e 's/"//g'
  358. return 0
  359. else
  360. echo "$output"
  361. return 1
  362. fi
  363. }
  364. # Connect to a remote node
  365. remsh() {
  366. # Generate a unique id used to allow multiple remsh to the same node
  367. # transparently
  368. id="remsh$(gen_node_id)-${NAME}"
  369. # shellcheck disable=SC2086
  370. # Setup remote shell command to control node
  371. if [ "$IS_ELIXIR" = no ] || [ "${EMQX_CONSOLE_FLAVOR:-}" = 'erl' ] ; then
  372. set -- "$BINDIR/erl" "$NAME_TYPE" "$id" \
  373. -remsh "$NAME" -boot "$REL_DIR/start_clean" \
  374. -boot_var ERTS_LIB_DIR "$ERTS_LIB_DIR" \
  375. -boot_var RELEASE_LIB "$ERTS_LIB_DIR" \
  376. -setcookie "$COOKIE" \
  377. -hidden \
  378. -kernel net_ticktime "$TICKTIME" \
  379. $EPMD_ARGS
  380. else
  381. set -- "$REL_DIR/iex" \
  382. --remsh "$NAME" \
  383. --boot-var RELEASE_LIB "$ERTS_LIB_DIR" \
  384. --cookie "$COOKIE" \
  385. --hidden \
  386. --erl "-kernel net_ticktime $TICKTIME" \
  387. --erl "$EPMD_ARGS" \
  388. --erl "$NAME_TYPE $id" \
  389. --boot "$REL_DIR/start_clean"
  390. fi
  391. exec "$@"
  392. }
  393. # Generate a random id
  394. gen_node_id() {
  395. od -t u -N 4 /dev/urandom | head -n1 | awk '{print $2 % 1000}'
  396. }
  397. call_nodetool() {
  398. "$ERTS_DIR/bin/escript" "$RUNNER_ROOT_DIR/bin/nodetool" "$@"
  399. }
  400. # Control a node
  401. relx_nodetool() {
  402. command="$1"; shift
  403. ERL_FLAGS="${ERL_FLAGS:-} $EPMD_ARGS -setcookie $COOKIE" \
  404. call_nodetool "$NAME_TYPE" "$NAME" "$command" "$@"
  405. }
  406. call_hocon() {
  407. call_nodetool hocon "$@" \
  408. || die "call_hocon_failed: $*" $?
  409. }
  410. find_emqx_process() {
  411. ## Find the running node from 'ps -ef'
  412. ## * The grep args like '[e]mqx' but not 'emqx' is to avoid greping the grep command itself
  413. ## * The running 'remsh' and 'nodetool' processes must be excluded
  414. if [ -n "${EMQX_NODE__NAME:-}" ]; then
  415. # if node name is provided, filter by node name
  416. # shellcheck disable=SC2009
  417. ps -ef | $GREP '[e]mqx' | $GREP -v -E '(remsh|nodetool)' | $GREP -E "\s-s?name\s${EMQX_NODE__NAME}" | $GREP -oE "\-[r]oot ${RUNNER_ROOT_DIR}.*" || true
  418. else
  419. # shellcheck disable=SC2009
  420. ps -ef | $GREP '[e]mqx' | $GREP -v -E '(remsh|nodetool)' | $GREP -oE "\-[r]oot ${RUNNER_ROOT_DIR}.*" || true
  421. fi
  422. }
  423. ## Resolve boot configs in a batch
  424. ## This is because starting the Erlang beam with all modules loaded
  425. ## and parsing HOCON config + environment variables is a non-trivial task
  426. CONF_KEYS=( 'node.data_dir' 'node.name' 'node.cookie' 'node.db_backend' 'cluster.proto_dist' 'node.dist_net_ticktime' )
  427. if [ "$IS_ENTERPRISE" = 'yes' ]; then
  428. CONF_KEYS+=( 'license.key' )
  429. fi
  430. ## To be backward compatible, read and then unset EMQX_NODE_NAME
  431. if [ -n "${EMQX_NODE_NAME:-}" ]; then
  432. export EMQX_NODE__NAME="${EMQX_NODE_NAME}"
  433. unset EMQX_NODE_NAME
  434. fi
  435. # Turn off debug as the ps output can be quite noisy
  436. set +x
  437. PS_LINE="$(find_emqx_process)"
  438. logdebug "PS_LINE=$PS_LINE"
  439. RUNNING_NODES_COUNT="$(echo -e "$PS_LINE" | sed '/^\s*$/d' | wc -l)"
  440. [ "$RUNNING_NODES_COUNT" -gt 1 ] && logdebug "More than one running node found: count=$RUNNING_NODES_COUNT"
  441. if [ "$IS_BOOT_COMMAND" = 'yes' ]; then
  442. if [ "$RUNNING_NODES_COUNT" -gt 0 ] && [ "$COMMAND" != 'check_config' ]; then
  443. running_node_name=$(echo -e "$PS_LINE" | $GREP -oE "\s-s?name.*" | awk '{print $2}' || true)
  444. if [ -n "$running_node_name" ] && [ "$running_node_name" = "${EMQX_NODE__NAME:-}" ]; then
  445. echo "Node ${running_node_name} is already running!"
  446. exit 1
  447. fi
  448. fi
  449. [ -f "$EMQX_ETC_DIR"/emqx.conf ] || die "emqx.conf is not found in $EMQX_ETC_DIR" 1
  450. maybe_use_portable_dynlibs
  451. if [ "${EMQX_BOOT_CONFIGS:-}" = '' ]; then
  452. EMQX_BOOT_CONFIGS="$(call_hocon -s "$SCHEMA_MOD" -c "$EMQX_ETC_DIR"/emqx.conf multi_get "${CONF_KEYS[@]}")"
  453. ## export here so the 'console' command recursively called from
  454. ## 'start' command does not have to parse the configs again
  455. export EMQX_BOOT_CONFIGS
  456. fi
  457. else
  458. # For non-boot commands, we need below runtime facts to connect to the running node:
  459. # 1. The running node name;
  460. # 2. The Erlang cookie in use by the running node name;
  461. # 3. SSL options if the node is using TLS for Erlang distribution;
  462. # 4. Erlang kernel application's net_ticktime config.
  463. #
  464. # There are 3 sources of truth to get those runtime information.
  465. # Listed in the order of preference:
  466. # 1. The boot command (which can be inspected from 'ps -ef' command output)
  467. # 2. The generated vm.<time>.config file located in the dir pointed by 'node.data_dir'
  468. # 3. The bootstrap config 'etc/emqx.conf'
  469. #
  470. # If failed to read from source 1, the information is retrieved from source 3
  471. # i.e. source 2 is never used.
  472. #
  473. # NOTES:
  474. # * We should avoid getting runtime information with the 3rd approach because 'etc/emqx.conf' might
  475. # be updated after the node is started. e.g. If a user starts the node with name 'emqx@127.0.0.1'
  476. # then update the config in the file to 'node.name = "emqx@local.net"', after this change,
  477. # there would be no way stop the running node 'emqx@127.0.0.1', because 'emqx stop' command
  478. # would try to stop the new node instead.
  479. if [ "$RUNNING_NODES_COUNT" -eq 1 ]; then
  480. ## only one emqx node is running, get running args from 'ps -ef' output
  481. tmp_nodename=$(echo -e "$PS_LINE" | $GREP -oE "\s-s?name.*" | awk '{print $2}' || true)
  482. tmp_cookie=$(echo -e "$PS_LINE" | $GREP -oE "\s-setcookie.*" | awk '{print $2}' || true)
  483. tmp_proto_dist=$(echo -e "$PS_LINE" | $GREP -oE '\s-ekka_proto_dist.*' | awk '{print $2}' || echo 'inet_tcp')
  484. SSL_DIST_OPTFILE="$(echo -e "$PS_LINE" | $GREP -oE '\-ssl_dist_optfile\s.+\s' | awk '{print $2}' || true)"
  485. tmp_ticktime="$(echo -e "$PS_LINE" | $GREP -oE '\s-kernel\snet_ticktime\s.+\s' | awk '{print $3}' || true)"
  486. # data_dir is actually not needed, but kept anyway
  487. tmp_datadir="$(echo -e "$PS_LINE" | $GREP -oE "\-emqx_data_dir.*" | sed -E 's#.+emqx_data_dir[[:blank:]]##g' | sed -E 's#[[:blank:]]--$##g' || true)"
  488. ## Make the format like what call_hocon multi_get prints out, but only need 4 args
  489. EMQX_BOOT_CONFIGS="node.name=${tmp_nodename}\nnode.cookie=${tmp_cookie}\ncluster.proto_dist=${tmp_proto_dist}\nnode.dist_net_ticktime=$tmp_ticktime\nnode.data_dir=${tmp_datadir}"
  490. else
  491. if [ "$RUNNING_NODES_COUNT" -gt 1 ]; then
  492. if [ -z "${EMQX_NODE__NAME:-}" ]; then
  493. tmp_nodenames=$(echo -e "$PS_LINE" | $GREP -oE "\s-s?name.*" | awk '{print $2}' | tr '\n' ' ')
  494. logerr "More than one EMQX node found running (root dir: ${RUNNER_ROOT_DIR})"
  495. logerr "Running nodes: $tmp_nodenames"
  496. logerr "Make sure environment variable EMQX_NODE__NAME is set to indicate for which node this command is intended."
  497. exit 1
  498. fi
  499. else
  500. if [ -n "${EMQX_NODE__NAME:-}" ]; then
  501. die "Node $EMQX_NODE__NAME is not running?"
  502. fi
  503. fi
  504. ## We have no choice but to read the bootstrap config (with environment overrides available in the current shell)
  505. [ -f "$EMQX_ETC_DIR"/emqx.conf ] || die "emqx.conf is not found in $EMQX_ETC_DIR" 1
  506. maybe_use_portable_dynlibs
  507. EMQX_BOOT_CONFIGS="$(call_hocon -s "$SCHEMA_MOD" -c "$EMQX_ETC_DIR"/emqx.conf multi_get "${CONF_KEYS[@]}")"
  508. fi
  509. fi
  510. logdebug "EMQX_BOOT_CONFIGS: $EMQX_BOOT_CONFIGS"
  511. [ "$DEBUG" -eq 1 ] && set -x
  512. get_boot_config() {
  513. path_to_value="$1"
  514. echo -e "$EMQX_BOOT_CONFIGS" | $GREP "$path_to_value=" | sed -e "s/$path_to_value=//g" | tr -d \"
  515. }
  516. EPMD_ARGS="-start_epmd false -epmd_module ekka_epmd -proto_dist ekka"
  517. PROTO_DIST="$(get_boot_config 'cluster.proto_dist' || true)"
  518. TICKTIME="$(get_boot_config 'node.dist_net_ticktime' || echo '120')"
  519. # this environment variable is required by ekka_dist module
  520. # because proto_dist is overriden to ekka, and there is a lack of ekka_tls module
  521. export EKKA_PROTO_DIST_MOD="${PROTO_DIST:-inet_tcp}"
  522. if [ "$EKKA_PROTO_DIST_MOD" = 'inet_tls' ] || [ "$EKKA_PROTO_DIST_MOD" = 'inet6_tls' ]; then
  523. if [ "$IS_BOOT_COMMAND" = 'yes' ]; then
  524. SSL_DIST_OPTFILE=${EMQX_SSL_DIST_OPTFILE:-"$EMQX_ETC_DIR/ssl_dist.conf"}
  525. case "$SSL_DIST_OPTFILE" in
  526. *\ *)
  527. # there is unfortunately no way to support space for this option because we'd need to grep
  528. # from 'ps -ef' result to get this option for non-boot commands (nodetool) to run
  529. set +x
  530. logerr "Got space in: $SSL_DIST_OPTFILE"
  531. logerr "No space is allowed for Erlang distribution over SSL option file path."
  532. logerr "Configure it from environment variable EMQX_SSL_DIST_OPTFILE."
  533. logerr "Or make sure emqx root path '$RUNNER_ROOT_DIR' has no space"
  534. exit 1
  535. ;;
  536. *)
  537. true
  538. ;;
  539. esac
  540. fi
  541. EPMD_ARGS="${EPMD_ARGS} -ssl_dist_optfile $SSL_DIST_OPTFILE"
  542. fi
  543. DATA_DIR="$(get_boot_config 'node.data_dir')"
  544. # ensure no trailing /
  545. DATA_DIR="${DATA_DIR%/}"
  546. if [[ $DATA_DIR != /* ]]; then
  547. # relative path
  548. DATA_DIR="${RUNNER_ROOT_DIR}/${DATA_DIR}"
  549. fi
  550. CONFIGS_DIR="$DATA_DIR/configs"
  551. mkdir -p "$CONFIGS_DIR"
  552. check_license() {
  553. if [ "$IS_ENTERPRISE" == "no" ]; then
  554. return 0
  555. fi
  556. key_license="${EMQX_LICENSE__KEY:-$(get_boot_config 'license.key')}"
  557. if [[ -n "$key_license" && ("$key_license" != "undefined") ]]; then
  558. call_nodetool check_license_key "$key_license"
  559. else
  560. set +x
  561. logerr "License not found."
  562. logerr "Please specify one via the EMQX_LICENSE__KEY variable"
  563. logerr "or via license.key in emqx.conf."
  564. return 1
  565. fi
  566. }
  567. # When deciding which install upgrade script to run, we have to check
  568. # our own version so we may avoid infinite loops and call the correct
  569. # version.
  570. current_script_version() {
  571. curr_script=$(basename "${BASH_SOURCE[0]}")
  572. suffix=${curr_script#*-}
  573. if [[ "${suffix}" == "${curr_script}" ]]; then
  574. # there's no suffix, so we're running the default `emqx` script;
  575. # we'll have to trust the REL_VSN variable
  576. echo "$REL_VSN"
  577. else
  578. echo "${suffix}"
  579. fi
  580. }
  581. parse_semver() {
  582. echo "$1" | tr '.|-' ' '
  583. }
  584. max_version_of() {
  585. local vsn1="$1"
  586. local vsn2="$2"
  587. echo "${vsn1}" "${vsn2}" | tr " " "\n" | sort -rV | head -n1
  588. }
  589. versioned_script_path() {
  590. local script_name="$1"
  591. local vsn="$2"
  592. echo "$RUNNER_ROOT_DIR/bin/$script_name-$vsn"
  593. }
  594. does_script_version_exist() {
  595. local script_name="$1"
  596. local vsn="$2"
  597. if [[ -f "$(versioned_script_path "$script_name" "$vsn")" ]]; then
  598. return 0
  599. else
  600. return 1
  601. fi
  602. }
  603. # extract_from_package packege_path destination file1 file2
  604. extract_from_package() {
  605. local package="$1"
  606. local dest_dir="$2"
  607. shift 2
  608. tar -C "$dest_dir" -xf "$package" "$@"
  609. }
  610. am_i_the_newest_script() {
  611. local curr_vsn other_vsn
  612. curr_vsn="$(current_script_version)"
  613. other_vsn="$1"
  614. max_vsn="$(max_version_of "$other_vsn" "$curr_vsn")"
  615. if [[ "$max_vsn" == "$curr_vsn" ]]; then
  616. return 0
  617. else
  618. return 1
  619. fi
  620. }
  621. locate_package() {
  622. local package_path candidates vsn
  623. vsn="$1"
  624. if [[ "${IS_ENTERPRISE}" == "yes" ]]; then
  625. package_pattern="$RUNNER_ROOT_DIR/releases/emqx-enterprise-$vsn-*.tar.gz"
  626. else
  627. package_pattern="$RUNNER_ROOT_DIR/releases/emqx-$vsn-*.tar.gz"
  628. fi
  629. # shellcheck disable=SC2207,SC2086
  630. candidates=($(ls $package_pattern))
  631. if [[ "${#candidates[@]}" == 0 ]]; then
  632. logerr "No package matching $package_pattern found."
  633. exit 1
  634. elif [[ "${#candidates[@]}" -gt 1 ]]; then
  635. logerr "Multiple packages matching $package_pattern found. Ensure only one exists."
  636. exit 1
  637. else
  638. echo "${candidates[0]}"
  639. fi
  640. }
  641. ensure_newest_script_is_extracted() {
  642. local newest_vsn="$1"
  643. local package_path tmpdir
  644. if does_script_version_exist "emqx" "$newest_vsn" \
  645. && does_script_version_exist "install_upgrade.escript" "$newest_vsn"; then
  646. return
  647. else
  648. package_path="$(locate_package "$newest_vsn")"
  649. tmpdir="$(mktemp -dp /tmp emqx.XXXXXXXXXXX)"
  650. extract_from_package \
  651. "$package_path" \
  652. "$tmpdir" \
  653. "bin/emqx-$newest_vsn" \
  654. "bin/install_upgrade.escript-$newest_vsn"
  655. cp "$tmpdir/bin/emqx-$newest_vsn" \
  656. "$tmpdir/bin/install_upgrade.escript-$newest_vsn" \
  657. "$RUNNER_ROOT_DIR/bin/"
  658. rm -rf "$tmpdir"
  659. fi
  660. }
  661. # Run an escript in the node's environment
  662. relx_escript() {
  663. shift; scriptpath="$1"; shift
  664. "$ERTS_DIR/bin/escript" "$RUNNER_ROOT_DIR/$scriptpath" "$@"
  665. }
  666. # Output a start command for the last argument of run_erl
  667. relx_start_command() {
  668. printf "exec \"%s\" \"%s\"" "$RUNNER_SCRIPT" \
  669. "$START_OPTION"
  670. }
  671. # Function to check configs without generating them
  672. check_config() {
  673. ## this command checks the configs without generating any files
  674. call_hocon -v -s "$SCHEMA_MOD" -c "$EMQX_ETC_DIR"/emqx.conf check_schema
  675. }
  676. # Function to generate app.config and vm.args
  677. # sets two environment variables CONF_FILE and ARGS_FILE
  678. generate_config() {
  679. local name_type="$1"
  680. local node_name="$2"
  681. ## Delete the *.siz files first or it can't start after
  682. ## changing the config 'log.rotation.size'
  683. rm -f "${EMQX_LOG_DIR}"/*.siz
  684. ## timestamp for each generation
  685. local NOW_TIME
  686. NOW_TIME="$(date +'%Y.%m.%d.%H.%M.%S')"
  687. ## this command populates two files: app.<time>.config and vm.<time>.args
  688. ## NOTE: the generate command merges environment variables to the base config (emqx.conf),
  689. ## but does not include the cluster-override.conf and local-override.conf
  690. ## meaning, certain overrides will not be mapped to app.<time>.config file
  691. call_hocon -v -t "$NOW_TIME" -s "$SCHEMA_MOD" -c "$EMQX_ETC_DIR"/emqx.conf -d "$DATA_DIR"/configs generate
  692. ## filenames are per-hocon convention
  693. CONF_FILE="$CONFIGS_DIR/app.$NOW_TIME.config"
  694. ARGS_FILE="$CONFIGS_DIR/vm.$NOW_TIME.args"
  695. ## Merge hocon generated *.args into the vm.args
  696. TMP_ARG_FILE="$CONFIGS_DIR/vm.args.tmp"
  697. cp "$EMQX_ETC_DIR/vm.args" "$TMP_ARG_FILE"
  698. echo "" >> "$TMP_ARG_FILE"
  699. echo "-pa \"${REL_DIR}/consolidated\"" >> "$TMP_ARG_FILE"
  700. ## read lines from generated vm.<time>.args file
  701. ## drop comment lines, and empty lines using sed
  702. ## pipe the lines to a while loop
  703. sed '/^#/d' "$ARGS_FILE" | sed '/^$/d' | while IFS='' read -r ARG_LINE || [ -n "$ARG_LINE" ]; do
  704. ## in the loop, split the 'key[:space:]value' pair
  705. ARG_KEY=$(echo "$ARG_LINE" | awk '{$NF="";print}')
  706. ARG_VALUE=$(echo "$ARG_LINE" | awk '{print $NF}')
  707. ## use the key to look up in vm.args file for the value
  708. TMP_ARG_VALUE=$($GREP "^$ARG_KEY" "$TMP_ARG_FILE" || true | awk '{print $NF}')
  709. ## compare generated (to override) value to original (to be overridden) value
  710. if [ "$ARG_VALUE" != "$TMP_ARG_VALUE" ] ; then
  711. ## if they are different
  712. if [ -n "$TMP_ARG_VALUE" ]; then
  713. ## if the old value is present, replace it with generated value
  714. sh -c "$SED_REPLACE 's|^$ARG_KEY.*$|$ARG_LINE|' \"$TMP_ARG_FILE\""
  715. else
  716. ## otherwise append generated value to the end
  717. echo "$ARG_LINE" >> "$TMP_ARG_FILE"
  718. fi
  719. fi
  720. done
  721. echo "$name_type $node_name" >> "$TMP_ARG_FILE"
  722. echo "-mnesia dir '\"$DATA_DIR/mnesia/$NAME\"'" >> "$TMP_ARG_FILE"
  723. ## rename the generated vm.<time>.args file
  724. mv -f "$TMP_ARG_FILE" "$ARGS_FILE"
  725. }
  726. # check if a PID is defunct
  727. is_defunct() {
  728. local PID="$1"
  729. ps -fp "$PID" | $GREP -q 'defunct'
  730. }
  731. # check if a PID is down
  732. # shellcheck disable=SC2317 # call in func `nodetool_shutdown()`
  733. is_down() {
  734. PID="$1"
  735. if ps -p "$PID" >/dev/null; then
  736. # still around
  737. # shellcheck disable=SC2009 # this grep pattern is not a part of the program names
  738. if is_defunct "$PID"; then
  739. # zombie state, print parent pid
  740. parent="$(ps -o ppid= -p "$PID" | tr -d ' ')"
  741. if [ -z "$parent" ] && ! is_defunct "$PID"; then
  742. # process terminated in the meanwhile
  743. return 0;
  744. fi
  745. logwarn "$PID is marked <defunct>, parent: $(ps -p "$parent")"
  746. return 0
  747. fi
  748. return 1
  749. fi
  750. # it's gone
  751. return 0
  752. }
  753. wait_for() {
  754. local WAIT_TIME
  755. local CMD
  756. WAIT_TIME="$1"
  757. shift
  758. CMD="$*"
  759. while true; do
  760. if $CMD; then
  761. return 0
  762. fi
  763. if [ "$WAIT_TIME" -le 0 ]; then
  764. return 1
  765. fi
  766. WAIT_TIME=$((WAIT_TIME - 1))
  767. sleep 1
  768. done
  769. }
  770. wait_until_return_val() {
  771. local RESULT
  772. local WAIT_TIME
  773. local CMD
  774. RESULT="$1"
  775. WAIT_TIME="$2"
  776. shift 2
  777. CMD="$*"
  778. while true; do
  779. if [ "$($CMD 2>/dev/null)" = "$RESULT" ]; then
  780. return 0
  781. fi
  782. if [ "$WAIT_TIME" -le 0 ]; then
  783. return 1
  784. fi
  785. WAIT_TIME=$((WAIT_TIME - 1))
  786. sleep 1
  787. done
  788. }
  789. # First, there is EMQX_DEFAULT_LOG_HANDLER which can control the default values
  790. # to be used when generating configs.
  791. # It's set in docker entrypoint and in systemd service file.
  792. #
  793. # To be backward compatible with 4.x and v5.0.0 ~ v5.0.24/e5.0.2:
  794. # if EMQX_LOG__TO is set, we try to enable handlers from environment variables.
  795. # i.e. it overrides the default value set in EMQX_DEFAULT_LOG_HANDLER
  796. tr_log_to_env() {
  797. local log_to=${EMQX_LOG__TO:-undefined}
  798. # unset because it's unknown to 5.0
  799. unset EMQX_LOG__TO
  800. case "${log_to}" in
  801. console)
  802. export EMQX_LOG__CONSOLE__ENABLE='true'
  803. export EMQX_LOG__FILE__ENABLE='false'
  804. ;;
  805. file)
  806. export EMQX_LOG__CONSOLE__ENABLE='false'
  807. export EMQX_LOG__FILE__ENABLE='true'
  808. ;;
  809. both)
  810. export EMQX_LOG__CONSOLE__ENABLE='true'
  811. export EMQX_LOG__FILE__ENABLE='true'
  812. ;;
  813. default)
  814. # want to use config file defaults, do nothing
  815. ;;
  816. undefined)
  817. # value not set, do nothing
  818. ;;
  819. *)
  820. logerr "Unknown environment value for EMQX_LOG__TO=${log_to} discarded"
  821. ;;
  822. esac
  823. }
  824. maybe_log_to_console() {
  825. if [ "${EMQX_LOG__TO:-}" = 'default' ]; then
  826. # want to use defaults, do nothing
  827. unset EMQX_LOG__TO
  828. else
  829. tr_log_to_env
  830. export EMQX_DEFAULT_LOG_HANDLER=${EMQX_DEFAULT_LOG_HANDLER:-console}
  831. fi
  832. }
  833. # Warn the user if ulimit -n is less than 1024
  834. maybe_warn_ulimit() {
  835. ULIMIT_F=$(ulimit -n)
  836. if [ "$ULIMIT_F" -lt 1024 ]; then
  837. logwarn "ulimit -n is ${ULIMIT_F}; 1024 is the recommended minimum."
  838. fi
  839. }
  840. ## Possible ways to configure emqx node name:
  841. ## 1. configure node.name in emqx.conf
  842. ## 2. override with environment variable EMQX_NODE__NAME
  843. ## Node name is either short-name (without '@'), e.g. 'emqx'
  844. ## or long name (with '@') e.g. 'emqx@example.net' or 'emqx@127.0.0.1'
  845. NAME="${EMQX_NODE__NAME:-}"
  846. if [ -z "$NAME" ]; then
  847. NAME="$(get_boot_config 'node.name')"
  848. fi
  849. # force to use 'emqx' short name
  850. [ -z "$NAME" ] && NAME='emqx'
  851. case "$NAME" in
  852. *@*)
  853. NAME_TYPE='-name'
  854. ;;
  855. *)
  856. NAME_TYPE='-sname'
  857. esac
  858. SHORT_NAME="$(echo "$NAME" | awk -F'@' '{print $1}')"
  859. HOST_NAME="$(echo "$NAME" | awk -F'@' '{print $2}')"
  860. if ! (echo "$SHORT_NAME" | $GREP -q '^[0-9A-Za-z_\-]\+$'); then
  861. logerr "Invalid node name, should be of format '^[0-9A-Za-z_-]+$'."
  862. exit 1
  863. fi
  864. # This also changes the program name from 'beam.smp' to node name
  865. # e.g. the 'ps' command output
  866. export ESCRIPT_NAME="$SHORT_NAME"
  867. PIPE_DIR="${PIPE_DIR:-/$DATA_DIR/${WHOAMI}_erl_pipes/$NAME/}"
  868. ## Resolve Erlang cookie.
  869. if [ -n "${EMQX_NODE_COOKIE:-}" ]; then
  870. ## To be backward compatible, read and unset EMQX_NODE_COOKIE
  871. export EMQX_NODE__COOKIE="${EMQX_NODE_COOKIE}"
  872. unset EMQX_NODE_COOKIE
  873. fi
  874. COOKIE="${EMQX_NODE__COOKIE:-}"
  875. COOKIE_IN_USE="$(get_boot_config 'node.cookie')"
  876. if [ "$IS_BOOT_COMMAND" != 'yes' ] && [ -n "$COOKIE_IN_USE" ] && [ -n "$COOKIE" ] && [ "$COOKIE" != "$COOKIE_IN_USE" ]; then
  877. die "EMQX_NODE__COOKIE is different from the cookie used by $NAME"
  878. fi
  879. [ -z "$COOKIE" ] && COOKIE="$COOKIE_IN_USE"
  880. [ -z "$COOKIE" ] && COOKIE="$EMQX_DEFAULT_ERLANG_COOKIE"
  881. maybe_warn_default_cookie() {
  882. if [ $IS_BOOT_COMMAND = 'yes' ] && [ "$COOKIE" = "$EMQX_DEFAULT_ERLANG_COOKIE" ]; then
  883. logwarn "Default (insecure) Erlang cookie is in use."
  884. logwarn "Configure node.cookie in $EMQX_ETC_DIR/emqx.conf or override from environment variable EMQX_NODE__COOKIE"
  885. logwarn "NOTE: Use the same cookie for all nodes in the cluster."
  886. fi
  887. }
  888. ## check if OTP version has mnesia_hook feature; if not, fallback to
  889. ## using Mnesia DB backend.
  890. if [[ "$IS_BOOT_COMMAND" == 'yes' && "$(get_boot_config 'node.db_backend')" == "rlog" ]]; then
  891. if ! (echo -e "$COMPATIBILITY_INFO" | $GREP -q 'MNESIA_OK'); then
  892. logwarn "DB Backend is RLOG, but an incompatible OTP version has been detected. Falling back to using Mnesia DB backend."
  893. export EMQX_NODE__DB_BACKEND=mnesia
  894. export EMQX_NODE__DB_ROLE=core
  895. fi
  896. fi
  897. diagnose_boot_failure_and_die() {
  898. local ps_line
  899. ps_line="$(find_emqx_process)"
  900. if [ -z "$ps_line" ]; then
  901. echo "Find more information in the latest log file: ${EMQX_LOG_DIR}/erlang.log.*"
  902. exit 1
  903. fi
  904. if ! relx_nodetool "ping" > /dev/null; then
  905. logerr "$NAME seems to be running, but not responding to pings."
  906. echo "Make sure '$HOST_NAME' is a resolvable and reachable hostname."
  907. pipe_shutdown
  908. exit 2
  909. fi
  910. if ! relx_nodetool 'eval' 'true = emqx:is_running()' > /dev/null; then
  911. logerr "$NAME node is started, but failed to complete the boot sequence in time."
  912. echo "Please collect the logs in ${EMQX_LOG_DIR} and report a bug to EMQX team at https://github.com/emqx/emqx/issues/new/choose"
  913. pipe_shutdown
  914. exit 3
  915. fi
  916. }
  917. ## Only works when started in daemon mode
  918. pipe_shutdown() {
  919. if [ -d "$PIPE_DIR" ]; then
  920. echo "Shutting down $NAME from to_erl pipe."
  921. ## can not evaluate init:stop() or erlang:halt() because the shell is restricted
  922. echo 'emqx_machine:brutal_shutdown().' | "$BINDIR/to_erl" "$PIPE_DIR"
  923. fi
  924. }
  925. ## Call nodetool to stop EMQX
  926. nodetool_shutdown() {
  927. # Wait for the node to completely stop...
  928. PID="$(relx_get_pid)"
  929. if ! relx_nodetool "stop"; then
  930. die "Graceful shutdown failed PID=[$PID]"
  931. fi
  932. WAIT_TIME="${EMQX_WAIT_FOR_STOP:-120}"
  933. if ! wait_for "$WAIT_TIME" 'is_down' "$PID"; then
  934. msg="dangling after ${WAIT_TIME} seconds"
  935. # also log to syslog
  936. logger -t "${REL_NAME}[${PID}]" "STOP: $msg"
  937. # log to user console
  938. set +x
  939. logerr "Stop failed, $msg"
  940. echo "ERROR: $PID is still around"
  941. ps -p "$PID"
  942. exit 1
  943. fi
  944. echo "ok"
  945. logger -t "${REL_NAME}[${PID}]" "STOP: OK"
  946. }
  947. cd "$RUNNER_ROOT_DIR"
  948. case "${COMMAND}" in
  949. start)
  950. maybe_warn_ulimit
  951. maybe_warn_default_cookie
  952. # this flag passes down to console mode
  953. # so we know it's intended to be run in daemon mode
  954. export _EMQX_START_DAEMON_MODE=1
  955. case "$COMMAND" in
  956. start)
  957. shift
  958. START_OPTION="console"
  959. HEART_OPTION="start"
  960. ;;
  961. esac
  962. RUN_PARAM="$*"
  963. # Set arguments for the heart command
  964. set -- "$RUNNER_SCRIPT" "$HEART_OPTION"
  965. [ "$RUN_PARAM" ] && set -- "$@" "$RUN_PARAM"
  966. # Export the HEART_COMMAND
  967. HEART_COMMAND="$RUNNER_SCRIPT $COMMAND"
  968. export HEART_COMMAND
  969. ## See: http://erlang.org/doc/man/run_erl.html
  970. # Export the RUN_ERL_LOG_GENERATIONS
  971. export RUN_ERL_LOG_GENERATIONS=${RUN_ERL_LOG_GENERATIONS:-"5"}
  972. # Export the RUN_ERL_LOG_MAXSIZE
  973. export RUN_ERL_LOG_MAXSIZE=${RUN_ERL_LOG_MAXSIZE:-"10485760"}
  974. mkdir -p "$PIPE_DIR"
  975. "$BINDIR/run_erl" -daemon "$PIPE_DIR" "$EMQX_LOG_DIR" \
  976. "$(relx_start_command)"
  977. WAIT_TIME=${EMQX_WAIT_FOR_START:-120}
  978. if wait_until_return_val "true" "$WAIT_TIME" 'relx_nodetool' \
  979. 'eval' 'emqx:is_running()'; then
  980. echo "$EMQX_DESCRIPTION $REL_VSN is started successfully!"
  981. exit 0
  982. else
  983. logerr "${EMQX_DESCRIPTION} ${REL_VSN} using node name '${NAME}' failed ${WAIT_TIME} probes."
  984. diagnose_boot_failure_and_die
  985. fi
  986. ;;
  987. stop)
  988. if ! nodetool_shutdown; then
  989. pipe_shutdown
  990. fi
  991. ;;
  992. pid)
  993. ## Get the VM's pid
  994. if ! relx_get_pid; then
  995. exit 1
  996. fi
  997. ;;
  998. ping)
  999. assert_node_alive
  1000. echo pong
  1001. ;;
  1002. escript)
  1003. ## Run an escript under the node's environment
  1004. if ! relx_escript "$@"; then
  1005. exit 1
  1006. fi
  1007. ;;
  1008. attach)
  1009. exec "$BINDIR/to_erl" "$PIPE_DIR"
  1010. ;;
  1011. remote_console)
  1012. assert_node_alive
  1013. shift
  1014. remsh
  1015. ;;
  1016. upgrade|downgrade|install|unpack|uninstall)
  1017. if [ -z "${2:-}" ]; then
  1018. echo "Missing version argument"
  1019. echo "Usage: $REL_NAME $COMMAND {version}"
  1020. exit 1
  1021. fi
  1022. shift
  1023. assert_node_alive
  1024. curr_vsn="$(current_script_version)"
  1025. target_vsn="$1"
  1026. newest_vsn="$(max_version_of "$target_vsn" "$curr_vsn")"
  1027. ensure_newest_script_is_extracted "$newest_vsn"
  1028. # if we are not the newest script, run the same command from it
  1029. if ! am_i_the_newest_script "$newest_vsn"; then
  1030. script_path="$(versioned_script_path emqx "$newest_vsn")"
  1031. exec "$script_path" "$COMMAND" "$@"
  1032. fi
  1033. upgrade_script_path="$(versioned_script_path install_upgrade.escript "$newest_vsn")"
  1034. echo "using ${upgrade_script_path} to run ${COMMAND} $*"
  1035. ERL_FLAGS="${ERL_FLAGS:-} $EPMD_ARGS" \
  1036. exec "$BINDIR/escript" "$upgrade_script_path" \
  1037. "$COMMAND" "{'$REL_NAME', \"$NAME_TYPE\", '$NAME', '$COOKIE'}" "$@"
  1038. ;;
  1039. versions)
  1040. assert_node_alive
  1041. shift
  1042. ERL_FLAGS="${ERL_FLAGS:-} $EPMD_ARGS" \
  1043. exec "$BINDIR/escript" "$RUNNER_ROOT_DIR/bin/install_upgrade.escript" \
  1044. "versions" "{'$REL_NAME', \"$NAME_TYPE\", '$NAME', '$COOKIE'}" "$@"
  1045. ;;
  1046. console|console_clean|foreground)
  1047. # .boot file typically just $REL_NAME (ie, the app name)
  1048. # however, for debugging, sometimes start_clean.boot is useful.
  1049. # For e.g. 'setup', one may even want to name another boot script.
  1050. case "$COMMAND" in
  1051. console|foreground)
  1052. if [ -f "$REL_DIR/$REL_NAME.boot" ]; then
  1053. BOOTFILE="$REL_DIR/$REL_NAME"
  1054. else
  1055. BOOTFILE="$REL_DIR/start"
  1056. fi
  1057. ;;
  1058. console_clean)
  1059. BOOTFILE="$REL_DIR/start_clean"
  1060. ;;
  1061. esac
  1062. case "$COMMAND" in
  1063. foreground)
  1064. FOREGROUNDOPTIONS="-noshell -noinput +Bd"
  1065. ;;
  1066. *)
  1067. FOREGROUNDOPTIONS=''
  1068. ;;
  1069. esac
  1070. # set before generate_config
  1071. if [ "${_EMQX_START_DAEMON_MODE:-}" = 1 ]; then
  1072. tr_log_to_env
  1073. else
  1074. maybe_log_to_console
  1075. maybe_warn_ulimit
  1076. maybe_warn_default_cookie
  1077. fi
  1078. #generate app.config and vm.args
  1079. generate_config "$NAME_TYPE" "$NAME"
  1080. check_license
  1081. # Setup beam-required vars
  1082. EMU="beam"
  1083. PROGNAME="${0}"
  1084. export EMU
  1085. export PROGNAME
  1086. # Store passed arguments since they will be erased by `set`
  1087. ARGS="$*"
  1088. # shellcheck disable=SC2086
  1089. # Build an array of arguments to pass to exec later on
  1090. # Build it here because this command will be used for logging.
  1091. if [ "$IS_ELIXIR" = no ] || [ "${EMQX_CONSOLE_FLAVOR:-}" = 'erl' ] ; then
  1092. # pass down RELEASE_LIB so we can switch to IS_ELIXIR=no
  1093. # to boot an Erlang node from the elixir release
  1094. set -- "$BINDIR/erlexec" \
  1095. $FOREGROUNDOPTIONS \
  1096. -boot "$BOOTFILE" \
  1097. -boot_var RELEASE_LIB "$ERTS_LIB_DIR" \
  1098. -boot_var ERTS_LIB_DIR "$ERTS_LIB_DIR" \
  1099. -mode "$CODE_LOADING_MODE" \
  1100. -config "$CONF_FILE" \
  1101. -args_file "$ARGS_FILE" \
  1102. $EPMD_ARGS
  1103. else
  1104. set -- "$REL_DIR/iex" \
  1105. --boot "$BOOTFILE" \
  1106. --boot-var RELEASE_LIB "${ERTS_LIB_DIR}" \
  1107. --erl-config "${CONF_FILE}" \
  1108. --vm-args "${ARGS_FILE}" \
  1109. --erl "$FOREGROUNDOPTIONS" \
  1110. --erl "-mode $CODE_LOADING_MODE" \
  1111. --erl "$EPMD_ARGS" \
  1112. --werl
  1113. fi
  1114. # Log the startup
  1115. logger -t "${REL_NAME}[$$]" "EXEC: $* -- ${1+$ARGS} -ekka_proto_dist ${EKKA_PROTO_DIST_MOD} -emqx_data_dir ${DATA_DIR}"
  1116. # Start the VM
  1117. # add ekka_proto_dist emqx_data_dir to boot command so it is visible from 'ps -ef'
  1118. # NTOE: order matters! emqx_data_dir has to be positioned at the end of the line to simplify the
  1119. # line parsing when file path contains spaces
  1120. exec "$@" -- ${1+$ARGS} -ekka_proto_dist "${EKKA_PROTO_DIST_MOD}" -emqx_data_dir "${DATA_DIR}"
  1121. ;;
  1122. ctl)
  1123. assert_node_alive
  1124. shift
  1125. relx_nodetool rpc_infinity emqx_ctl run_command "$@"
  1126. ;;
  1127. rpc)
  1128. assert_node_alive
  1129. shift
  1130. relx_nodetool rpc "$@"
  1131. ;;
  1132. rpcterms)
  1133. assert_node_alive
  1134. shift
  1135. relx_nodetool rpcterms "$@"
  1136. ;;
  1137. eval)
  1138. assert_node_alive
  1139. shift
  1140. relx_nodetool "eval" "$@"
  1141. ;;
  1142. eval-ex)
  1143. assert_node_alive
  1144. shift
  1145. if [ "$IS_ELIXIR" = "yes" ]
  1146. then
  1147. "$REL_DIR/elixir" \
  1148. --hidden \
  1149. --name "rand-$(gen_node_id)-$NAME" \
  1150. --cookie "$COOKIE" \
  1151. --boot "$REL_DIR/start_clean" \
  1152. --boot-var RELEASE_LIB "$ERTS_LIB_DIR" \
  1153. --vm-args "$REL_DIR/remote.vm.args" \
  1154. --erl "-start_epmd false -epmd_module ekka_epmd" \
  1155. --rpc-eval "$NAME" "$@"
  1156. else
  1157. echo "EMQX node is not an Elixir node"
  1158. usage "$COMMAND"
  1159. exit 1
  1160. fi
  1161. ;;
  1162. check_config)
  1163. check_config
  1164. ;;
  1165. *)
  1166. usage "$COMMAND"
  1167. exit 1
  1168. ;;
  1169. esac
  1170. exit 0