On this page
Updates the monitoring configuration for the cluster.
This will restart the
memsql_ process or stop it if
--stop-exporter is specified.
This command should be run on the cluster you are monitoring (Source cluster).
--exporter-password flag is required and specifies the password of the SingleStoreDB
root user on the Source cluster.
--exporter-user flag to specify a SingleStoreDB user on Source cluster that is different from the
root user and the user’s password.
EXPORTER_ environment variable is a safer alternative option for setting the password.
Wrap the password string in single quotes (') to avoid having the shell try to interpret any special characters included in the string.
Usage:sdb-admin configure-monitoring [flags]For flags that can accept multiple values (indicated by VALUES after the name of the flag),separate each value with a comma.Flags:-p, --exporter-password string The password for the user that will start the memsql_exporter on the Source cluster. If a password is specified on the command line, it must not contain an unescaped '$' character as it will be replaced by the shell-P, --exporter-port PORT Port where memsql_exporter is run (on the Source cluster) (default 9104)--exporter-ssl-cert string Path to the certificate the exporter will use for SSL connections. This path must exist on the host where the exporter is running--exporter-ssl-key string Path to the public-private key pair file the exporter will use for SSL connections. This path must exist on the host where the exporter is running--exporter-ssl-passphrase string Passphrase for encrypted exporter-ssl-key--exporter-use-https Whether to start the exporter in HTTPS mode. Requires --exporter-ssl-cert and --exporter-ssl-key to be set-u, --exporter-user string The database user on the Source cluster that will start the memsql_exporter (should have at least SHOW METADATA permission) (default "root")-h, --help Help for configure-monitoring--stop-exporter Stop the memsql_exporter processGlobal Flags:--backup-cache FILE_PATH File path for the backup cache--cache-file FILE_PATH File path for the Toolbox node cache-c, --config FILE_PATH File path for the Toolbox configuration--disable-colors Disable color output in console, which some terminal sessions/environments may have difficulty with--disable-spinner Disable the progress spinner, which some terminal sessions/environments may have issues with-j, --json Enable JSON output--parallelism POSITIVE_INTEGER Maximum number of operations to run in parallel--runtime-dir DIRECTORY_PATH Where to store Toolbox runtime data--ssh-control-persist SECONDS Enable SSH ControlPersist and set it to the specified duration in seconds--ssh-max-sessions POSITIVE_INTEGER Maximum number of SSH sessions to open per host, must be at least 3--ssh-strict-host-key-checking Enable strict host key checking for SSH connections--ssh-user-known-hosts-file FILE_PATH Path to the user known_hosts file for SSH connections. If not set, /dev/null will be used--state-file FILE_PATH Toolbox state file path-v, --verbosity count Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count-y, --yes Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default
This command is interactive unless you use either
--json flag to override interactive behavior.
Last modified: October 6, 2023