DebuggingGnomeSystemTools

Differences between revisions 1 and 2
Revision 1 as of 2009-10-24 09:58:18
Size: 7528
Editor: 147
Comment: Create page
Revision 2 as of 2009-10-24 10:01:38
Size: 7529
Editor: 147
Comment: Bullet
Deletions are marked like this. Additions are marked like this.
Line 15: Line 15:
1. The console output of the tool itself, which often signals that invalid data was found by the GUI before committing that. This kind of error generally leads to an error dialog as well.
1. The logs from the backends, which are required to debug any problem that did not lead to any error being reported via the above method. To do this, you need to start the matching backend from command line before reproducing the problem.
 * The console output of the tool itself, which often signals that invalid data was found by the GUI before committing that. This kind of error generally leads to an error dialog as well.
 * The logs from the backends, which are required to debug any problem that did not lead to any error being reported via the above method. To do this, you need to start the matching backend from command line before reproducing the problem.
Line 39: Line 39:
== For Users == == For Groups ==

Debugging Central

This page is part of the debugging series — pages with debugging details for a variety of Ubuntu packages.

Introduction

The GNOME System Tools are a set of graphical tools that allow to change the system configuration regarding users and groups, time, network, network shares and background services. They are frontends communicating with privileged helper programs called the system-tools-backends, which perform the actual work.

How to file

Bugs should be reported against the gnome-system-tools package (obviously), but they may often correspond to a problem in the system-tools-backends package, or in liboobs, which is a wrapper library used by the gnome-system-tools to communicate with the backends. In-depth debugging is required to determine which of this Trinity is the real culprit.

Debugging procedure

Debugging the GNOME System Tools requires getting log information from two sources:

  • The console output of the tool itself, which often signals that invalid data was found by the GUI before committing that. This kind of error generally leads to an error dialog as well.
  • The logs from the backends, which are required to debug any problem that did not lead to any error being reported via the above method. To do this, you need to start the matching backend from command line before reproducing the problem.

Below are detailed procedures that can be used to achieve that, depending on the tool in which the problem happens.

For Users

Open 3 consoles, for example using GNOME Terminal. Run in the first one

sudo killall /usr/bin/perl; sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m UsersConfig -v &> ~/stb-users.log

and type in your password. Then run in the second console

sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m UserConfig -v &> ~/stb-user.log

typing your password as well.

Then, without stopping the above two commands, run in the third console

users-admin &> ~/users-admin.log

and reproduce the bug you want to report.

Once this is done, please attach to the report the files stb-users.log, stb-user.log, users-admin.log that you will find in your home folder. You can now stop the commands by closing the consoles and remove these files without risks.

For Groups

Open 3 consoles, for example using GNOME Terminal. Run in the first one

sudo killall /usr/bin/perl; sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m GroupsConfig -v &> ~/stb-groups.log

and type in your password. Then run in the second console

sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m GroupsConfig -v &> ~/stb-group.log

typing your password as well.

Then, without stopping the above two commands, run in the third console

users-admin &> ~/users-admin.log

and reproduce the bug you want to report.

Once this is done, please attach to the report the files stb-groups.log, stb-group.log, users-admin.log that you will find in your home folder. You can now stop the commands by closing the consoles without risks.

For Time

Open 3 consoles, for example using GNOME Terminal. Run in the first one

sudo killall /usr/bin/perl; /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m TimeConfig -v &> ~/stb-time.log

and type in your password. Then run in the second console

sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m NTPConfig -v &> ~/stb-ntp.log

typing your password as well.

Then, without stopping the above two commands, run in the third console

time-admin &> ~/time-admin.log

and reproduce the bug you want to report.

Once this is done, please attach to the report the files stb-time.log, stb-ntp.log, time-admin.log that you will find in your home folder. You can now stop the commands by closing the consoles without risks.

For Network Shares

Open 3 consoles, for example using GNOME Terminal. Run in the first one

sudo killall /usr/bin/perl; sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m SMBConfig -v &> ~/stb-smb.log

and type in your password. Then run in the second console

sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m NFSConfig -v &> ~/stb-nfs.log

typing your password as well.

Then, without stopping the above two commands, run in the third console

shares-admin &> ~/shares-admin.log

and reproduce the bug you want to report.

Once this is done, please attach to the report the files stb-smb.log, stb-nfs.log, shares-admin.log that you will find in your home folder. You can now stop the commands by closing the consoles and remove these files without risks.

For Network

Open 3 consoles, for example using GNOME Terminal. Run in the first one

sudo killall /usr/bin/perl; sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m IfacesConfig -v &> ~/stb-ifaces.log

and type in your password. Then run in the second console

sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m HostsConfig -v &> ~/stb-hosts.log

typing your password as well.

Then, without stopping the above two commands, run in the third console

network-admin &> ~/network-admin.log

and reproduce the bug you want to report.

Once this is done, please attach to the report the files stb-ifaces.log, stb-hosts.log, network-admin.log that you will find in your home folder. You can now stop the commands by closing the consoles and remove these files without risks.

For Services

Open 2 consoles, for example using GNOME Terminal. Run in the first one

sudo killall /usr/bin/perl; sudo /usr/share/system-tools-backends-2.0/scripts/SystemToolsBackends.pl -m ServicesConfig -v &> ~/stb-services.log

and type in your password.

Then, without stopping the above two commands, run in the third console

services-admin &> ~/services-admin.log

and reproduce the bug you want to report.

Once this is done, please attach to the report the files stb-services.log, services-admin.log that you will find in your home folder. You can now stop the commands by closing the consoles and remove these files without risks.

How to Triage

Bugs reporting a failure in the GUI with an error dialog being displayed should get the output of *-admin attached. This may be sufficient to understand the problem; else, full logs from the system-tools-backends may be needed (see above). If no error dialog was displayed, these logs are required anyway.

Please make sure that the bug title includes the name of the implied tool, if not add [*-admin] to the start.

Stock Reply

Thanks for your report. We need more information to understand how the bug you describe could happen. Please read the instructions at https://wiki.ubuntu.com/DebuggingGnomeSystemTools, and follow the procedure for the tool [tool name here].

How to Forward

See Bugs/Upstream/GNOME. Some bugs are handled directly in Launchpad by upstream, in this case an upstream task is opened without link to an upstream report.


CategoryBugSquad CategoryDebugging

DebuggingGnomeSystemTools (last edited 2010-01-23 10:42:32 by 85-169-122-209)