Availability checks

Operations admins for on-premises DocFusion can monitor health using availability checks that are determined by checking each node where the API is running every minute. DocFusion verifies the status of the system, connectivity and storage through availability checks, which can then be used to setup heartbeat and other alerts on nodes (VM's). Currently, only Azure Monitor is supported as instrumentation. 

Availability Checks

DocFusion performs the following checks each minute on every node that has the API running:

Health

• Is the Cache Service running.
• Is the DataBroker Service running.
• Is the GeneratorFull Service running.
• Is the GeneratorLite Service running.
• Is the Workflow Service running.
• Is the DataBrokerManager Service running.
• Is the Stats Service running.
• Is IDS (Identity Services) available.

Database Connectivity

• Connection to the Control Database.
• Connection to the Stats Database.
• Connection to the Jobs Database.
• The DataBroker service's connection to the control database and each business unit database.

Storage

When checking the health of Job Storage, DocFusion varies the test method based on the type of storage being checked.

File Checking Method

To validate file storage, a connection is established to the storage location where a file is written and read back. If the contents that were written matches what was read back, the check passes, and the file is removed.

Azure Storage Checking Method

To validate Azure storage, a connection is established to the database and a record is added, then read back. If the content of those operations match, the check passes, and the record is removed. Passing this test also means that managed identity and key vault access are available (where the Azure storage is configured to use them).

Resources

• Application Insights Overview