Cluster
Define clusters of MentDB servers and their nodes, then execute MQL scripts across the cluster. Nodes can be expelled and reinstated, and signals can be set, deployed and given to agents. Typical uses: spread work over several servers, keep a service running when a node fails.
cluster showcluster createcluster existcluster deletesignal processsignal deploycluster signal setcluster signal deletecluster signal show_objcluster signal showsignal remote_showcluster signal givecluster node setcluster nodes show_objcluster nodes show_txtcluster node deletecluster node expelscluster execute_hotcluster executecluster node reinstatecluster node generate_setcluster node

cluster show


Description

    To show all clusters

admin
cluster show;
mentdb
[ "cluster_id_2", "cluster_id_1" ]
Used in use cases (1 recipe)

    Cluster & high-availability engineer › Is this server ready for a cluster?
Often used with

    cluster exist  ·  cluster signal show_obj  ·  concat_var  ·  config show  ·  job exist  ·  job show  ·  string trim

cluster create <clusterId>


Description

    To create a new cluster

Parameters

    clusterId:   The cluster id - string - required
admin
cluster create "cluster_id_1";
mentdb
Cluster created with successful.
Used in use cases (3 recipes)

    Cluster & high-availability engineer › Build a 2-node cluster and replicate the scripts
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
    Cluster & high-availability engineer › Round robin or signal: which node gets the request?
Often used with

    cluster node set  ·  cluster delete  ·  cluster exist  ·  cluster node  ·  cluster node delete  ·  cluster nodes show_txt  ·  cluster node expels  ·  cluster node generate_set

cluster exist <clusterId>


Description

    To check if a cluster already exists

Parameters

    clusterId:   The cluster id - string - required
admin
cluster exist "cluster_id_1";
mentdb
1
Used in use cases (4 recipes)

    Cluster & high-availability engineer › Is this server ready for a cluster?
    Cluster & high-availability engineer › Retire a staging cluster cleanly
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
    Cluster & high-availability engineer › Round robin or signal: which node gets the request?
Often used with

    cluster delete  ·  cluster node delete  ·  cluster create  ·  cluster node generate_set  ·  cluster node set  ·  cluster node  ·  cluster node expels  ·  cluster node reinstate

cluster delete <clusterId>


Description

    To delete a cluster

Parameters

    clusterId:   The cluster id - string - required
admin
cluster delete "cluster_id_2";
mentdb
Cluster deleted with successful.
Used in use cases (3 recipes)

    Cluster & high-availability engineer › Retire a staging cluster cleanly
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
    Cluster & high-availability engineer › Round robin or signal: which node gets the request?
Often used with

    cluster exist  ·  cluster node delete  ·  cluster create  ·  cluster node generate_set  ·  cluster node set  ·  cluster node  ·  cluster node expels  ·  cluster node reinstate

signal process


Description

    To send signals to agents

admin
signal process;
mentdb
1
Used in use cases (1 recipe)

    Cluster & high-availability engineer › Build a 2-node cluster and replicate the scripts
Often used with

    cluster create  ·  cluster node  ·  cluster node set  ·  cluster nodes show_txt  ·  cluster signal set  ·  execute  ·  parameter get value  ·  signal deploy

signal deploy <clusterId> <hostname> <port> <user> <user_key> <password> <connectTimeout> <readTimeout> <mql_signal>


Description

    To deploy all signals to all nodes

Parameters

    clusterId:   The cluster id - string - required
    hostname:   The hostname - string - required
    port:   The port - string - required
    user:   The user - string - required
    user_key:   The user key - string - required
    password:   The password - string - required
    connectTimeout:   The connection timeout - string - required
    readTimeout:   The read timeout - string - required
    mql_signal:   The MQL signal (returns a number) - string - required
admin
signal deploy "cluster_id_1" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 "metric current cpu jvm;"
mentdb
ok/set/cluster_id_1/node_id_3 ok/set/cluster_id_1/node_id_4 ok/set/cluster_id_1/node_id_1 ok/set/cluster_id_1/node_id_2
Used in use cases (1 recipe)

    Cluster & high-availability engineer › Build a 2-node cluster and replicate the scripts
Often used with

    cluster create  ·  cluster node  ·  cluster node set  ·  cluster nodes show_txt  ·  cluster signal set  ·  execute  ·  parameter get value  ·  signal process

cluster signal set <clusterId> <nodeId> <hostname> <port> <user> <user_key> <password> <connectTimeout> <readTimeout> <mql_signal>


Description

    To set a new signal in a node

Parameters

    clusterId:   The cluster id - string - required
    nodeId:   The node id - string - required
    hostname:   The hostname - string - required
    port:   The port - string - required
    user:   The user - string - required
    user_key:   The user key - string - required
    password:   The password - string - required
    connectTimeout:   The connection timeout - string - required
    readTimeout:   The read timeout - string - required
    mql_signal:   The MQL signal (returns a number) - string - required
admin
cluster signal set "cluster_id_1" "node_id_1" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 "metric current cpu jvm;"
mentdb
Signal added/updated with successful.
Used in use cases (1 recipe)

    Cluster & high-availability engineer › Build a 2-node cluster and replicate the scripts
Often used with

    cluster create  ·  cluster node  ·  cluster node set  ·  cluster nodes show_txt  ·  execute  ·  parameter get value  ·  signal deploy  ·  signal process

cluster signal delete <clusterId> <nodeId>


Description

    To delete a signal from a node

Parameters

    clusterId:   The cluster id - string - required
    nodeId:   The node id - string - required
admin
cluster signal delete "cluster_id_1" "node_id_1"
mentdb
Signal deleted with successful.
Used in use cases (2 recipes)

    Cluster & high-availability engineer › Failover of a node
    Cluster & high-availability engineer › Retire a staging cluster cleanly
Often used with

    cluster node delete  ·  signal remote_show  ·  cluster delete  ·  cluster exist  ·  cluster node expels  ·  cluster node generate_set  ·  cluster node reinstate  ·  cluster nodes show_obj

cluster signal show_obj


Description

    To show all the signals of this server (cluster > node > signal) in object format, the password and the key are masked

admin
cluster signal show_obj
mentdb
{ "cluster_id_1": { "node_id_1": { "cluster_id": "cluster_id_1", "node_id": "node_id_1", "hostname": "localhost", "port": "9998", "user": "admin", "user_key": "***", "password": "***", "connectTimeout": "10000", "readTimeout": "30000", "mql_signal": "metric current cpu jvm;", "signal_last_time": "2019-07-01 09:58:07", "error": "" } } }
Used in use cases (1 recipe)

    Cluster & high-availability engineer › Is this server ready for a cluster?
Often used with

    cluster exist  ·  cluster show  ·  concat_var  ·  config show  ·  job exist  ·  job show  ·  string trim

cluster signal show <clusterId>


Description

    To show all the signals of a node for a specific cluster

Parameters

    clusterId:   The cluster id - string - required
admin
cluster signal show "cluster_id_1"
mentdb
CLUSTER_ID / NODE_ID / USER@HOSTNAME:PORT / CONNECT_TIMEOUT / READ_TIMEOUT / MQL_SIGNAL / LAST_TIME : ERROR cluster_id_1 / node_id_3 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:58:07 : cluster_id_1 / node_id_4 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:58:07 : cluster_id_1 / node_id_1 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:58:07 : cluster_id_1 / node_id_2 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:58:07 :
Used in use cases (1 recipe)

    Cluster & high-availability engineer › Failover of a node
Often used with

    cluster node delete  ·  cluster node expels  ·  cluster node reinstate  ·  cluster nodes show_txt  ·  cluster signal delete  ·  cluster signal give  ·  date now  ·  execute

signal remote_show <clusterId>


Description

    To show all the remote signals of a node for a specific cluster

Parameters

    clusterId:   The cluster id - string - required
admin
signal remote_show "cluster_id_1"
mentdb
ok/CLUSTER_ID / NODE_ID / USER@HOSTNAME:PORT / CONNECT_TIMEOUT / READ_TIMEOUT / MQL_SIGNAL / LAST_TIME : ERROR cluster_id_1 / node_id_3 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_4 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_1 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / : cluster_id_1 / node_id_2 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / : ok/CLUSTER_ID / NODE_ID / USER@HOSTNAME:PORT / CONNECT_TIMEOUT / READ_TIMEOUT / MQL_SIGNAL / LAST_TIME : ERROR cluster_id_1 / node_id_3 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_4 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_1 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_2 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / : ok/CLUSTER_ID / NODE_ID / USER@HOSTNAME:PORT / CONNECT_TIMEOUT / READ_TIMEOUT / MQL_SIGNAL / LAST_TIME : ERROR cluster_id_1 / node_id_3 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_4 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_1 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_2 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : ok/CLUSTER_ID / NODE_ID / USER@HOSTNAME:PORT / CONNECT_TIMEOUT / READ_TIMEOUT / MQL_SIGNAL / LAST_TIME : ERROR cluster_id_1 / node_id_3 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_4 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_1 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 : cluster_id_1 / node_id_2 / admin@localhost:9998 / 10000 / 30000 / metric current cpu jvm; / 2019-07-01 09:57:47 :
Used in use cases (2 recipes)

    Cluster & high-availability engineer › Failover of a node
    Cluster & high-availability engineer › Retire a staging cluster cleanly
Often used with

    cluster node delete  ·  cluster signal delete  ·  cluster delete  ·  cluster exist  ·  cluster node expels  ·  cluster node generate_set  ·  cluster node reinstate  ·  cluster nodes show_obj

cluster signal give <clusterId> <nodeId> <signal> <current_time>


Description

    To give a signal to an agent

Parameters

    clusterId:   The cluster id - string - required
    nodeId:   The node id - string - required
    signal:   The signal (a number) - number - required
    current_time:   The current time - string - required
admin
cluster signal give "cluster_id_1" "node_id_1" 52 "2019-06-18 10:21:56"
mentdb
1
Used in use cases (2 recipes)

    Cluster & high-availability engineer › Failover of a node
    Cluster & high-availability engineer › Round robin or signal: which node gets the request?
Often used with

    cluster node delete  ·  cluster create  ·  cluster delete  ·  cluster exist  ·  cluster node  ·  cluster node expels  ·  cluster node reinstate  ·  cluster node set

cluster node set <clusterId> <nodeId> <hostname> <port> <user> <user_key> <password> <connectTimeout> <readTimeout> <active_signal>


Description

    To set a new node in a cluster

Parameters

    clusterId:   The cluster id - string - required
    nodeId:   The node id - string - required
    hostname:   The hostname - string - required
    port:   The port - string - required
    user:   The user - string - required
    user_key:   The user key - string - required
    password:   The password - string - required
    connectTimeout:   The connection timeout - string - required
    readTimeout:   The read timeout - string - required
    active_signal:   Is it an auto-active signal node? - boolean - required
admin
cluster node set "cluster_id_1" "node_id_1" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true; cluster node set "cluster_id_1" "node_id_2" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true; cluster node set "cluster_id_1" "node_id_3" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true; cluster node set "cluster_id_1" "node_id_4" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true;
mentdb
Node added/updated with successful.
Used in use cases (3 recipes)

    Cluster & high-availability engineer › Build a 2-node cluster and replicate the scripts
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
    Cluster & high-availability engineer › Round robin or signal: which node gets the request?
Often used with

    cluster create  ·  cluster delete  ·  cluster exist  ·  cluster node  ·  cluster node delete  ·  cluster nodes show_txt  ·  cluster node expels  ·  cluster node generate_set

cluster nodes show_obj <clusterId>


Description

    To show all the nodes of a cluster in array format

Parameters

    clusterId:   The cluster id - string - required
admin
cluster nodes show_obj "cluster_id_1"
mentdb
{ "node_id_3": { "in_the_cluster": "1", "active_signal": "1", "signal_last_time": "2019-06-30 09:35:45", "user_key": "pwd", "error": "", "cluster_id": "cluster_id_1", "hostname": "localhost", "password": "pwd", "port": "9998", "readTimeout": "30000", "connectTimeout": "10000", "signal": "0.2", "user": "admin", "node_id": "node_id_3" }, "node_id_4": { "in_the_cluster": "1", "active_signal": "1", "signal_last_time": "2019-06-30 09:35:45", "user_key": "pwd", "error": "", "cluster_id": "cluster_id_1", "hostname": "localhost", "password": "pwd", "port": "9998", "readTimeout": "30000", "connectTimeout": "10000", "signal": "35.1", "user": "admin", "node_id": "node_id_4" }, "node_id_1": { "in_the_cluster": "1", "active_signal": "1", "signal_last_time": "2019-06-30 09:35:45", "user_key": "pwd", "error": "", "cluster_id": "cluster_id_1", "hostname": "localhost", "password": "pwd", "port": "9998", "readTimeout": "30000", "connectTimeout": "10000", "signal": "57.0", "user": "admin", "node_id": "node_id_1" }, "node_id_2": { "in_the_cluster": "1", "active_signal": "1", "signal_last_time": "2019-06-30 09:35:45", "user_key": "pwd", "error": "", "cluster_id": "cluster_id_1", "hostname": "localhost", "password": "pwd", "port": "9998", "readTimeout": "30000", "connectTimeout": "10000", "signal": "57.5", "user": "admin", "node_id": "node_id_2" } }
Used in use cases (1 recipe)

    Cluster & high-availability engineer › Retire a staging cluster cleanly
Often used with

    cluster delete  ·  cluster exist  ·  cluster node delete  ·  cluster node generate_set  ·  cluster signal delete  ·  json parse_obj  ·  signal remote_show  ·  string char

cluster nodes show_txt <clusterId>


Description

    To show all the nodes of a cluster in text format

Parameters

    clusterId:   The cluster id - string - required
admin
cluster nodes show_txt "cluster_id_1"
mentdb
IN_THE_CLUSTER / ACTIVE_SIGNAL / CLUSTER_ID / NODE_ID / USER@HOSTNAME:PORT / CONNECT_TIMEOUT / READ_TIMEOUT / SIGNAL / LAST_TIME / NB_CMD : ERROR 1 / 0 / cluster_id_1 / node_id_3 / admin@localhost:9998 / 10000 / 30000 / 0.2 / 2019-07-01 09:41:07 / 11 : 1 / 0 / cluster_id_1 / node_id_4 / admin@localhost:9998 / 10000 / 30000 / 35.0 / 2019-07-01 09:41:07 / 0 : 1 / 0 / cluster_id_1 / node_id_1 / admin@localhost:9998 / 10000 / 30000 / 58.8 / 2019-07-01 09:41:07 / 0 : 1 / 0 / cluster_id_1 / node_id_2 / admin@localhost:9998 / 10000 / 30000 / 57.0 / 2019-07-01 09:41:07 / 0 :
Used in use cases (3 recipes)

    Cluster & high-availability engineer › Build a 2-node cluster and replicate the scripts
    Cluster & high-availability engineer › Failover of a node
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
Often used with

    cluster create  ·  cluster node delete  ·  cluster node expels  ·  cluster node reinstate  ·  cluster node set  ·  execute  ·  cluster delete  ·  cluster exist

cluster node delete <clusterId> <nodeId>


Description

    To delete a node from a cluster

Parameters

    clusterId:   The cluster id - string - required
    nodeId:   The node id - string - required
admin
cluster node delete "cluster_id_1" "node_id_1";
mentdb
Node deleted with successful.
Used in use cases (4 recipes)

    Cluster & high-availability engineer › Failover of a node
    Cluster & high-availability engineer › Retire a staging cluster cleanly
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
    Cluster & high-availability engineer › Round robin or signal: which node gets the request?
Often used with

    cluster delete  ·  cluster exist  ·  cluster create  ·  cluster node expels  ·  cluster node generate_set  ·  cluster node reinstate  ·  cluster node set  ·  cluster nodes show_txt

cluster node expels <clusterId> <nodeId> <error>


Description

    To expel a node from a cluster

Parameters

    clusterId:   The cluster id - string - required
    nodeId:   The node id - string - required
    error:   The error message - string - required
admin
cluster node expels "cluster_id_1" "node_id_1" "error message ...";
mentdb
1
Used in use cases (2 recipes)

    Cluster & high-availability engineer › Failover of a node
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
Often used with

    cluster node delete  ·  cluster node reinstate  ·  cluster nodes show_txt  ·  cluster create  ·  cluster delete  ·  cluster exist  ·  cluster node generate_set  ·  cluster node set

cluster execute_hot


Description

    Execute an MQL command on the fly through a cluster.

admin
-> "[local_var1]" "data1"; -> "[local_var2]" "data2"; include "cluster.1n.hot.exe" "[cluster_id]" "cluster_id_1" "[method]" "LB_50_50|SIGNAL" "[tunnel_id]" "tunnel_id_1" "[request]" (concat "-> \"[remote_var1]\" " (mql encode [local_var1]) ";" "-> \"[remote_var2]\" " (mql encode [local_var2]) ";" (mql { concat [remote_var1] ":" [remote_var2] }) ) ;
mentdb
data1:data2

cluster execute


Description

    Execute an MQL command through a cluster.

admin
-> "[local_var1]" "data1"; -> "[local_var2]" "data2"; execute "cluster.1n.exe" "[cluster_id]" "cluster_id_1" "[method]" "LB_50_50|SIGNAL" "[request]" (concat "-> \"[remote_var1]\" " (mql encode [local_var1]) ";" "-> \"[remote_var2]\" " (mql encode [local_var2]) ";" (mql { concat [remote_var1] ":" [remote_var2] }) ) ;
mentdb
data1:data2

cluster node reinstate <clusterId> <nodeId>


Description

    To reinstate a node in a cluster

Parameters

    clusterId:   The cluster id - string - required
    nodeId:   The node id - string - required
admin
cluster node reinstate "cluster_id_1" "node_id_1"
mentdb
1
Used in use cases (2 recipes)

    Cluster & high-availability engineer › Failover of a node
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
Often used with

    cluster node delete  ·  cluster node expels  ·  cluster nodes show_txt  ·  cluster create  ·  cluster delete  ·  cluster exist  ·  cluster node generate_set  ·  cluster node set

cluster node generate_set <clusterId>


Description

    To generate the MQL code that sets a node in a cluster

Parameters

    clusterId:   The cluster id - string - required
admin
in editor {cluster node generate_set "cluster_id_1"};
mentdb
cluster node set "cluster_id_1" "node_id_3" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true; cluster node set "cluster_id_1" "node_id_4" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true; cluster node set "cluster_id_1" "node_id_1" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true; cluster node set "cluster_id_1" "node_id_2" "localhost" "9998" "admin" "pwd" "pwd" 10000 30000 true;
Used in use cases (2 recipes)

    Cluster & high-availability engineer › Retire a staging cluster cleanly
    Cluster & high-availability engineer › Expel and reinstate drill on a lab cluster
Often used with

    cluster delete  ·  cluster exist  ·  cluster node delete  ·  cluster create  ·  cluster node expels  ·  cluster node reinstate  ·  cluster node set  ·  cluster nodes show_obj

cluster node <clusterId> <method>


Description

    To get a cluster node

Parameters

    clusterId:   The cluster id - string - required
    method:   The method (LB_50_50|SIGNAL) - string - required
admin
cluster node "cluster_id_1" "LB_50_50"
mentdb
{ "subTunnels": "[MQL_TO_REPLACE]", "hostname": "localhost", "password": "pwd", "cluster_id": "cluster_id_1", "port": "9998", "readTimeout": "30000", "connectTimeout": "10000", "type": "mentdb", "user": "admin", "cluster_method": "lb_50_50", "key": "pwd", "node_id": "node_id_3" }
Used in use cases (2 recipes)

    Cluster & high-availability engineer › Build a 2-node cluster and replicate the scripts
    Cluster & high-availability engineer › Round robin or signal: which node gets the request?
Often used with

    cluster create  ·  cluster node set  ·  cluster delete  ·  cluster exist  ·  cluster node delete  ·  cluster nodes show_txt  ·  cluster signal give  ·  cluster signal set