| 1 | <?xml version='1.0' encoding='UTF-8'?>
|
|---|
| 2 | <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
|---|
| 3 | <topic xml:lang="en-us" id="heartbeatservice">
|
|---|
| 4 | <title>Configuring the Heartbeat Service</title>
|
|---|
| 5 |
|
|---|
| 6 | <body>
|
|---|
| 7 | <p>
|
|---|
| 8 | <ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships a simple heartbeat service. Once the Guest
|
|---|
| 9 | Additions are active, the guest sends frequent heartbeat pings to
|
|---|
| 10 | the host. If the guest stops sending the heartbeat pings without
|
|---|
| 11 | properly terminating the service, the VM process will log this
|
|---|
| 12 | event in the VBox.log file. In the future it might be possible to
|
|---|
| 13 | configure dedicated actions but for now there is only a warning in
|
|---|
| 14 | the log file.
|
|---|
| 15 | </p>
|
|---|
| 16 | <p>
|
|---|
| 17 | There are two parameters to configure. The <i>heartbeat
|
|---|
| 18 | interval</i> defines the time between two heartbeat pings.
|
|---|
| 19 | The default value is 2 seconds, that is, the heartbeat service of
|
|---|
| 20 | the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions will send a heartbeat ping
|
|---|
| 21 | every two seconds. The value in nanoseconds can be configured like
|
|---|
| 22 | this:
|
|---|
| 23 | </p>
|
|---|
| 24 | <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
|
|---|
| 25 | VBoxInternal/Devices/VMMDev/0/Config/HeartbeatInterval 2000000000</pre>
|
|---|
| 26 | <p>
|
|---|
| 27 | The <i>heartbeat timeout</i> defines the time the
|
|---|
| 28 | host waits starting from the last heartbeat ping before it defines
|
|---|
| 29 | the guest as unresponsive. The default value is 2 times the
|
|---|
| 30 | heartbeat interval (4 seconds) and can be configured as following,
|
|---|
| 31 | in nanoseconds:
|
|---|
| 32 | </p>
|
|---|
| 33 | <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
|
|---|
| 34 | VBoxInternal/Devices/VMMDev/0/Config/HeartbeatTimeout 4000000000</pre>
|
|---|
| 35 | <p>
|
|---|
| 36 | If the heartbeat timeout expires, there will be a log message like
|
|---|
| 37 | <i>VMMDev: HeartBeatCheckTimer: Guest seems to be
|
|---|
| 38 | unresponsive. Last heartbeat received 5 seconds ago.</i> If
|
|---|
| 39 | another heartbeat ping arrives after this warning, there will be a
|
|---|
| 40 | log message like <i>VMMDev: GuestHeartBeat: Guest is
|
|---|
| 41 | alive.</i>
|
|---|
| 42 | </p>
|
|---|
| 43 | </body>
|
|---|
| 44 |
|
|---|
| 45 | </topic>
|
|---|
