Join the SingleStore Community Today
Get expert advice, develop skills, and connect with others.

send-alert

Build a diagnostics report for the cluster and send an alert if any issues are found.

Usage

Build a diagnostics report for the cluster, check it for issues, and send an alert if any issues are found.

Examples:

# Run the default configuration
memsql-report send-alert --alert-location /path/to/config.yaml

# Receive only a summary of the results
memsql-report send-alert --alert-location /path/to/config.yaml --summary-only

# Receive alerts only when checks fail
memsql-report send-alert --alert-location /path/to/config.yaml --fail-only

# Configure the leavesNotOnline checker to fail when two leaf nodes are not online and orphanDatabases checker to produces failures on any found orphan database
memsql-report send-alert --alert-location /path/to/config.yaml --thresholds '{"leavesNotOnline":{"fail":2}, "orphanDatabases":{"output_level":"fail"}}'

# Use a threshold configurations file
memsql-report send-alert --alert-location /path/to/config.yaml --thresholds /path/to/thresholds/config/file

Below is example of alert location config file content:
email:
  receivers:
    - receiver@example.com
  sender: sender@example.com
  server:
    host: smtp.example.com
    port: 25
    username: ~
    password: ~

Usage:
  memsql-report send-alert [flags]

Flags:
      --alert-location FILE_PATH   Path to SMTP config file
      --fail-only                  Send alerts only for failed checks
  -h, --help                       Help for send-alert
      --summary-only               Include only summaries in alerts
      --thresholds JSON            Alert thresholds config JSON or path to JSON

Global 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                    Toolbox configuration file path
      --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-max-sessions POSITIVE_INTEGER   Maximum number of SSH sessions to open per host, must be at least 3
      --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

Remarks

This command is interactive unless you use either the --yes or --json flags to override interactive behavior.