Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 41.6Mb
PDF (A4) - 41.7Mb
HTML Download (TGZ) - 9.3Mb
HTML Download (Zip) - 9.4Mb
Man Pages (TGZ) - 262.1Kb
Man Pages (Zip) - 372.2Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb
Excerpts from this Manual

MySQL 8.0 Reference Manual  /  ...  /  ndb_error_reporter — NDB Error-Reporting Utility

23.5.12 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.

Options that can be used with ndb_error_reporter are shown in the following table. Additional descriptions follow the table.

Table 23.34 Command-line options used with the program ndb_error_reporter

Format Description Added, Deprecated, or Removed

--connection-timeout=timeout

Number of seconds to wait when connecting to nodes before timing out

(Supported in all NDB releases based on MySQL 8.0)

--dry-scp

Disable scp with remote hosts; used only for testing

(Supported in all NDB releases based on MySQL 8.0)

--fs

Include file system data in error report; can use a large amount of disk space

(Supported in all NDB releases based on MySQL 8.0)

--help,

-?

Display help text and exit

(Supported in all NDB releases based on MySQL 8.0)

--skip-nodegroup=nodegroup_id

Skip all nodes in the node group having this ID

(Supported in all NDB releases based on MySQL 8.0)


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

    Command-Line Format --connection-timeout=timeout
    Type Integer
    Default Value 0

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

  • --dry-scp

    Command-Line Format --dry-scp
    Type Boolean
    Default Value TRUE

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

  • --help

    Command-Line Format --help

    Display help text and exit.

  • --fs

    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

    Command-Line Format --connection-timeout=timeout
    Type Integer
    Default Value 0

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