| 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><ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships a simple heartbeat service. Once the Guest Additions
|
|---|
| 8 | are active, the guest sends frequent heartbeat pings to the host. If the guest stops sending the heartbeat pings
|
|---|
| 9 | without properly terminating the service, the VM process will log this event in the VBox.log file. In the future
|
|---|
| 10 | it might be possible to configure dedicated actions but for now there is only a warning in the log file. </p>
|
|---|
| 11 | <p>There are two parameters to configure. The <i>heartbeat interval</i> defines the time between two heartbeat
|
|---|
| 12 | pings. The default value is 2 seconds, that is, the heartbeat service of the <ph
|
|---|
| 13 | conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions will send a heartbeat ping every two seconds.
|
|---|
| 14 | The value in nanoseconds can be configured like this: </p>
|
|---|
| 15 | <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
|
|---|
| 16 | VBoxInternal/Devices/VMMDev/0/Config/HeartbeatInterval 2000000000</pre>
|
|---|
| 17 | <p>The <i>heartbeat timeout</i> defines the time the host waits starting from the last heartbeat ping before it
|
|---|
| 18 | defines the guest as unresponsive. The default value is 2 times the heartbeat interval (4 seconds) and can be
|
|---|
| 19 | configured as following, in nanoseconds: </p>
|
|---|
| 20 | <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
|
|---|
| 21 | VBoxInternal/Devices/VMMDev/0/Config/HeartbeatTimeout 4000000000</pre>
|
|---|
| 22 | <p>If the heartbeat timeout expires, there will be a log message like <i>VMMDev: HeartBeatCheckTimer: Guest seems to
|
|---|
| 23 | be unresponsive. Last heartbeat received 5 seconds ago.</i> If another heartbeat ping arrives after this
|
|---|
| 24 | warning, there will be a log message like <i>VMMDev: GuestHeartBeat: Guest is alive.</i>
|
|---|
| 25 | </p>
|
|---|
| 26 | </body>
|
|---|
| 27 |
|
|---|
| 28 | </topic>
|
|---|
