6.13 ndb_error_reporter — NDB Error-Reporting Utility

ndb_error_reporter creates an archive from data node and management node log files that can be used to help diagnose bugs or other problems with a cluster. It is highly recommended that you make use of this utility when filing reports of bugs in NDB Cluster.

The following table includes command options specific to the NDB Cluster program ndb_error_reporter. Additional descriptions follow the table. For options common to most NDB Cluster programs (including ndb_error_reporter), see Section 6.29, “Options Common to NDB Cluster Programs — Options Common to NDB Cluster Programs”.

ndb_error_reporter did not support the --help option prior to NDB 7.3.3 (Bug #11756666, Bug #48606). The --connection-timeout --dry-scp, and --skip-nodegroup options were also added in this release (Bug #16602002).

Table 6.11 Command-line options for the ndb_error_reporter program

Format	Description	Added, Deprecated, or Removed
--connection-timeout=timeout	Number of seconds to wait when connecting to nodes before timing out.	ADDED: NDB 7.3.3
--dry-scp	Disable scp with remote hosts; used only for testing.	ADDED: NDB 7.3.3
--fs	Include file system data in error report; can use a large amount of disk space	All MySQL 5.6 based releases
--skip-nodegroup=nodegroup_id	Skip all nodes in the node group having this ID.	ADDED: NDB 7.3.3

Usage

ndb_error_reporter path/to/config-file [username] [options]

This utility is intended for use on a management node host, and requires the path to the management host configuration file (usually named config.ini). Optionally, you can supply the name of a user that is able to access the cluster's data nodes using SSH, to copy the data node log files. ndb_error_reporter then includes all of these files in archive that is created in the same directory in which it is run. The archive is named ndb_error_report_YYYYMMDDHHMMSS.tar.bz2, where YYYYMMDDHHMMSS is a datetime string.

ndb_error_reporter also accepts the options listed here:

• --connection-timeout=timeout

  Property	Value
  Command-Line Format	--connection-timeout=timeout
  Introduced	5.6.14-ndb-7.3.3
  Type	Integer
  Default Value	0

  Wait this many seconds when trying to connect to nodes before timing out.

• --dry-scp

  Property	Value
  Command-Line Format	--dry-scp
  Introduced	5.6.14-ndb-7.3.3
  Type	Boolean
  Default Value	TRUE

  Run ndb_error_reporter without using scp from remote hosts. Used for testing only.

• --fs

  Property	Value
  Command-Line Format	--fs
  Type	Boolean
  Default Value	FALSE

  Copy the data node file systems to the management host and include them in the archive.

  Because data node file systems can be extremely large, even after being compressed, we ask that you please do not send archives created using this option to Oracle unless you are specifically requested to do so.

• --skip-nodegroup=nodegroup_id

  Property	Value
  Command-Line Format	--connection-timeout=timeout
  Introduced	5.6.14-ndb-7.3.3
  Type	Integer
  Default Value	0

  Skip all nodes belong to the node group having the supplied node group ID.