REPORT
On this page
Generate a comprehensive report that contains diagnostic information about your entire SingleStore cluster for troubleshooting purposes.
The size of the log files to be collected can be specified, as well as the SingleStore nodes from which information should be collected.
The generated report is compressed into a file called cluster-report-*.
.
Usage
usage: memsql-ops report [--settings-file SETTINGS_FILE] [--async][--tracelog-mb TRACELOG_MB] [--include-log-archives][--include-pipelines-debug-info][--exclude-system-info] [--exclude-processlist][--include-backtrace | --no-include-backtrace][--exclude-schema | --include-plancache][--memsql-ids [MEMSQL_IDS [MEMSQL_IDS ...]]][--timeout TIMEOUT]Generate a report that contains diagnostic information for MemSQL Ops.optional arguments:--settings-file SETTINGS_FILEA path to a MemSQL Ops settings.conf file. If not set,we will use the file in the same directory as theMemSQL Ops binary.--async If this option is true, we will exit without waitingfor the report to be fully built.--tracelog-mb TRACELOG_MBIf specified, we will truncate SingleStore tracelogs suchthat all of the tracelogs combined will be less thanthis size. The default value is 150.--include-log-archivesInclude the log_archives directory from each agent.--include-pipelines-debug-infoInclude some debugging information about pipelines.--exclude-system-infoIf specified, we will not include some system datathat is mostly disk related.--exclude-processlistIf specified, we will not include the process list ofrunning queries in the report.--include-backtrace If specified, we will include a SingleStore backtrace fromeach node.--no-include-backtraceIf specified, we will not include a SingleStore backtrace.--exclude-schema If specified, we will not include any informationabout SingleStore database and table schemas in the report.Consequently the plancache and process list will alsobe excluded.--include-plancache If specified, we will include SingleStore plancache filesin the report. Note that this flag cannot be used with--exclude-schema because schema information isrevealed by the plancache files.--memsql-ids [MEMSQL_IDS [MEMSQL_IDS ...]]A list of MemSQL IDs for which we will gathertracelogs. If not specified, we will gather tracelogsfor all SingleStore nodes.--timeout TIMEOUT If specified, we will wait at most this many secondsfor a report to be built for each MemSQL Ops agent.
Last modified: April 25, 2023