Administration & Troubleshooting
The Workbench is well-suited to point-in-time filesystem snapshots. By using such a feature, a backup of the current state of the Workbench can be saved, and restored at a later point.
Before creating a plan for backups, read this section carefully, and then consult one of the following backup strategies:
In addition to configuration files, the MongoDB instance, which contains the Workbench's database, can also be backed up via snapshots of the filesystem. However, in order to do so, some conditions must be met, especially:
To get a correct snapshot of a running mongod process, you must have journaling enabled and the journal must reside on the same logical volume as the other MongoDB data files. Without journaling enabled, there is no guarantee that the snapshot will be consistent or valid.
The recommended MongoDB installation supports this, but if you are using a different configuration, please ensure these conditions are met.
This page assumes a point-in-time snapshot tool to prevent issues of inconsistent data or database corruption. If the snapshot tool does not operate atomically, it will be necessary to disable the entire Workbench before a backup, and then re-enable it after the backup is made, and when restoring from such a backup. Note that this causes an outage for the server.
We also recommend using this process when using tools for MongoDB, such as
Because a PreEmptive Analytics Data Hub is installed on the same machine as the Workbench, it will share a RabbitMQ instance with the Workbench; any envelopes queued by either product will be preserved by the backup.
Similarly, if a PreEmptive Analytics Standalone Repository is installed on the same machine as the Workbench, these products will share the same MongoDB instance, so backing up the Workbench will also back up the contents of the Repository.
If either of these products are installed on the Workbench's machine, their configuration files will need to be backed up, and their websites and services stopped and started when disabling and enabling the server for backup and restore. The steps below list these as appropriate.
All other products, such as the PreEmptive Analytics Replayer, are not included in these steps.
During a restore, the server and its software will be offline. The amount of time the server is offline, not taking into account your particular backup tool's restore process, will be a few minutes for a full backup, or several minutes to an hour for a partial backup.
It is useful to test the restore process on a regular basis, to ensure your snapshot tool is correctly able to save and retrieve the state of the Workbench.
We also recommend backing up the source code for any Plugins you deploy.
A full backup will save the state of the host, ensuring a consistent view of the various components of the Workbench. This also preserves any changes made to the IIS configuration, local configuration files, etc., and is easier to manage. For these reasons, we recommend performing a Full Backup over a Partial Backup.
Your backup should target the following drives:
C:\ProgramData\PreEmptive Solutions\PreEmptive Analytics Data Hub\RabbitMQ Data, so the previous item captures this folder automatically in that case.)
P:\data\dbin the recommended installation.)
To restore a Full Backup:
If a Full Backup is not possible, the Workbench may be backed up in a partial state, which comes with several limitations:
Your backup should target the following locations:
C:\ProgramData\PreEmptive Solutions\PreEmptive Analytics Data Hub\RabbitMQ Data)
P:\data\dbin the recommended installation)
C:\mongodb\mongod.cfgin the recommended installation)
<Installation Folder>\config\OSMappings\default matches.json
<Installation Folder>\Windows\Computation Service\WorkbenchComputationService.exe.config
<Installation Folder>\Windows\Computation Service\NLog.config
<Data Hub Installation Folder>\DispatchService\Dispatch.config
<Data Hub Installation Folder>\DispatchService\HubDispatchService.exe.config
<Data Hub Installation Folder>\DispatchService\NLog.config
<Data Hub Installation Folder>\Web\Web.config
<Data Hub Installation Folder>\Web\NLog.config
<Standalone Repository Installation Folder>\Web.config
<Standalone Repository Installation Folder>\NLog.config
Note the following information, as it will be important when restoring:
<Installation Folder>\config\plugins). Either target the DLLs as part of the snapshot, or ensure you have the source code to rebuild them after a restore.
<Installation Folder>\config\Plugins\localand any other folder that contained Plugins.
To disable the Workbench server:
inetmgr). This will also disable other products that use IIS.
To re-enable the Workbench server after it has been disabled: