Outdated Version
You are viewing an older version of this section. View current production version.
start-monitoring
Start monitoring.
Usage
The 'start-monitoring' command creates a database where cluster information is stored and establishes pipelines for streaming data into it.
The 'memsql-admin start-monitoring' command must be run on the Master Aggregator of the cluster you want to store monitoring data in (the Metrics cluster).
The Metrics cluster may be the same as the Source cluster.
The 'memsql-admin configure-monitoring' command must be run on the Master Aggregator of the Source (monitored) cluster before running the current command.
Running the 'memsql-admin configure-monitoring' command in succession will recreate pipelines each time.
Usage:
memsql-admin start-monitoring [flags]
Flags:
--batch-interval MILLISECONDS Time interval between data collections in milliseconds (default 15000)
--database-name string Monitoring database name (default "metrics")
--exporter-host string Host where memsql_exporter is run (on the Source cluster)
--exporter-port PORT Port where memsql_exporter is run (on the Source cluster) (default 9104)
-h, --help Help for start-monitoring
--high-cardinality-metrics Collect high cardinality metrics. It is recommended to set --batch-interval to at least 60000 if high-cardinality-metrics is enabled
--monitoring-version string Version of the cluster running monitoring
--password string SQL password for connecting to SingleStore DB (on the Metrics cluster)
--retention-period DAYS Period of time to retain monitoring data. Applicable to all pipelines (default 7)
--sample-queries Sample queries
--user string SQL user for connecting to SingleStore DB (on the Metrics cluster) (default "root")
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.