1
by James Page
Import upstream version 5.6.15 |
1 |
'\" t
|
2 |
.\" Title: \fBndb_error_reporter\fR |
|
3 |
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] |
|
4 |
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
|
1.2.6
by Marc Deslauriers
Import upstream version 5.6.25 |
5 |
.\" Date: 05/05/2015 |
1
by James Page
Import upstream version 5.6.15 |
6 |
.\" Manual: MySQL Database System |
7 |
.\" Source: MySQL 5.6 |
|
8 |
.\" Language: English |
|
9 |
.\" |
|
1.2.6
by Marc Deslauriers
Import upstream version 5.6.25 |
10 |
.TH "\FBNDB_ERROR_REPORTE" "1" "05/05/2015" "MySQL 5\&.6" "MySQL Database System" |
1
by James Page
Import upstream version 5.6.15 |
11 |
.\" ----------------------------------------------------------------- |
12 |
.\" * Define some portability stuff |
|
13 |
.\" ----------------------------------------------------------------- |
|
14 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
.\" http://bugs.debian.org/507673 |
|
16 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
.ie \n(.g .ds Aq \(aq |
|
19 |
.el .ds Aq ' |
|
20 |
.\" ----------------------------------------------------------------- |
|
21 |
.\" * set default formatting |
|
22 |
.\" ----------------------------------------------------------------- |
|
23 |
.\" disable hyphenation |
|
24 |
.nh
|
|
25 |
.\" disable justification (adjust text to left margin only) |
|
26 |
.ad l |
|
27 |
.\" ----------------------------------------------------------------- |
|
28 |
.\" * MAIN CONTENT STARTS HERE * |
|
29 |
.\" ----------------------------------------------------------------- |
|
30 |
.\" ndb_error_reporter |
|
31 |
.\" bugs: MySQL Cluster: reporting |
|
32 |
.SH "NAME" |
|
33 |
ndb_error_reporter \- NDB error\-reporting utility |
|
34 |
.SH "SYNOPSIS" |
|
35 |
.HP \w'\fBndb_error_reporter\ \fR\fB\fIoptions\fR\fR\ 'u |
|
36 |
\fBndb_error_reporter \fR\fB\fIoptions\fR\fR |
|
37 |
.SH "DESCRIPTION" |
|
38 |
.PP
|
|
39 |
\fBndb_error_reporter\fR |
|
40 |
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\&.
|
|
41 |
\fIIt is highly recommended that you make use of this utility when filing reports of bugs in MySQL Cluster\fR\&. |
|
42 |
.PP
|
|
43 |
The following table includes command options specific to the MySQL Cluster program |
|
44 |
\fBndb_error_reporter\fR\&. Additional descriptions follow the table\&. For options common to most MySQL Cluster programs (including |
|
45 |
\fBndb_error_reporter\fR), see |
|
46 |
Options Common to MySQL Cluster Programs(1)\&.
|
|
47 |
.PP
|
|
48 |
\fBndb_error_reporter\fR |
|
49 |
did not support the |
|
50 |
\fB\-\-help\fR |
|
51 |
option prior to MySQL Cluster NDB 7\&.3\&.3 (Bug #11756666, Bug #48606)\&. The |
|
1.2.1
by James Page
Import upstream version 5.6.16 |
52 |
\fB\-\-connection\-timeout\fR |
53 |
\fB\-\-dry\-scp\fR, and |
|
1
by James Page
Import upstream version 5.6.15 |
54 |
\fB\-\-skip\-nodegroup\fR |
55 |
options were also added in this release (Bug #16602002)\&.
|
|
56 |
.sp
|
|
57 |
.it 1 an-trap |
|
58 |
.nr an-no-space-flag 1 |
|
59 |
.nr an-break-flag 1 |
|
60 |
.br
|
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
61 |
.B Table\ \&18.88.\ \& This table describes command-line options for the ndb_error_reporter program |
1
by James Page
Import upstream version 5.6.15 |
62 |
.TS
|
63 |
allbox tab(:); |
|
64 |
lB lB lB. |
|
65 |
T{ |
|
66 |
Format |
|
67 |
T}:T{ |
|
68 |
Description |
|
69 |
T}:T{ |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
70 |
Added or Removed |
1
by James Page
Import upstream version 5.6.15 |
71 |
T} |
72 |
.T& |
|
73 |
l l l |
|
74 |
l l l |
|
75 |
l l l |
|
76 |
l l l. |
|
77 |
T{ |
|
78 |
.PP
|
|
79 |
--connection-timeout=timeout |
|
80 |
T}:T{ |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
81 |
Number of seconds to wait when connecting to nodes before timing |
82 |
out. |
|
1
by James Page
Import upstream version 5.6.15 |
83 |
T}:T{ |
84 |
.PP
|
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
85 |
ADDED: NDB 7.3.3 |
1
by James Page
Import upstream version 5.6.15 |
86 |
T} |
87 |
T{ |
|
88 |
.PP
|
|
89 |
--dry-scp |
|
90 |
T}:T{ |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
91 |
Disable scp with remote hosts; used only for testing. |
1
by James Page
Import upstream version 5.6.15 |
92 |
T}:T{ |
93 |
.PP
|
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
94 |
ADDED: NDB 7.3.3 |
1
by James Page
Import upstream version 5.6.15 |
95 |
T} |
96 |
T{ |
|
97 |
.PP
|
|
98 |
--fs |
|
99 |
T}:T{ |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
100 |
Include file system data in error report; can use a large amount |
101 |
of disk space |
|
1
by James Page
Import upstream version 5.6.15 |
102 |
T}:T{ |
103 |
.PP
|
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
104 |
All MySQL 5.6 based releases |
1
by James Page
Import upstream version 5.6.15 |
105 |
T} |
106 |
T{ |
|
107 |
.PP
|
|
108 |
--skip-nodegroup=nodegroup_id |
|
109 |
T}:T{ |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
110 |
Skip all nodes in the node group having this ID. |
1
by James Page
Import upstream version 5.6.15 |
111 |
T}:T{ |
112 |
.PP
|
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
113 |
ADDED: NDB 7.3.3 |
1
by James Page
Import upstream version 5.6.15 |
114 |
T} |
115 |
.TE
|
|
116 |
.sp 1 |
|
1.2.3
by James Page
Import upstream version 5.6.19 |
117 |
Usage |
1
by James Page
Import upstream version 5.6.15 |
118 |
.sp
|
119 |
.if n \{\ |
|
120 |
.RS 4 |
|
121 |
.\}
|
|
122 |
.nf
|
|
123 |
ndb_error_reporter \fIpath/to/config\-file\fR [\fIusername\fR] [\fIoptions\fR] |
|
124 |
.fi
|
|
125 |
.if n \{\ |
|
126 |
.RE
|
|
127 |
.\}
|
|
128 |
.PP
|
|
129 |
This utility is intended for use on a management node host, and requires the path to the management host configuration file (usually named |
|
130 |
config\&.ini)\&. Optionally, you can supply the name of a user that is able to access the cluster\*(Aqs data nodes using SSH, to copy the data node log files\&. |
|
131 |
\fBndb_error_reporter\fR |
|
132 |
then includes all of these files in archive that is created in the same directory in which it is run\&. The archive is named
|
|
133 |
ndb_error_report_\fIYYYYMMDDHHMMSS\fR\&.tar\&.bz2, where |
|
134 |
\fIYYYYMMDDHHMMSS\fR |
|
135 |
is a datetime string\&.
|
|
136 |
.PP
|
|
1.2.1
by James Page
Import upstream version 5.6.16 |
137 |
.\" ndb_error_reporter: options |
138 |
\fBndb_error_reporter\fR |
|
1
by James Page
Import upstream version 5.6.15 |
139 |
also accepts the options listed here: |
140 |
.sp
|
|
141 |
.RS 4 |
|
142 |
.ie n \{\ |
|
143 |
\h'-04'\(bu\h'+03'\c |
|
144 |
.\}
|
|
145 |
.el \{\ |
|
146 |
.sp -1 |
|
147 |
.IP \(bu 2.3 |
|
148 |
.\} |
|
1.2.1
by James Page
Import upstream version 5.6.16 |
149 |
.\" connection-timeout option (ndb_error_reporter) |
150 |
\fB\-\-connection\-timeout=\fR\fB\fItimeout\fR\fR |
|
1
by James Page
Import upstream version 5.6.15 |
151 |
.TS
|
152 |
allbox tab(:); |
|
153 |
l l s s |
|
154 |
l l s s |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
155 |
l l l s |
1
by James Page
Import upstream version 5.6.15 |
156 |
^ l l s. |
157 |
T{ |
|
158 |
\fBIntroduced\fR |
|
159 |
T}:T{ |
|
160 |
5\&.6\&.14\-ndb\-7\&.3\&.3 |
|
161 |
T} |
|
162 |
T{ |
|
163 |
\fBCommand\-Line Format\fR |
|
164 |
T}:T{ |
|
165 |
\-\-connection\-timeout=timeout |
|
166 |
T} |
|
167 |
T{ |
|
168 |
\fBPermitted Values\fR |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
169 |
T}:T{ |
1
by James Page
Import upstream version 5.6.15 |
170 |
\fBType\fR |
171 |
T}:T{ |
|
172 |
integer |
|
173 |
T} |
|
174 |
:T{ |
|
175 |
\fBDefault\fR |
|
176 |
T}:T{ |
|
177 |
0 |
|
178 |
T} |
|
179 |
.TE
|
|
180 |
.sp 1 |
|
181 |
Wait this many seconds when trying to connect to nodes before timing out\&.
|
|
182 |
.RE
|
|
183 |
.sp
|
|
184 |
.RS 4 |
|
185 |
.ie n \{\ |
|
186 |
\h'-04'\(bu\h'+03'\c |
|
187 |
.\}
|
|
188 |
.el \{\ |
|
189 |
.sp -1 |
|
190 |
.IP \(bu 2.3 |
|
191 |
.\} |
|
1.2.1
by James Page
Import upstream version 5.6.16 |
192 |
.\" dry-scp option (ndb_error_reporter) |
193 |
\fB\-\-dry\-scp\fR |
|
1
by James Page
Import upstream version 5.6.15 |
194 |
.TS
|
195 |
allbox tab(:); |
|
196 |
l l s s |
|
197 |
l l s s |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
198 |
l l l s |
1
by James Page
Import upstream version 5.6.15 |
199 |
^ l l s. |
200 |
T{ |
|
201 |
\fBIntroduced\fR |
|
202 |
T}:T{ |
|
203 |
5\&.6\&.14\-ndb\-7\&.3\&.3 |
|
204 |
T} |
|
205 |
T{ |
|
206 |
\fBCommand\-Line Format\fR |
|
207 |
T}:T{ |
|
208 |
\-\-dry\-scp |
|
209 |
T} |
|
210 |
T{ |
|
211 |
\fBPermitted Values\fR |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
212 |
T}:T{ |
1
by James Page
Import upstream version 5.6.15 |
213 |
\fBType\fR |
214 |
T}:T{ |
|
215 |
boolean |
|
216 |
T} |
|
217 |
:T{ |
|
218 |
\fBDefault\fR |
|
219 |
T}:T{ |
|
220 |
TRUE |
|
221 |
T} |
|
222 |
.TE
|
|
223 |
.sp 1 |
|
224 |
Run |
|
225 |
\fBndb_error_reporter\fR |
|
226 |
without using scp from remote hosts\&. Used for testing only\&. |
|
227 |
.RE
|
|
228 |
.sp
|
|
229 |
.RS 4 |
|
230 |
.ie n \{\ |
|
231 |
\h'-04'\(bu\h'+03'\c |
|
232 |
.\}
|
|
233 |
.el \{\ |
|
234 |
.sp -1 |
|
235 |
.IP \(bu 2.3 |
|
236 |
.\} |
|
1.2.1
by James Page
Import upstream version 5.6.16 |
237 |
.\" fs option (ndb_error_reporter) |
238 |
\fB\-\-fs\fR |
|
1
by James Page
Import upstream version 5.6.15 |
239 |
.TS
|
240 |
allbox tab(:); |
|
241 |
l l s s |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
242 |
l l l s |
1
by James Page
Import upstream version 5.6.15 |
243 |
^ l l s. |
244 |
T{ |
|
245 |
\fBCommand\-Line Format\fR |
|
246 |
T}:T{ |
|
247 |
\-\-fs
|
|
248 |
T} |
|
249 |
T{ |
|
250 |
\fBPermitted Values\fR |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
251 |
T}:T{ |
1
by James Page
Import upstream version 5.6.15 |
252 |
\fBType\fR |
253 |
T}:T{ |
|
254 |
boolean |
|
255 |
T} |
|
256 |
:T{ |
|
257 |
\fBDefault\fR |
|
258 |
T}:T{ |
|
259 |
FALSE |
|
260 |
T} |
|
261 |
.TE
|
|
262 |
.sp 1 |
|
263 |
Copy the data node file systems to the management host and include them in the archive\&.
|
|
264 |
.sp
|
|
265 |
Because data node file systems can be extremely large, even after being compressed, we ask that you please do |
|
266 |
\fInot\fR |
|
267 |
send archives created using this option to Oracle unless you are specifically requested to do so\&.
|
|
268 |
.RE
|
|
269 |
.sp
|
|
270 |
.RS 4 |
|
271 |
.ie n \{\ |
|
272 |
\h'-04'\(bu\h'+03'\c |
|
273 |
.\}
|
|
274 |
.el \{\ |
|
275 |
.sp -1 |
|
276 |
.IP \(bu 2.3 |
|
277 |
.\} |
|
1.2.1
by James Page
Import upstream version 5.6.16 |
278 |
.\" skip-nodegroup option (ndb_error_reporter) |
279 |
\fB\-\-skip\-nodegroup=\fR\fB\fInodegroup_id\fR\fR |
|
1
by James Page
Import upstream version 5.6.15 |
280 |
.TS
|
281 |
allbox tab(:); |
|
282 |
l l s s |
|
283 |
l l s s |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
284 |
l l l s |
1
by James Page
Import upstream version 5.6.15 |
285 |
^ l l s. |
286 |
T{ |
|
287 |
\fBIntroduced\fR |
|
288 |
T}:T{ |
|
289 |
5\&.6\&.14\-ndb\-7\&.3\&.3 |
|
290 |
T} |
|
291 |
T{ |
|
292 |
\fBCommand\-Line Format\fR |
|
293 |
T}:T{ |
|
294 |
\-\-connection\-timeout=timeout |
|
295 |
T} |
|
296 |
T{ |
|
297 |
\fBPermitted Values\fR |
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
298 |
T}:T{ |
1
by James Page
Import upstream version 5.6.15 |
299 |
\fBType\fR |
300 |
T}:T{ |
|
301 |
integer |
|
302 |
T} |
|
303 |
:T{ |
|
304 |
\fBDefault\fR |
|
305 |
T}:T{ |
|
306 |
0 |
|
307 |
T} |
|
308 |
.TE
|
|
309 |
.sp 1 |
|
310 |
Skip all nodes belong to the node group having the supplied node group ID\&.
|
|
311 |
.RE
|
|
312 |
.SH "COPYRIGHT" |
|
313 |
.br
|
|
314 |
.PP
|
|
1.2.4
by Robie Basak
Import upstream version 5.6.23 |
315 |
Copyright \(co 1997, 2015, Oracle and/or its affiliates. All rights reserved.
|
1
by James Page
Import upstream version 5.6.15 |
316 |
.PP
|
317 |
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. |
|
318 |
.PP
|
|
319 |
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
|
320 |
.PP
|
|
321 |
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. |
|
322 |
.sp
|
|
323 |
.SH "SEE ALSO" |
|
324 |
For more information, please refer to the MySQL Reference Manual, |
|
325 |
which may already be installed locally and which is also available |
|
326 |
online at http://dev.mysql.com/doc/. |
|
327 |
.SH AUTHOR |
|
328 |
Oracle Corporation (http://dev.mysql.com/). |