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:

# Use single file for location config and threshold configurations
sdb-report send-alert --config-file /path/to/config.yaml

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

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

# Use separate location config and threshold configurations files
sdb-report send-alert --alert-location /path/to/location-config.yaml --thresholds /path/to/thresholds/config/file

Below is example of config file content:
location:
  email:
    receivers:
      - receiver@example.com
    sender: sender@example.com
    server:
      host: smtp.example.com
      port: 25
      username: ~
      password: ~
thresholds:
  leavesNotOnline:
    fail: 2
  memoryCommitted:
    warn: 80

Usage:
  sdb-report send-alert [flags]

Flags:
      --alert-location YAML   Path to the SMTP config file (ADVANCED)
      --config-file YAML      Path to the alerting config YAML file. Specify both the thresholds and this path in the alerting config file
      --fail-only             Send alerts only for failed checks
  -h, --help                  Help for send-alert
      --summary-only          Include only summaries in alerts
      --thresholds YAML       Alert thresholds config YAML or path to YAML (ADVANCED)

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                      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

Remarks

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

Was this Article Helpful?

Thanks For Your Feedback!