~kim0/serverguide/serverguide-review-ch19

« back to all changes in this revision

Viewing changes to serverguide/C/reporting-bugs.xml

  • Committer: Matthew East
  • Date: 2011-05-03 07:11:18 UTC
  • Revision ID: mdke@ubuntu.com-20110503071118-081aatibsr9k2yqy
Add files from ubuntu-docs natty branch, trim to use only those necessary for serverguide

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
 
3
        "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
 
4
<!ENTITY % globalent SYSTEM "../../libs/global.ent">
 
5
%globalent;
 
6
<!ENTITY % gnome-menus-C SYSTEM "../../libs/gnome-menus-C.ent">
 
7
%gnome-menus-C;
 
8
<!ENTITY % xinclude SYSTEM "../../libs/xinclude.mod">
 
9
%xinclude;
 
10
<!ENTITY language "&EnglishAmerican;">
 
11
]>
 
12
<appendix id="serverguide-appendix" status="review">
 
13
  <title>Appendix</title>
 
14
 
 
15
  <sect1 id="reporting-bugs" status="review">
 
16
    <title>Reporting Bugs in Ubuntu Server Edition</title>
 
17
 
 
18
  <para>
 
19
  While the Ubuntu Project attempts to release software with as few
 
20
  bugs as possible, they do occur. You can help fix these bugs by
 
21
  reporting ones that you find to the project.  The Ubuntu Project
 
22
  uses <ulink url="https://launchpad.net/">Launchpad</ulink>
 
23
  to track its bug reports. In order to file a bug
 
24
  about Ubuntu Server on Launchpad, you will need to
 
25
  <ulink url="https://help.launchpad.net/YourAccount/NewAccount">create
 
26
  an account</ulink>.
 
27
  </para>
 
28
 
 
29
  <sect2 id="reporting-bugs-ubuntu-bug" status="review">
 
30
    <title>Reporting Bugs With ubuntu-bug</title>
 
31
 
 
32
    <para>
 
33
    The preferred way to report a bug is with the
 
34
    <application>ubuntu-bug</application> command. The ubuntu-bug
 
35
    tool gathers information about the system useful to developers in
 
36
    diagnosing the reported problem that will then be included in the
 
37
    bug report filed on Launchpad. Bug reports in Ubuntu need to be
 
38
    filed against a specific software package, thus the name of the
 
39
    package that the bug occurs in needs to be given to ubuntu-bug:
 
40
    </para>
 
41
 
 
42
<screen>
 
43
<command>ubuntu-bug PACKAGENAME</command>
 
44
</screen>
 
45
 
 
46
    <para>
 
47
    For example, to file a bug against the openssh-server package, you would do:
 
48
    </para>
 
49
 
 
50
<screen>
 
51
<command>ubuntu-bug openssh-server</command>
 
52
</screen>
 
53
 
 
54
    <para>
 
55
    You can specify either a binary package or the source package
 
56
    for ubuntu-bug. Again using openssh-server as an example,
 
57
    you could also generate the report against the source package
 
58
    for openssh-server, openssh:
 
59
    </para>
 
60
 
 
61
<screen>
 
62
<command>ubuntu-bug openssh</command>
 
63
</screen>
 
64
 
 
65
    <note>
 
66
    <para>
 
67
    See <xref linkend="package-management"/>
 
68
    for more information about packages in Ubuntu.
 
69
    </para>
 
70
    </note>
 
71
 
 
72
    <para>
 
73
    The ubuntu-bug command will gather information about the system in
 
74
    question, possibly including information specific to the specified
 
75
    package, and then ask you what you would like to do with collected
 
76
    information:
 
77
    </para>
 
78
 
 
79
<screen>
 
80
<command>ubuntu-bug postgresql</command>
 
81
 
 
82
*** Collecting problem information
 
83
 
 
84
The collected information can be sent to the developers to improve the
 
85
application. This might take a few minutes.
 
86
..........
 
87
 
 
88
*** Send problem report to the developers?
 
89
 
 
90
After the problem report has been sent, please fill out the form in the
 
91
automatically opened web browser.
 
92
 
 
93
What would you like to do? Your options are:
 
94
  S: Send report (1.7 KiB)
 
95
  V: View report
 
96
  K: Keep report file for sending later or copying to somewhere else
 
97
  C: Cancel
 
98
Please choose (S/V/K/C):
 
99
</screen>
 
100
 
 
101
    <para>
 
102
    The options available are:
 
103
    </para>
 
104
 
 
105
    <para>
 
106
    <itemizedlist>
 
107
      <listitem>
 
108
        <para><emphasis role="bold">Send Report</emphasis> Selecting
 
109
        Send Report submits the collected information to Launchpad as
 
110
        part of the the process of filing a bug report. You will be
 
111
        given the opportunity to describe the situation that led up to
 
112
        the occurrence of the bug.
 
113
        </para>
 
114
 
 
115
<screen>
 
116
*** Uploading problem information
 
117
 
 
118
The collected information is being sent to the bug tracking system.
 
119
This might take a few minutes.
 
120
91%
 
121
 
 
122
*** To continue, you must visit the following URL:
 
123
 
 
124
  https://bugs.launchpad.net/ubuntu/+source/postgresql-8.4/+filebug/kc6eSnTLnLxF8u0t3e56EukFeqJ?
 
125
 
 
126
You can launch a browser now, or copy this URL into a browser on another
 
127
computer.
 
128
 
 
129
Choices:
 
130
  1: Launch a browser now
 
131
  C: Cancel
 
132
Please choose (1/C):
 
133
</screen>
 
134
 
 
135
        <para>
 
136
        If you choose to start a browser, by default the text based web
 
137
        browser <application>w3m</application> will be used to finish filing
 
138
        the bug report. Alternately, you can copy the given URL to a
 
139
        currently running web browser.
 
140
        </para>
 
141
      </listitem>
 
142
 
 
143
      <listitem>
 
144
        <para>
 
145
        <emphasis role="bold">View Report</emphasis> Selecting View
 
146
        Report causes the collected information to be displayed to
 
147
        the terminal for review.
 
148
        </para>
 
149
 
 
150
<screen>
 
151
Package: postgresql 8.4.2-2
 
152
PackageArchitecture: all
 
153
Tags: lucid
 
154
ProblemType: Bug
 
155
ProcEnviron:
 
156
  LANG=en_US.UTF-8
 
157
  SHELL=/bin/bash
 
158
Uname: Linux 2.6.32-16-server x86_64
 
159
Dependencies:
 
160
  adduser 3.112ubuntu1
 
161
  base-files 5.0.0ubuntu10
 
162
  base-passwd 3.5.22
 
163
  coreutils 7.4-2ubuntu2
 
164
...
 
165
</screen>
 
166
 
 
167
        <para>
 
168
        After viewing the report, you will be brought back to the same
 
169
        menu asking what you would like to do with the report.
 
170
        </para>
 
171
      </listitem>
 
172
 
 
173
      <listitem>
 
174
        <para>
 
175
        <emphasis role="bold">Keep Report File</emphasis> Selecting Keep
 
176
        Report File causes the gathered information to be written to
 
177
        a file. This file can then be used to later file a bug report
 
178
        or transferred to a different Ubuntu system for reporting.
 
179
        To submit the report file, simply give it as an argument to
 
180
        the ubuntu-bug command:
 
181
        </para>
 
182
 
 
183
<screen>
 
184
What would you like to do? Your options are:
 
185
  S: Send report (1.7 KiB)
 
186
  V: View report
 
187
  K: Keep report file for sending later or copying to somewhere else
 
188
  C: Cancel
 
189
Please choose (S/V/K/C): <userinput>k</userinput>
 
190
Problem report file: /tmp/apport.postgresql.v4MQas.apport
 
191
 
 
192
<command>ubuntu-bug /tmp/apport.postgresql.v4MQas.apport</command>
 
193
 
 
194
*** Send problem report to the developers?
 
195
...
 
196
</screen>
 
197
      </listitem>
 
198
 
 
199
      <listitem>
 
200
        <para>
 
201
        <emphasis role="bold">Cancel</emphasis> Selecting
 
202
        Cancel causes the collected information to be discarded.
 
203
        </para>
 
204
      </listitem>
 
205
    </itemizedlist>
 
206
    </para>
 
207
  </sect2>
 
208
 
 
209
  <sect2 id="apport-crash-catching" status="review">
 
210
    <title>Reporting Application Crashes</title>
 
211
 
 
212
    <para>
 
213
    The software package that provides the ubuntu-bug utility, 
 
214
    <application>apport</application>, can be configured to trigger
 
215
    when applications crash. This is disabled by default, as capturing
 
216
    a crash can be resource intensive depending on how much memory
 
217
    the application that crashed was using as apport captures and
 
218
    processes the core dump.
 
219
    </para>
 
220
 
 
221
    <para>
 
222
    Configuring apport to capture information about
 
223
    crashing applications requires a couple of steps. First,
 
224
    <application>gdb</application> needs to be installed; it is not
 
225
    installed by default in Ubuntu Server Edition.
 
226
    </para>
 
227
 
 
228
<screen>
 
229
<command>sudo apt-get install gdb</command>
 
230
</screen>
 
231
 
 
232
    <para>
 
233
    See <xref linkend="package-management"/>
 
234
    for more information about managing packages in Ubuntu.
 
235
    </para>
 
236
 
 
237
    <para>
 
238
    Once you have ensured that gdb is installed, open the file
 
239
    <filename>/etc/default/apport</filename> in your text editor,
 
240
    and change the <emphasis>enabled</emphasis> setting to be
 
241
    <emphasis role="bold">1</emphasis> like so:
 
242
    </para>
 
243
 
 
244
<programlisting>
 
245
# set this to 0 to disable apport, or to 1 to enable it
 
246
# you can temporarily override this with
 
247
# sudo service apport start force_start=1
 
248
enabled=<userinput>1</userinput>
 
249
 
 
250
# set maximum core dump file size (default: 209715200 bytes == 200 MB)
 
251
maxsize=209715200
 
252
</programlisting>
 
253
 
 
254
    <para>
 
255
    Once you have completed editing
 
256
    <filename>/etc/default/apport</filename>,
 
257
    start the apport service:
 
258
    </para>
 
259
 
 
260
<screen>
 
261
<command>sudo start apport</command>
 
262
</screen>
 
263
 
 
264
    <para>
 
265
    After an application crashes, use the
 
266
    <application>apport-cli</application> command to search for the
 
267
    existing saved crash report information:
 
268
    </para>
 
269
 
 
270
<screen>
 
271
<command>apport-cli</command>
 
272
 
 
273
*** dash closed unexpectedly on 2010-03-11 at 21:40:59.
 
274
 
 
275
If you were not doing anything confidential (entering passwords or other
 
276
private information), you can help to improve the application by
 
277
reporting
 
278
the problem.
 
279
 
 
280
What would you like to do? Your options are:
 
281
  R: Report Problem...
 
282
  I: Cancel and ignore future crashes of this program version
 
283
  C: Cancel
 
284
Please choose (R/I/C):
 
285
</screen>
 
286
 
 
287
    <para>
 
288
    Selecting <emphasis>Report Problem</emphasis> will walk you through
 
289
    similar steps as when using ubuntu-bug. One important difference
 
290
    is that a crash report will be marked as private when filed on
 
291
    Launchpad, meaning that it will be visible to only a limited set
 
292
    of bug triagers. These triagers will review the gathered data for private
 
293
    information before making the bug report publicly visible.
 
294
    </para>
 
295
 
 
296
    <!-- Include a bit here on using apport-retrace for generating a
 
297
         full stack trace locally, for situations when the application
 
298
         does contain confidential information that should not be
 
299
         submitted to launchpad? -->
 
300
 
 
301
  </sect2>
 
302
 
 
303
  <sect2 id="reporting-bugs-resources" status="review">
 
304
    <title>Resources</title>
 
305
    <itemizedlist>
 
306
      <listitem>
 
307
        <para>
 
308
        See the <ulink url="https://help.ubuntu.com/community/ReportingBugs">Reporting
 
309
        Bugs</ulink> Ubuntu wiki page.
 
310
        </para>
 
311
      </listitem>
 
312
      <listitem>
 
313
        <para>
 
314
            Also, the <ulink url="https://wiki.ubuntu.com/Apport">Apport</ulink> page has some useful information.  Though some
 
315
        of it pertains to using a GUI.
 
316
        </para>
 
317
      </listitem>
 
318
    </itemizedlist>
 
319
  </sect2>
 
320
  </sect1>
 
321
</appendix>