| blob | 14425ea73bb760099860043402f764d729c101d6 |
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.77.1 <http://docbook.sf.net/>
5 .\" Date: 11/04/2013
6 .\" Manual: MySQL Database System
7 .\" Source: MySQL 5.1
8 .\" Language: English
9 .\"
10 .TH "\FBNDB_ERROR_REPORTE" "1" "11/04/2013" "MySQL 5\&.1" "MySQL Database System"
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\fIconfig_file\fR\fR\fB\ [\fR\fB\fIuser_name\fR\fR\fB]\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
36 \fBndb_error_reporter \fR\fB\fIconfig_file\fR\fR\fB [\fR\fB\fIuser_name\fR\fR\fB] [\fR\fB\fIoptions\fR\fR\fB]\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 6\&.3\&.52, MySQL Cluster NDB 7\&.0\&.40, and MySQL Cluster NDB 7\&.1\&.29 (Bug #11756666, Bug #48606)\&. The
52 \fB\-\-connection\-timeout\fR
53 \fB\-\-dry\-scp\fR, and
54 \fB\-\-skip\-nodegroup\fR
55 options were also added in these releases (Bug #16602002)\&.
56 .sp
57 .it 1 an-trap
58 .nr an-no-space-flag 1
59 .nr an-break-flag 1
60 .br
61 .B Table\ \&17.20.\ \&ndb_error_reporter Options and Variables: MySQL 5.1, MySQL Cluster NDB 6.3-7.1
62 .TS
63 allbox tab(:);
64 lB lB lB.
65 T{
66 Format
67 T}:T{
68 Description
69 T}:T{
70 Added / Removed
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{
81 Number of seconds to wait when connecting to nodes before timing out\&.
82 T}:T{
83 .PP
84 ADDED: NDB 6\&.3\&.52, NDB 7\&.0\&.40, NDB 7\&.1\&.29
85 T}
86 T{
87 .PP
88 --dry-scp
89 T}:T{
90 Disable scp with remote hosts; used only for testing\&.
91 T}:T{
92 .PP
93 ADDED: NDB 6\&.3\&.52, NDB 7\&.0\&.40, NDB 7\&.1\&.29
94 T}
95 T{
96 .PP
97 --fs
98 T}:T{
99 Include file system data in error report; can use a large amount of disk
100 space
101 T}:T{
102 .PP
103 All MySQL 5\&.1 based releases
104 T}
105 T{
106 .PP
107 --skip-nodegroup=nodegroup_id
108 T}:T{
109 Skip all nodes in the node group having this ID\&.
110 T}:T{
111 .PP
112 ADDED: NDB 6\&.3\&.52, NDB 7\&.0\&.40, NDB 7\&.1\&.29
113 T}
114 .TE
115 .sp 1
116 Usage
117 .sp
118 .if n \{\
119 .RS 4
120 .\}
121 .nf
122 ndb_error_reporter \fIpath/to/config\-file\fR [\fIusername\fR] [\fIoptions\fR]
123 .fi
124 .if n \{\
125 .RE
126 .\}
127 .PP
128 This utility is intended for use on a management node host, and requires the path to the management host configuration file (usually named
129 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\&.
130 \fBndb_error_reporter\fR
131 then includes all of these files in archive that is created in the same directory in which it is run\&. The archive is named
132 ndb_error_report_\fIYYYYMMDDHHMMSS\fR\&.tar\&.bz2, where
133 \fIYYYYMMDDHHMMSS\fR
134 is a datetime string\&.
135 .PP
136 .\" ndb_error_reporter: options
137 \fBndb_error_reporter\fR
138 also accepts the options listed here:
139 .sp
140 .RS 4
141 .ie n \{\
142 \h'-04'\(bu\h'+03'\c
143 .\}
144 .el \{\
145 .sp -1
146 .IP \(bu 2.3
147 .\}
148 .\" connection-timeout option (ndb_error_reporter)
149 \fB\-\-connection\-timeout=\fR\fB\fItimeout\fR\fR
150 .TS
151 allbox tab(:);
152 l l s s
153 l l s s
154 l l s s
155 ^ l l s
156 ^ l l s.
157 T{
158 \fBIntroduced\fR
159 T}:T{
160 5\&.1\&.71\-ndb\-7\&.1\&.29
161 T}
162 T{
163 \fBCommand\-Line Format\fR
164 T}:T{
165 \-\-connection\-timeout=timeout
166 T}
167 T{
168 \ \&
169 T}:T{
170 \fBPermitted Values\fR
171 T}
172 :T{
173 \fBType\fR
174 T}:T{
175 integer
176 T}
177 :T{
178 \fBDefault\fR
179 T}:T{
180 0
181 T}
182 .TE
183 .sp 1
184 Wait this many seconds when trying to connect to nodes before timing out\&.
185 .RE
186 .sp
187 .RS 4
188 .ie n \{\
189 \h'-04'\(bu\h'+03'\c
190 .\}
191 .el \{\
192 .sp -1
193 .IP \(bu 2.3
194 .\}
195 .\" dry-scp option (ndb_error_reporter)
196 \fB\-\-dry\-scp\fR
197 .TS
198 allbox tab(:);
199 l l s s
200 l l s s
201 l l s s
202 ^ l l s
203 ^ l l s.
204 T{
205 \fBIntroduced\fR
206 T}:T{
207 5\&.1\&.71\-ndb\-7\&.1\&.29
208 T}
209 T{
210 \fBCommand\-Line Format\fR
211 T}:T{
212 \-\-dry\-scp
213 T}
214 T{
215 \ \&
216 T}:T{
217 \fBPermitted Values\fR
218 T}
219 :T{
220 \fBType\fR
221 T}:T{
222 boolean
223 T}
224 :T{
225 \fBDefault\fR
226 T}:T{
227 TRUE
228 T}
229 .TE
230 .sp 1
231 Run
232 \fBndb_error_reporter\fR
233 without using scp from remote hosts\&. Used for testing only\&.
234 .RE
235 .sp
236 .RS 4
237 .ie n \{\
238 \h'-04'\(bu\h'+03'\c
239 .\}
240 .el \{\
241 .sp -1
242 .IP \(bu 2.3
243 .\}
244 .\" fs option (ndb_error_reporter)
245 \fB\-\-fs\fR
246 .TS
247 allbox tab(:);
248 l l s s
249 l l s s
250 ^ l l s
251 ^ l l s.
252 T{
253 \fBCommand\-Line Format\fR
254 T}:T{
255 \-\-fs
256 T}
257 T{
258 \ \&
259 T}:T{
260 \fBPermitted Values\fR
261 T}
262 :T{
263 \fBType\fR
264 T}:T{
265 boolean
266 T}
267 :T{
268 \fBDefault\fR
269 T}:T{
270 FALSE
271 T}
272 .TE
273 .sp 1
274 Copy the data node file systems to the management host and include them in the archive\&.
275 .sp
276 Because data node file systems can be extremely large, even after being compressed, we ask that you please do
277 \fInot\fR
278 send archives created using this option to Oracle unless you are specifically requested to do so\&.
279 .RE
280 .sp
281 .RS 4
282 .ie n \{\
283 \h'-04'\(bu\h'+03'\c
284 .\}
285 .el \{\
286 .sp -1
287 .IP \(bu 2.3
288 .\}
289 .\" skip-nodegroup option (ndb_error_reporter)
290 \fB\-\-skip\-nodegroup=\fR\fB\fInodegroup_id\fR\fR
291 .TS
292 allbox tab(:);
293 l l s s
294 l l s s
295 l l s s
296 ^ l l s
297 ^ l l s.
298 T{
299 \fBIntroduced\fR
300 T}:T{
301 5\&.1\&.71\-ndb\-7\&.1\&.29
302 T}
303 T{
304 \fBCommand\-Line Format\fR
305 T}:T{
306 \-\-connection\-timeout=timeout
307 T}
308 T{
309 \ \&
310 T}:T{
311 \fBPermitted Values\fR
312 T}
313 :T{
314 \fBType\fR
315 T}:T{
316 integer
317 T}
318 :T{
319 \fBDefault\fR
320 T}:T{
321 0
322 T}
323 .TE
324 .sp 1
325 Skip all nodes belong to the node group having the supplied node group ID\&.
326 .RE
327 .SH "COPYRIGHT"
328 .br
329 .PP
330 Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved.
331 .PP
332 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.
333 .PP
334 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.
335 .PP
336 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/.
337 .sp
338 .SH "SEE ALSO"
339 For more information, please refer to the MySQL Reference Manual,
340 which may already be installed locally and which is also available
341 online at http://dev.mysql.com/doc/.
342 .SH AUTHOR
343 Oracle Corporation (http://dev.mysql.com/).