git.sur5r.net Git - bacula/docs/blob - docs/manuals/en/problems/kaboom.tex

   1 \chapter{What To Do When Bacula Crashes (Kaboom)}
   2 \label{KaboomChapter}
   3 \index[general]{Kaboom!What To Do When Bacula Crashes }
   4 \index[general]{What To Do When Bacula Crashes (Kaboom) }
   5
   6 If you are running on a Linux system, and you have a set of working
   7 configuration files, it is very unlikely that {\bf Bacula} will crash. As with
   8 all software, however, it is inevitable that someday, it may crash,
   9 particularly if you are running on another operating system or using a new or
  10 unusual feature.
  11
  12 This chapter explains what you should do if one of the three {\bf Bacula}
  13 daemons (Director, File, Storage) crashes.  When we speak of crashing, we
  14 mean that the daemon terminates abnormally because of an error.  There are
  15 many cases where Bacula detects errors (such as PIPE errors) and will fail
  16 a job. These are not considered crashes.  In addition, under certain
  17 conditions, Bacula will detect a fatal in the configuration, such as
  18 lack of permission to read/write the working directory. In that case,
  19 Bacula will force itself to crash with a SEGFAULT. However, before
  20 crashing, Bacula will normally display a message indicating why.
  21 For more details, please read on.
  22
  23
  24 \section{Traceback}
  25 \index[general]{Traceback}
  26
  27 Each of the three Bacula daemons has a built-in exception handler which, in
  28 case of an error, will attempt to produce a traceback. If successful the
  29 traceback will be emailed to you.
  30
  31 For this to work, you need to ensure that a few things are setup correctly on
  32 your system:
  33
  34 \begin{enumerate}
  35 \item You must have a version of Bacula built with debug information turned
  36    on and not stripped of debugging symbols.
  37
  38 \item You must have an installed copy of {\bf gdb} (the GNU debugger),  and it
  39    must be on {\bf Bacula's} path. On some systems such as Solaris, {\bf
  40    gdb} may be replaced by {\bf dbx}.
  41
  42 \item The Bacula installed script file {\bf btraceback} must  be in the same
  43    directory as the daemon which dies, and it must  be marked as executable.
  44
  45 \item The script file {\bf btraceback.gdb} must  have the correct  path to it
  46    specified in the {\bf btraceback} file.
  47
  48 \item You must have a {\bf mail} program which is on {\bf Bacula's}  path.
  49    By default, this {\bf mail} program is set to {\bf bsmtp}, so it must
  50    be correctly configured.
  51
  52 \item If you run either the Director or Storage daemon under a non-root
  53    userid, you will most likely need to modify the {\bf btraceback} file
  54    to do something like {\bf sudo} (raise to root priority) for the
  55    call to {\bf gdb} so that it has the proper permissions to debug
  56    Bacula.
  57 \end{enumerate}
  58
  59 If all the above conditions are met, the daemon that crashes will produce a
  60 traceback report and email it to you. If the above conditions are not true,
  61 you can either run the debugger by hand as described below, or you may be able
  62 to correct the problems by editing the {\bf btraceback} file. I recommend not
  63 spending too much time on trying to get the traceback to work as it can be
  64 very difficult.
  65
  66 The changes that might be needed are to add a correct path to the {\bf gdb}
  67 program, correct the path to the {\bf btraceback.gdb} file, change the {\bf
  68 mail} program or its path, or change your email address. The key line in the
  69 {\bf btraceback} file is:
  70
  71 \begin{lstlisting}
  72 gdb -quiet -batch -x /home/kern/bacula/bin/btraceback.gdb \
  73      $1 $2 2>\&1 | bsmtp -s "Bacula traceback" your-address@xxx.com
  74 \end{lstlisting}
  75
  76 Since each daemon has the same traceback code, a single btraceback file is
  77 sufficient if you are running more than one daemon on a machine.
  78
  79 \section{Testing The Traceback}
  80 \index[general]{Traceback!Testing The }
  81 \index[general]{Testing The Traceback }
  82
  83 To "manually" test the traceback feature, you simply start {\bf Bacula} then
  84 obtain the {\bf PID} of the main daemon thread (there are multiple threads).
  85 The output produced here will look different depending on what OS and what
  86 version of the kernel you are running.
  87 Unfortunately, the output had to be split to fit on this page:
  88
  89 \begin{lstlisting}
  90 [kern@rufus kern]$ ps fax --columns 132 | grep bacula-dir
  91  2103 ?        S      0:00 /home/kern/bacula/k/src/dird/bacula-dir -c
  92                                        /home/kern/bacula/k/src/dird/dird.conf
  93  2104 ?        S      0:00  \_ /home/kern/bacula/k/src/dird/bacula-dir -c
  94                                        /home/kern/bacula/k/src/dird/dird.conf
  95  2106 ?        S      0:00      \_ /home/kern/bacula/k/src/dird/bacula-dir -c
  96                                        /home/kern/bacula/k/src/dird/dird.conf
  97  2105 ?        S      0:00      \_ /home/kern/bacula/k/src/dird/bacula-dir -c
  98                                        /home/kern/bacula/k/src/dird/dird.conf
  99 \end{lstlisting}
 100
 101 which in this case is 2103. Then while Bacula is running, you call the program
 102 giving it the path to the Bacula executable and the {\bf PID}. In this case,
 103 it is:
 104
 105 \begin{lstlisting}
 106 ./btraceback /home/kern/bacula/k/src/dird 2103
 107 \end{lstlisting}
 108
 109 It should produce an email showing you the current state of the daemon (in
 110 this case the Director), and then exit leaving {\bf Bacula} running as if
 111 nothing happened. If this is not the case, you will need to correct the
 112 problem by modifying the {\bf btraceback} script.
 113
 114 Typical problems might be that {\bf gdb} or {\bf dbx} for Solaris is not on
 115 the default path.  Fix this by specifying the full path to it in the {\bf
 116 btraceback} file.  Another common problem is that you haven't modified the
 117 script so that the {\bf bsmtp} program has an appropriate smtp server or
 118 the proper syntax for your smtp server.  If you use the {\bf mail} program
 119 and it is not on the default path, it will also fail.  On some systems, it
 120 is preferable to use {\bf Mail} rather than {\bf mail}.
 121
 122 \section{Getting A Traceback On Other Systems}
 123 \index[general]{Getting A Traceback On Other Systems}
 124 \index[general]{Systems!Getting A Traceback On Other}
 125
 126 It should be possible to produce a similar traceback on systems other than
 127 Linux, either using {\bf gdb} or some other debugger. Solaris with {\bf dbx}
 128 loaded works quite fine. On other systems, you will need to modify the {\bf
 129 btraceback} program to invoke the correct debugger, and possibly correct the
 130 {\bf btraceback.gdb} script to have appropriate commands for your debugger. If
 131 anyone succeeds in making this work with another debugger, please send us a
 132 copy of what you modified. Please keep in mind that for any debugger to
 133 work, it will most likely need to run as root, so you may need to modify
 134 the {\bf btraceback} script accordingly.
 135
 136 \label{ManuallyDebugging}
 137 \section{Manually Running Bacula Under The Debugger}
 138 \index[general]{Manually Running Bacula Under The Debugger}
 139 \index[general]{Debugger!Manually Running Bacula Under The}
 140
 141 If for some reason you cannot get the automatic traceback, or if you want to
 142 interactively examine the variable contents after a crash, you can run Bacula
 143 under the debugger. Assuming you want to run the Storage daemon under the
 144 debugger (the technique is the same for the other daemons, only the name
 145 changes), you would do the following:
 146
 147 \begin{enumerate}
 148 \item Start the Director and the File daemon. If the  Storage daemon also
 149    starts, you will need to find its PID  as shown above (ps fax | grep
 150    bacula-sd) and kill it  with a command like the following:
 151
 152 \begin{lstlisting}
 153       kill -15 PID
 154 \end{lstlisting}
 155
 156 where you replace {\bf PID} by the actual value.
 157
 158 \item At this point, the Director and the File daemon should  be running but
 159    the Storage daemon should not.
 160
 161 \item cd to the directory containing the Storage daemon
 162
 163 \item Start the Storage daemon under the debugger:
 164
 165 \begin{lstlisting}
 166     gdb ./bacula-sd
 167 \end{lstlisting}
 168
 169 \item Run the Storage daemon:
 170
 171 \begin{lstlisting}
 172      run -s -f -c ./bacula-sd.conf
 173 \end{lstlisting}
 174
 175 You may replace the {\bf ./bacula-sd.conf} with the full path  to the Storage
 176 daemon's configuration file.
 177
 178 \item At this point, Bacula will be fully operational.
 179
 180 \item In another shell command window, start the Console program  and do what
 181    is necessary to cause Bacula to die.
 182
 183 \item When Bacula crashes, the {\bf gdb} shell window will  become active and
 184    {\bf gdb} will show you the error that  occurred.
 185
 186 \item To get a general traceback of all threads, issue the following  command:
 187
 188
 189 \begin{lstlisting}
 190        thread apply all bt
 191 \end{lstlisting}
 192
 193 After that you can issue any debugging command.
 194 \end{enumerate}
 195
 196 \section{Getting Debug Output from Bacula}
 197 \index[general]{Getting Debug Output from Bacula }
 198 Each of the daemons normally has debug compiled into the program, but
 199 disabled. There are two ways to enable the debug output. One is to add the
 200 {\bf -d nnn} option on the command line when starting the debugger. The {\bf
 201 nnn} is the debug level, and generally anything between 50 and 200 is
 202 reasonable. The higher the number, the more output is produced. The output is
 203 written to standard output.
 204
 205 The second way of getting debug output is to dynamically turn it on using the
 206 Console using the {\bf setdebug} command. The full syntax of the command is:
 207
 208 \begin{lstlisting}
 209  setdebug level=nnn client=client-name storage=storage-name dir
 210 \end{lstlisting}
 211
 212 If none of the options are given, the command will prompt you. You can
 213 selectively turn on/off debugging in any or all the daemons (i.e. it is not
 214 necessary to specify all the components of the above command).