[deployment-guide/comm-rel: 291/727] added a new image, added two new section
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 12:49:03 UTC 2010
commit 2a9c945df03681ccce25605b14ee2abe1784d8c0
Author: Martin Prpic <mprpic at redhat.com>
Date: Mon Aug 9 16:47:28 2010 +0200
added a new image, added two new section
en-US/ABRT.xml | 212 ++++++++++++++++++++++++++++++++++++-----
en-US/images/ABRT-plugins.png | Bin 0 -> 72790 bytes
2 files changed, 189 insertions(+), 23 deletions(-)
---
diff --git a/en-US/ABRT.xml b/en-US/ABRT.xml
index 0445aac..2e8d83d 100644
--- a/en-US/ABRT.xml
+++ b/en-US/ABRT.xml
@@ -90,10 +90,21 @@
</section>
<section>
<title>Installing and Running ABRT</title>
- <para>By default, <application>ABRT</application> should be installed on your system, the <systemitem class="daemon">abrtd</systemitem> daemon configured to run at boot time, and <application>abrt-applet</application> is running in the Notification Area of your desktop session. You can check whether <application>ABRT</application> is installed by running:</para>
- <screen>~]$ <command>rpm -qa | grep abrt</command>
+ <para>By default, <application>ABRT</application> should be installed on your system, the <systemitem class="daemon">abrtd</systemitem> daemon configured to run at boot time, and <application>abrt-applet</application> to run in the Notification Area of your desktop session.
+ <note>
+ <title>Note: Installing the <application>ABRT</application> packages</title>
+ <para>In order to use <application>ABRT</application>, first ensure the <command>abrt-desktop</command> package is installed on your system by running, as root:
+ </para>
+ <screen>~]# <command>yum install abrt-desktop</command></screen>
+ <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para>
+ </note>
+ You can check whether <application>ABRT</application> is installed by running:</para>
+ <screen>~]$ <command>yum install abrt-desktop</command>
</screen>
<para>
+ For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.
+ </para>
+ <para>
<application>ABRT</application> is typically configured to start up at boot time. You can check that the <systemitem class="daemon">abrtd</systemitem> daemon is running by issuing the command:</para>
<screen>~]# <command>service abrtd status</command>
abrt (pid 1559) is running...</screen>
@@ -188,7 +199,7 @@ Starting abrt daemon: [ OK ]</screen>
</optional>
</term>
<listitem>
- <para>This option tells <application>ABRT</application> to run the specified plugin(s) immediately after a crash is detected and saved. For example, the <userinput>SOSreport</userinput> plugin runs the <systemitem>sosreport</systemitem> tool which adds the data collected by it to the created crash dump. You can turn this behavior off by commenting out this line. For further fine-tuning, you can add <userinput>SOSreport</userinput> (or any other specified plugin) to either the <parameter>CCpp</parameter> or <parameter>Python</parameter> options to make <application>ABRT</application> run <command>sosreport</command> (or any other specified plugin) after any C and C++ or Python applications crash, respectively. For more information on various Action and Reporter plugins, refer to TBD</para>
+ <para>This option tells <application>ABRT</application> to run the specified plugin(s) immediately after a crash is detected and saved. For example, the <userinput>SOSreport</userinput> plugin runs the <systemitem>sosreport</systemitem> tool which adds the data collected by it to the created crash dump. You can turn this behavior off by commenting out this line. For further fine-tuning, you can add <userinput>SOSreport</userinput> (or any other specified plugin) to either the <parameter>CCpp</parameter> or <parameter>Python</parameter> options to make <application>ABRT</application> run <command>sosreport</command> (or any other specified plugin) after any C and C++ or Python applications crash, respectively. For more information on various Action and Reporter plugins, refer to <xref linkend="plugins-and-sending-crash-reports"/></para>
</listitem>
</varlistentry>
</variablelist>
@@ -214,6 +225,9 @@ Starting abrt daemon: [ OK ]</screen>
</listitem>
</varlistentry>
</variablelist>
+ <para>
+ Each of these destinations' details can be specified in the corresponding <filename>plugins/*.conf</filename> file. For example, <filename>plugins/Bugzilla.conf</filename> specifies which Bugzilla URL to use (set to <ulink url="https://bugzilla.redhat.com/"/> by default), the user's login name, password for logging in to the Bugzilla site, etc. All these options can also be configured through the <command>abrt-gui</command> application (for more information on plugin configuration refer to <xref linkend="plugins-and-sending-crash-reports"/>).
+ </para>
<variablelist>
<title>[ Cron ] Section Directives</title>
<varlistentry>
@@ -237,20 +251,18 @@ Starting abrt daemon: [ OK ]</screen>
</varlistentry>
</variablelist>
</section>
- <section>
+ <section id="plugins-and-sending-crash-reports">
<title>Plugins and Sending Crash Reports</title>
- <para>The <literal>[AnalyzerActionsAndReporters]</literal> section in <filename>abrt.conf</filename> specifies which plugins are to be used to report crash data. As of version 1.0.0, the default <filename>abrt.conf</filename> contains:</para>
- <screen>
-[ AnalyzerActionsAndReporters ]
-Kerneloops = RHTSupport, Logger
-CCpp = RHTSupport, Logger
-Python = RHTSupport, Logger
-</screen>
- <para>These lines indicate that kernel oopses are to be reported to the <ulink url="kerneloops.org"/> site, and that both binary crashes and python crashes are to be reported to Bugzilla and to a local text file via the Logger plugin. Each of these destinations' details can be specified in the corresponding <filename>plugins/*.conf</filename> file. For example, <filename>plugins/Bugzilla.conf</filename> specifies which Bugzilla URL to use (set to <ulink url="https://bugzilla.redhat.com/"/> by default), the user's login name, password for logging in to the Bugzilla site, etc.</para>
+ <para>
+ <application>ABRT</application> offers a variety of analyzer plugins and reporter plugins. Each of these plugins is described in detail in the following two sections. Not all of the plugins mentioned in the following sections are installed by default. To view all available plugins, run the following command:
+ <screen>
+<command>]$ yum list all |grep abrt-plugin-*</command>
+ </screen>
+ </para>
<section id="analyzer-plugins">
<title>Analyzer Plugins</title>
<para>
- TEXT
+ These plugins serve as analyzers and crash information collectors for specific type of crashes. For example, the <application>Kerneloops</application> analyzer plugin checks for crashes in the kernel only. These plugins can be turned off and on in their corresponding configuration files placed in the <filename>/etc/abrt/plugins/</filename> directory. However, turning off one of these plugins will cause the associated crashes to not be caught by <application>ABRT</application>. The following is a list of all analyzer plugins.
</para>
<variablelist>
<title>Analyzer Plugins</title>
@@ -258,7 +270,7 @@ Python = RHTSupport, Logger
<term>Kerneloops</term>
<listitem>
<para>
- describe
+ This plugin checks for crashes in the kernel and consequently collects kernel crash information. It can be enabled/disabled in the <filename>/etc/abrt/plugins/Kerneloops.conf</filename> file.
</para>
</listitem>
</varlistentry>
@@ -266,7 +278,7 @@ Python = RHTSupport, Logger
<term>Python</term>
<listitem>
<para>
- describe
+ This plugin checks for crashes in Python programs and consequently collects the crash information. It can be enabled/disabled in the <filename>/etc/abrt/plugins/Python.conf</filename> file.
</para>
</listitem>
</varlistentry>
@@ -274,7 +286,7 @@ Python = RHTSupport, Logger
<term>CCpp</term>
<listitem>
<para>
- describe
+ This plugin checks for crashes in C and C++ programs and consequently collects the crash information. It can be enabled/disabled in the <filename>/etc/abrt/plugins/CCpp.conf</filename> file.
</para>
</listitem>
</varlistentry>
@@ -283,7 +295,7 @@ Python = RHTSupport, Logger
<section id="reporter-plugins">
<title>Reporter Plugins</title>
<para>
-
+ These are used to compile the crash data acquired by the analyzer plugins, combine the data with any user input (such as comments about the cras, reproducibility, etc.), and provide a specific output. Each of these plugins can be configured in their corresponding configuration files placed in the <filename>/etc/abrt/plugins/</filename> directory or in the <application>ABRT</application> GUI application (for more information on reporter plugin configuration in the <application>ABRT</application> GUI application, refer to <xref linkend="configuring-plugins-in-the-gui"/>).
</para>
<variablelist>
<title>Reporter Plugins</title>
@@ -291,7 +303,7 @@ Python = RHTSupport, Logger
<term>RHTSupport</term>
<listitem>
<para>
- describe
+ TBD
</para>
</listitem>
</varlistentry>
@@ -299,7 +311,7 @@ Python = RHTSupport, Logger
<term>MailX</term>
<listitem>
<para>
- describe
+ A simple reporter plugin which sends a crash report via the <application>mailx</application> utility to a specified email address.
</para>
</listitem>
</varlistentry>
@@ -307,7 +319,7 @@ Python = RHTSupport, Logger
<term>Report Uploader</term>
<listitem>
<para>
- describe
+ This plugin reports crashes into an anonymous <systemitem class="protocol">FTP</systemitem> site associated with a ticketing system.
</para>
</listitem>
</varlistentry>
@@ -315,15 +327,22 @@ Python = RHTSupport, Logger
<term>Bugzilla</term>
<listitem>
<para>
- describe
+ This plugin reports crashes into Bugzilla in the form of Bugzilla bugs.
</para>
+ <note>
+ <title>Note</title>
+ <para>
+ DO NOT USE BUGZILLA! TBD
+ </para>
+ </note>
+
</listitem>
</varlistentry>
<varlistentry>
<term>Logger</term>
<listitem>
<para>
- describe
+ A simple reporter plugin which creates a crash report and saves it to a specified file.
</para>
</listitem>
</varlistentry>
@@ -332,8 +351,155 @@ Python = RHTSupport, Logger
<section id="configuring-plugins-in-the-gui">
<title>Plugin Configuration in the GUI</title>
<para>
- TEXT
+ The system-wide plugin configuration in the <filename>/etc/abrt/plugins/*.conf</filename> configuration files may be overridden on a per-user basis.
+ Each of the plugins specified in the section above can be configured in the <application>ABRT</application> GUI application. Open the plugins menu by clicking <menuchoice><guimenu>Edit</guimenu><guisubmenu>Plugins</guisubmenu></menuchoice>. This window shows a list of all installed plugins. You can also view each of the plugins' details by selecting one and expanding the <guimenu>Plugin Details</guimenu> tab. When you click on one of the configurable plugins, the <guibutton>Configure</guibutton> button can be clicked and you will be able to configure your desired plugin. If you change any of the plugins' parameters, they are saved in the Gnome keyring and will be used in the future GUI sessions.
+ </para>
+ <note>
+ <title>Note</title>
+ <para>
+ All of the <filename>/etc/abrt/plugins/*.conf</filename> configuration files are world readable and are meant to be used as global settings. Thus, it is not advisable to store usernames, passwords or any other sensitive data in them. The per-user settings (set in the GUI application and readable by the owner of $HOME only) are stored in the Gnome keyring or can be stored in a text file in <filename>$HOME/.abrt/*.conf</filename> for use in <command>abrt-cli</command>.
+ </para>
+ </note>
+ <para>
+ The following is a list of all configuration options available for each configurable plugin in the <application>ABRT</application> GUI application.
</para>
+ <mediaobject id="mediaobj-abrt-plugins">
+ <imageobject>
+ <imagedata
+ align="center"
+ fileref="images/ABRT-plugins.png"
+ format="PNG"/>
+ </imageobject>
+ <caption>
+ <para>ABRT Plugins</para>
+ </caption>
+ </mediaobject>
+ <variablelist>
+ <title>Configurable Plugins</title>
+ <varlistentry>
+ <term>RHTSupport</term>
+ <listitem>
+ <para>
+ TBD
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>MailX</term>
+ <listitem>
+ <para>
+ In the <guilabel>MailX plugin configuration</guilabel>, you can configure the following parameters:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Subject</guilabel> — a string that appears in the <literal>Subject</literal> field of a crash report email sent by <application>mailx</application> (by default, set to <literal>"[abrt] crash report"</literal>).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Your Email</guilabel> — a string that appears in the <literal>From</literal> field of a crash report email.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Recipient's Email</guilabel> — email address of the recipient of a crash report email.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ When the <guilabel>Send Binary Data</guilabel> option is checked, the crash report email will also contain all binary files associated with the crash in an attachement. The core dump file is also sent as an attachement.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ReportUploader</term>
+ <listitem>
+ <para>
+ In the <guilabel>ReportUploader plugin configuration</guilabel>, you can configure the following parameters:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Customer</guilabel> — specifies customer's identification
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Ticket</guilabel> — specifies the Ticket ID number in a specific issue tracker that collects crash reports.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>URL</guilabel> — specifies the URL of the issue tracker used to collect crash reports
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Retry count</guilabel> — specifies the number of retries should an upload fail
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Retry delay</guilabel> — specifies the number or seconds between two retries
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ When the <guilabel>Use encryption</guilabel> option is checked, the crash report sent to the issue tracker is encrypted.
+ </para>
+ <para>
+ When the <guilabel>Upload</guilabel> option is checked, all crash reports are uploaded to the specified issue tracker. If the option is unchecked, all crash reports are saved locally.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Bugzilla</term>
+ <listitem>
+ <para>
+ In the <guilabel>Bugzilla plugin configuration</guilabel>, you can configure the following parameters:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Bugzilla URL</guilabel> — specifies the Bugzilla URL where crash dumps are sent (by default, set to <systemitem class="domainname">https://bugzilla.redhat.com</systemitem>).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Login (email)</guilabel> — user login which is used to log into Bugzilla and create a bug for a reported crash.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Password</guilabel> — password used to log into Bugzilla.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ When the <guilabel>No SSL verify</guilabel> option is checked, the <systemitem class="protocol">SSL</systemitem> protocol is not used when sending data over the network.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Logger</term>
+ <listitem>
+ <para>
+ In the <guilabel>Logger plugin configuration</guilabel>, you can configure the following parameter:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Logger file</guilabel> — specifies a file into which the crash reports are saved (by default, set to <filename>/var/log/abrt.log</filename>).
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ When the <guilabel>Append new logs</guilabel> option is checked, the Logger plugin will append new crash reports to the log file specified in the <guilabel>Logger file</guilabel> option. When unchecked, the new crash report always replaces the previous one.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
</section>
<section id="configuring-centralized-crash-collection">
diff --git a/en-US/images/ABRT-plugins.png b/en-US/images/ABRT-plugins.png
new file mode 100644
index 0000000..88c1947
Binary files /dev/null and b/en-US/images/ABRT-plugins.png differ
More information about the docs-commits
mailing list