usr.sbin/watchdogd/watchdogd.8

   1 .\" Copyright (c) 2013  iXsystems.com,
   2 .\"                     author: Alfred Perlstein <alfred@freebsd.org>
   3 .\" Copyright (c) 2004  Poul-Henning Kamp <phk@FreeBSD.org>
   4 .\" Copyright (c) 2003  Sean M. Kelly <smkelly@FreeBSD.org>
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd November 16, 2014
  31 .Dt WATCHDOGD 8
  32 .Os
  33 .Sh NAME
  34 .Nm watchdogd
  35 .Nd watchdog daemon
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl dnSw
  39 .Op Fl -debug
  40 .Op Fl -softtimeout
  41 .Op Fl -softtimeout-action Ar action
  42 .Op Fl -pretimeout Ar timeout
  43 .Op Fl -pretimeout-action Ar action
  44 .Op Fl e Ar cmd
  45 .Op Fl I Ar file
  46 .Op Fl s Ar sleep
  47 .Op Fl t Ar timeout
  48 .Op Fl T Ar script_timeout
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility interfaces with the kernel's watchdog facility to ensure
  53 that the system is in a working state.
  54 If
  55 .Nm
  56 is unable to interface with the kernel over a specific timeout,
  57 the kernel will take actions to assist in debugging or restarting the computer.
  58 .Pp
  59 If
  60 .Fl e Ar cmd
  61 is specified,
  62 .Nm
  63 will attempt to execute this command with
  64 .Xr system 3 ,
  65 and only if the command returns with a zero exit code will the
  66 watchdog be reset.
  67 If
  68 .Fl e Ar cmd
  69 is not specified, the daemon will perform a trivial file system
  70 check instead.
  71 .Pp
  72 The
  73 .Fl n
  74 argument 'dry-run' will cause watchdog not to arm the system watchdog and
  75 instead only run the watchdog function and report on failures.
  76 This is useful for developing new watchdogd scripts as the system will not
  77 reboot if there are problems with the script.
  78 .Pp
  79 The
  80 .Fl s Ar sleep
  81 argument can be used to control the sleep period between each execution
  82 of the check and defaults to 10 seconds.
  83 .Pp
  84 The
  85 .Fl t Ar timeout
  86 specifies the desired timeout period in seconds.
  87 The default timeout is 128 seconds.
  88 .Pp
  89 One possible circumstance which will cause a watchdog timeout is an interrupt
  90 storm.
  91 If this occurs,
  92 .Nm
  93 will no longer execute and thus the kernel's watchdog routines will take
  94 action after a configurable timeout.
  95 .Pp
  96 The
  97 .Fl T Ar script_timeout
  98 specifies the threshold (in seconds) at which the watchdogd will complain
  99 that its script has run for too long.
 100 If unset
 101 .Ar script_timeout
 102 defaults to the value specified by the
 103 .Fl s Ar sleep
 104 option.
 105 .Pp
 106 Upon receiving the
 107 .Dv SIGTERM
 108 or
 109 .Dv SIGINT
 110 signals,
 111 .Nm
 112 will first instruct the kernel to no longer perform watchdog checks and then
 113 will terminate.
 114 .Pp
 115 The
 116 .Nm
 117 utility recognizes the following runtime options:
 118 .Bl -tag -width 30m
 119 .It Fl I Ar file
 120 Write the process ID of the
 121 .Nm
 122 utility in the specified file.
 123 .It Fl d Fl -debug
 124 Do not fork.
 125 When this option is specified,
 126 .Nm
 127 will not fork into the background at startup.
 128 .It Fl S
 129 Do not send a message to the system logger when the watchdog command takes
 130 longer than expected to execute.
 131 The default behaviour is to log a warning via the system logger with the
 132 LOG_DAEMON facility, and to output a warning to standard error.
 133 .It Fl w
 134 Complain when the watchdog script takes too long.
 135 This flag will cause watchdogd to complain when the amount of time to
 136 execute the watchdog script exceeds the threshold of 'sleep' option.
 137 .It Fl -pretimeout Ar timeout
 138 Set a "pretimeout" watchdog.
 139 At "timeout" seconds before the watchdog will fire attempt an action.
 140 The action is set by the --pretimeout-action flag.
 141 The default is just to log a message (WD_SOFT_LOG) via
 142 .Xr log 9 .
 143 .It Fl -pretimeout-action Ar action
 144 Set the timeout action for the pretimeout.
 145 See the section
 146 .Sx Timeout Actions .
 147 .It Fl -softtimeout
 148 Instead of arming the various hardware watchdogs, only use a basic software
 149 watchdog.
 150 The default action is just to
 151 .Xr log 9
 152 a message (WD_SOFT_LOG).
 153 .It Fl -softtimeout-action Ar action
 154 Set the timeout action for the softtimeout.
 155 See the section
 156 .Sx Timeout Actions .
 157 .El
 158 .Sh Timeout Actions
 159 The following timeout actions are available via the
 160 .Fl -pretimeout-action
 161 and
 162 .Fl -softtimeout-action
 163 flags:
 164 .Bl -tag -width ".Ar printf  "
 165 .It Ar panic
 166 Call
 167 .Xr panic 9
 168 when the timeout is reached.
 169 .It Ar ddb
 170 Enter the kernel debugger via
 171 .Xr kdb_enter 9
 172 when the timeout is reached.
 173 .It Ar log
 174 Log a message using
 175 .Xr log 9
 176 when the timeout is reached.
 177 .It Ar printf
 178 call the kernel
 179 .Xr printf 9
 180 to display a message to the console and
 181 .Xr dmesg 8
 182 buffer.
 183 .El
 184 .Pp
 185 Actions can be combined in a comma separated list as so:
 186 .Ar log,printf
 187 which would both
 188 .Xr printf 9
 189 and
 190 .Xr log 9
 191 which will send messages both to
 192 .Xr dmesg 8
 193 and the kernel
 194 .Xr log 4
 195 device for
 196 .Xr syslog 8 .
 197 .Sh FILES
 198 .Bl -tag -width ".Pa /var/run/watchdogd.pid" -compact
 199 .It Pa /var/run/watchdogd.pid
 200 .El
 201 .Sh EXAMPLES
 202 .Ss Debugging watchdogd and/or your watchdog script.
 203 This is a useful recipe for debugging
 204 .Nm
 205 and your watchdog script.
 206 .Pp
 207 (Note that ^C works oddly because
 208 .Nm
 209 calls
 210 .Xr system 3
 211 so the
 212 first ^C will terminate the "sleep" command.)
 213 .Pp
 214 Explanation of options used:
 215 .Bl -enum -offset indent -compact
 216 .It
 217 Set Debug on (--debug)
 218 .It
 219 Set the watchdog to trip at 30 seconds. (-t 30)
 220 .It
 221 Use of a softtimeout:
 222 .Bl -enum -offset indent -compact -nested
 223 .It
 224 Use a softtimeout (do not arm the hardware watchdog).
 225 (--softtimeout)
 226 .It
 227 Set the softtimeout action to do both kernel
 228 .Xr printf 9
 229 and
 230 .Xr log 9
 231 when it trips.
 232 (--softtimeout-action log,printf)
 233 .El
 234 .It
 235 Use of a pre-timeout:
 236 .Bl -enum -offset indent -compact -nested
 237 .It
 238 Set a pre-timeout of 15 seconds (this will later trigger a panic/dump).
 239 (--pretimeout 15)
 240 .It
 241 Set the action to also kernel
 242 .Xr printf 9
 243 and
 244 .Xr log 9
 245 when it trips.
 246 (--pretimeout-action log,printf)
 247 .El
 248 .It
 249 Use of a script:
 250 .Bl -enum -offset indent -compact -nested
 251 .It
 252 Run "sleep 60" as a shell command that acts as the watchdog (-e 'sleep 60')
 253 .It
 254 Warn us when the script takes longer than 1 second to run (-w)
 255 .El
 256 .El
 257 .Bd -literal
 258 watchdogd --debug -t 30 \\
 259   --softtimeout --softtimeout-action log,printf \\
 260   --pretimeout 15 --pretimeout-action log,printf \\
 261   -e 'sleep 60' -w
 262 .Ed
 263 .Ss Production use of example
 264 .Bl -enum -offset indent -compact
 265 .It
 266 Set hard timeout to 120 seconds (-t 120)
 267 .It
 268 Set a panic to happen at 60 seconds (to trigger a
 269 .Xr crash 8
 270 for dump analysis):
 271 .Bl -enum -offset indent -compact -nested
 272 .It
 273 Use of pre-timeout (--pretimeout 60)
 274 .It
 275 Specify pre-timeout action (--pretimeout-action log,printf,panic )
 276 .El
 277 .It
 278 Use of a script:
 279 .Bl -enum -offset indent -compact -nested
 280 .It
 281 Run your script (-e '/path/to/your/script 60')
 282 .It
 283 Log if your script takes a longer than 15 seconds to run time. (-w -T 15)
 284 .El
 285 .El
 286 .Bd -literal
 287 watchdogd  -t 120 \\
 288   --pretimeout 60 --pretimeout-action log,printf,panic \\
 289   -e '/path/to/your/script 60' -w -T 15
 290 .Ed
 291 .Sh SEE ALSO
 292 .Xr watchdog 4 ,
 293 .Xr watchdog 8 ,
 294 .Xr watchdog 9
 295 .Sh HISTORY
 296 The
 297 .Nm
 298 utility appeared in
 299 .Fx 5.1 .
 300 .Sh AUTHORS
 301 .An -nosplit
 302 The
 303 .Nm
 304 utility and manual page were written by
 305 .An Sean Kelly Aq Mt smkelly@FreeBSD.org
 306 and
 307 .An Poul-Henning Kamp Aq Mt phk@FreeBSD.org .
 308 .Pp
 309 Some contributions made by
 310 .An Jeff Roberson Aq Mt jeff@FreeBSD.org .
 311 .Pp
 312 The pretimeout and softtimeout action system was added by
 313 .An Alfred Perlstein Aq Mt alfred@freebsd.org .