You are viewing an older version of this section. View current production version.
Join the SingleStore Community Today
Get expert advice, develop skills, and connect with others.

collect

Info

MemSQL Helios does not support this command.

Build a diagnostics report for the cluster.

Usage

Build a diagnostics report for the cluster

Available Collectors (some collectors are excluded by default):

+---------------------------------------+----------+----------------------------------------------------------------------------------+
|                  ID                   | EXCLUDED |                                   DESCRIPTION                                    |
+---------------------------------------+----------+----------------------------------------------------------------------------------+
| analyzeTables                         | EXCLUDED | Save column and histograms recorded on each table into a file in a JSON          |
|                                       |          | representation                                                                   |
| chronydStatus                         |          | Collects status of the `chronyd` service                                         |
| clusterTopology                       |          | Runs SHOW LEAVES, SHOW AGGREGATORS, and SHOW LEAF STATUS EXTENDED on the master  |
|                                       |          | aggregator                                                                       |
| cpuFreqInfo                           |          | Collects information about CPU frequency configuration                           |
| cpuMemoryBandwidth                    |          | Measures CPU-memory bandwidth                                                    |
| cpuThreadingInfo                      |          | Collects information about CPUs threading configuration                          |
| cpuUtilization                        |          | Records the output of `sar 1 10 -u`                                              |
| df                                    |          | Records the output of `df -h                                                     |
|                                       |          | --output=source,size,used,avail,pcent,ipcent,target`                             |
| diskBandwidth                         |          | Measures disk read/write bandwidth                                               |
| diskLatency                           |          | Records the output of `iostat -xdm 1 10`                                         |
| dmesg                                 |          | Records the output of `dmesg -T`                                                 |
| ethtool                               |          | Collects information about each network interface on the host                    |
| explainOrphanDatabases                |          | Runs EXPLAIN CLEAR ORPHAN DATABASES on the master aggregator                     |
| explainRebalancePartitions            |          | Runs EXPLAIN REBALANCE PARTITIONS for each user database                         |
| explainRestoreRedundancy              |          | Runs EXPLAIN RESTORE REDUNDANCY for each user database                           |
| free                                  |          | Records the output of `free -m`                                                  |
| hosts                                 |          | Collect information about cluster's hosts                                        |
| ifconfig                              |          | Records the output of `ifconfig`                                                 |
| informationSchemaColumnarSegments     | EXCLUDED | Collects columnstore debugging information from information_schema on the master |
|                                       |          | aggregator                                                                       |
| informationSchemaDistributedDatabases |          | Collects distributed databases names on master aggregator                        |
| informationSchemaIndexStatistics      |          | Runs SELECT * FROM information_schema.INDEX_STATISTICS on each aggregator        |
| informationSchemaMvBackupHistory      |          | Runs SELECT * FROM information_schema.MV_BACKUP_HISTORY on the master aggregator |
| informationSchemaMvEvents             |          | Runs SELECT * FROM information_schema.MV_EVENTS on the master aggregator         |
| informationSchemaMvNodes              |          | Runs SELECT * FROM information_schema.MV_NODES on the master aggregator          |
| informationSchemaMvQueries            |          | Runs SELECT * FROM information_schema.MV_QUERIES on all aggregator nodes         |
| informationSchemaMvSysinfo            |          | Collects all the MV_SYSINFO tables from information_schema master on the master  |
|                                       |          | aggregator                                                                       |
| informationSchemaPipelines            |          | Collects pipelines debugging information from information_schema on master       |
|                                       |          | aggregators                                                                      |
| informationSchemaProcesslist          |          | Records the PROCESSLIST for each MemSQL node                                     |
| informationSchemaRoutines             |          | Collects list of user-defined functions and stored procedures from               |
|                                       |          | information_schema on the master aggregator                                      |
| informationSchemaStatistics           |          | Collects information_schema.statistics on each node                              |
| informationSchemaTableStatistics      |          | Runs SELECT * FROM information_schema.TABLE_STATISTICS on each aggregator        |
| informationSchemaTables               |          | Collects table metadata from each node                                           |
| informationSchemaUserPrivileges       |          | Collects information_schema.USER_PRIVILEGES from each node                       |
| installedPermissions                  |          | Collects information about file and directory permissions on a cluster           |
| ipAddr                                |          | Records the output of `ip addr`                                                  |
| ipLink                                |          | Records the output of `ip link`                                                  |
| ipRoute                               |          | Records the output of `ip route`                                                 |
| licenseMetadata                       |          | Collects the output of `memsqlctl show-license` for every node                   |
| lsblk                                 |          | Records the output of `lsblk`                                                    |
| lsblkRota                             |          | Records the output of `lsblk -d -o rota`                                         |
| majorPageFaults                       |          | Records the output of `sar 1 10 -B`                                              |
| memoryCommitted                       |          | Records the output of `sar 1 10 -r`                                              |
| memsqlAuditlogs                       | EXCLUDED | Collects the audit logs from each MemSQL node                                    |
| memsqlBacktraces                      |          | Collects backtrace information from each node                                    |
| memsqlCommandLogs                     |          | Collects the command logs from each MemSQL node                                  |
| memsqlConfig                          |          | Collects the `memsql.cnf` from each MemSQL node                                  |
| memsqlNumaConfig                      |          | Collects the numa configuration files from each MemSQL node                      |
| memsqlPlancache                       | EXCLUDED | Copies the plancache directory from each MemSQL node                             |
| memsqlStacks                          |          | Collects stack files from each MemSQL node                                       |
| memsqlTracelogs                       |          | Collects the tracelogs from each MemSQL node                                     |
| memsqlctlInfo                         |          | Collects information about memsqlctl for every node                              |
| memsqldProcessLimits                  |          | Collects limits for all `memsqld` processes                                      |
| mount                                 |          | Records the output of `mount`                                                    |
| netstat                               |          | Records the output of `netstat -s`                                               |
| nodes                                 |          | Collects the output of `memsqlctl describe-node` for every node                  |
| numactl                               |          | Records the output of `numactl --hardware`                                       |
| partitionsStart                       |          | Collects information about each partition's start sector number                  |
| proc                                  |          | Collects diagnostic files from /proc                                             |
| procFs                                |          | Collects diagnostic files from /proc/fs                                          |
| processFiles                          |          | Collects top-level of /proc/<pid> for each SingleStore DB process                |
| ps                                    |          | Records the output of `ps aux`                                                   |
| psutil                                |          | Collects system and process information about the host                           |
| rebootTime                            |          | Records the output of `last -x reboot`                                           |
| schema                                |          | Collects database schemas from each aggregator                                   |
| securityLimits                        |          | Collects /etc/security/limits.conf                                               |
| showClusterStatus                     |          | collects cluster status by running `SHOW CLUSTER STATUS` on MA                   |
| showDatabaseStatus                    |          | Collects database status for each database, on each node                         |
| showDatabasesExtended                 |          | Runs SHOW DATABASES EXTENDED on each node                                        |
| showPartitions                        |          | Collects database partition metadata from each aggregator                        |
| showPlancache                         |          | Runs SHOW PLANCACHE on each node                                                 |
| showRebalanceStatus                   |          | Collects rebalance status for each database on the master aggregator             |
| showReplicationStatus                 |          | Runs SHOW REPLICATION STATUS on each node                                        |
| showResourcePools                     |          | Runs SHOW RESOURCE POOLS on each aggregator                                      |
| showStatusExtended                    |          | Runs SHOW STATUS EXTENDED on each node                                           |
| showTableStatus                       |          | Collects table status for each database on each aggregator                       |
| showVariables                         |          | Runs SHOW VARIABLES LIKE '%' on each node                                        |
| showWorkloadManagementStatus          |          | Runs SHOW WORKLOAD MANAGEMENT STATUS on each aggregator                          |
| shutdownTime                          |          | Records the output of `last -x shutdown`                                         |
| swapUsage                             |          | Records the output of `sar 1 10 -S`                                              |
| syncVariables                         |          | Runs query 'DUMP CLUSTER VARIABLES;' on each node in the cluster                 |
| sysctl                                |          | Records the output of `sysctl -a`                                                |
| toolboxConfig                         |          | Collects toolbox's configuration and version                                     |
| top                                   |          | Records the output of `top -b -n 1`                                              |
| transparentHugepage                   |          | Collects files from /sys/kernel/mm/transparent_hugepage                          |
| ulimit                                |          | Records the output of `sh -c ulimit -a`                                          |
| uptime                                |          | Records the output of `uptime`                                                   |
+---------------------------------------+----------+----------------------------------------------------------------------------------+


Examples:

# Run a single collector
memsql-report collect --only procFs

# Exclude specific collectors
memsql-report collect --exclude procFs --exclude securityLimits

# Include excluded collectors
memsql-report collect --include informationSchemaColumnarSegments

# Runs all included collectors by default. The --all option has been deprecated
memsql-report collect --all

# Change the amount of data collected from tracelogs to 15MB (default is 10MB)
memsql-report collect --opt memsqlTracelogs.tracelogSize=15mb

Usage:
  memsql-report collect [flags]

Flags:
      --exclude VALUES              Exclude the specified collectors
  -h, --help                        Help for collect
      --host strings                Specify host(s) to collect from (collects from all hosts by default)
      --include VALUES              Include the specified collectors
      --include-performance         Include collectors that create load on cluster (not recommended for active clusters)
      --merge-path string           The directory from which to merge reports. (ADVANCED)
      --only VALUES                 Only run the specified collectors
      --opt key=value               Specify collector options (default memsqlAuditlogs.auditLogSize=10MB,memsqlCommandLogs.commandLogSize=10MB,memsqlTracelogs.tracelogSize=10MB)
  -o, --output-path ABSOLUTE_PATH   Write the report tarball to this file path
      --remote-temp-dir string      Directory on remote host(s) to store temporary files during collection. (ADVANCED)
      --validate-env                Run collectors that do not require MemSQL installation (performance collectors included)

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.