start-monitoring-kube

Description

Start monitoring for a Kubernetes (kube) cluster. SingleStore 7.1.8 is the minimum version required to run the start-monitoring-kube command.

The start-monitoring-kube command creates a database where cluster information is stored and establishes pipelines for streaming data into it.

The start-monitoring-kube command must be run from a computer which can access the Master Aggregator node of the Metrics cluster which is running within the Kubernetes cluster.

By default, the KUBECONFIG environment variable or the ~/.kube/config file are used to discover the clusters. Use the --config-file option to specify a custom kube config to use.

If multiple SingleStore clusters are available in the provided kubeconfig, use the --namespace, --cluster-name, and/or --context options to specify the the desired cluster.

Wrap the password string in single quotes (') to avoid having the shell try to interpret any special characters included in the string.

Usage

Usage:
sdb-admin start-monitoring-kube [flags]
For flags that can accept multiple values (indicated by VALUES after the name of the flag),
separate each value with a comma.
Flags:
--batch-interval MILLISECONDS Time interval between data collections in milliseconds (default 60000)
--cluster-name string The specific cluster name of the Metrics cluster
--config-file FILE_PATH The kubeconfig file path. Leave blank if the path is stored in the KUBECONFIG env variable or in the ~/.kube/config file (ADVANCED)
--context string The specific context to switch to when a kubeconfig has multiple contexts (ADVANCED)
--database-name string Monitoring database name (default "metrics")
--disable-sample-queries Disables queries sampling
--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-kube
--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
--namespace string The Kubernetes namespace containing the Master Aggregator node of the Metrics cluster
--password string The database user's password for connecting to SingleStore (on the Metrics 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
--purge-frequency MINUTES Time between purges of expired monitoring data for a specific Source cluster (default 60)
--purge-log-retention-period DAYS Period of time to retain purge log entries (ADVANCED) (default 365)
--retention-period DAYS Period of time to retain monitoring data for a specific Source cluster (default 7)
--ssl-ca string Path to the CA certificate to use with HTTPS. When specified, pipelines will attempt to connect to the exporter via HTTPS. The certificate must exist on all hosts that contain a leaf node
--ssl-capath string Path to the directory that contains the CA certificates to use with HTTPS. When specified, pipelines will attempt to connect to the exporter on the Source cluster via HTTPS. The directory must exist on all hosts that contain a leaf node
--user string The database user for connecting to SingleStore (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 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 --yes or --json flag to override interactive behavior.

Last modified: December 15, 2023

Was this article helpful?