READynamic

Changing the “Heartbeat” value to limit network message traffic

READynamic is designed to collect detailed information about the user experience for later analysis, such as the name of any book a user reads, the number of pages read, and the page where the user was last reading. Whenever an eBook is opened and read in READynamic, the system sends the server messages about the user’s reading session at regular intervals.

By default these messages, called “heartbeat” messages, are sent every ten seconds. But if your READynamic environment has hundreds or even thousands of users, these heartbeat messages can create a lot of server traffic and slow down performance on your network. You might want to reduce the number of messages sent by increasing the interval between each message.

You can configure the heartbeat message timer to any value you want, up to five minutes, by changing a setting in the server_configuration_overrides.yml file.

Look in the “JS client features” settings of this configuration file, the JavaScript section. The Heartbeat monitor is run using JavaScript in the client.

# JS client features
features:
  heartbeat_enabled: true
  heartbeat_poll_rate: 300000 # 300000 milliseconds is 5 minutes

Enter the time period in milliseconds.  In this example the poll rate is set to five minutes, 300 seconds times 1000.