collect

Build a diagnostics report for the cluster

Usage

Available Collectors (some collectors are excluded by default):

+-----------------------------------+----------+----------------------------------------------------------------------------------+
|                ID                 | EXCLUDED |                                   DESCRIPTION                                    |
+-----------------------------------+----------+----------------------------------------------------------------------------------+
| clusterTopology                   |          | runs SHOW LEAVES, SHOW AGGREGATORS, and SHOW LEAF STATUS EXTENDED on the master  |
|                                   |          | aggregator                                                                       |
| df                                |          | records the output of `df -h`                                                    |
| dmesg                             |          | records the output of `dmesg`                                                    |
| ethtool                           |          | collects information about each network interface on the host                    |
| free                              |          | records the output of `free -m`                                                  |
| ifconfig                          |          | records the output of `ifconfig`                                                 |
| informationSchemaColumnarSegments | EXCLUDED | collects columnstore debugging information from information_schema on master     |
|                                   |          | aggregators                                                                      |
| informationSchemaIndexStatistics  |          | runs SELECT * FROM information_schema.INDEX_STATISTICS on each aggregator        |
| informationSchemaMvEvents         |          | runs SELECT * FROM information_schema.MV_EVENTS on master aggregators            |
| informationSchemaPipelines        |          | collects pipelines debugging information from information_schema on master       |
|                                   |          | aggregators                                                                      |
| informationSchemaProcesslist      |          | records the PROCESSLIST for each MemSQL node                                     |
| 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                       |
| ipAddr                            |          | records the output of `ip addr`                                                  |
| ipLink                            |          | records the output of `ip link`                                                  |
| ipRoute                           |          | records the output of `ip route`                                                 |
| lsblk                             |          | records the output of `lsblk`                                                    |
| 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                              |
| 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`                                       |
| proc                              |          | collects diagnostic files from /proc                                             |
| procFs                            |          | collects diagnostic files from /proc/fs                                          |
| ps                                |          | records the output of `ps aux`                                                   |
| psutil                            |          | collects system and process information about the host                           |
| schema                            |          | Collects database schemas from each aggregator                                   |
| securityLimits                    |          | collects /etc/security/limits.conf                                               |
| 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 master aggregators                |
| 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                          |
| sysctl                            |          | records the output of `sysctl -a`                                                |
| transparentHugepage               |          | collects files from /sys/kernel/mm/transparent_hugepage                          |
| ulimit                            |          | records the output of `sh -c ulimit -a`                                          |
+-----------------------------------+----------+----------------------------------------------------------------------------------+


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

# Run all collectors (including those excluded by default)
memsql-report collect --all

Usage:
  memsql-report collect [flags]

Flags:
      --all                         Collect everything
      --exclude VALUES              Exclude the specified collectors
  -h, --help                        help for collect
      --host stringArray            Specify host(s) to collect from
      --include VALUES              Include the specified collectors
      --only VALUES                 Only run the specified collectors
      --opt key=value               Specify collector options (default memsqlCommandLogs.commandLogSize=10mb,memsqlTracelogs.tracelogSize=10mb)
  -o, --output-path ABSOLUTE_PATH   Write the report tarball to this file path

Global Flags:
  -c, --config FILE_PATH             the Toolbox configuration file path
  -j, --json                         Enable JSON output
      --parallelism int              Maximum amount of operations to be run in parallel
      --runtime-dir DIRECTORY_PATH   where to put Toolbox runtime data
      --state-file FILE_PATH         the Toolbox state file path
  -v, --verbosity count              Increase logging verbosity
  -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 useful?