In order for Sync 2.0 to be transparent to administrators, it has to provide visibility into it's operations, as well and show what was synced. Sync must also be more reliable and allow administrators a way to troubleshoot more easily into how it operates.
Because of this, it should be possible to configure sync to store information about the failures it faced, as well as provide the ability to retry a failed transaction. It should be also to store details about all messages in order to provide a more comprehensive audit of Sync operations.
Sync should provide a UI that gives an overview of the transactions and failures that happen along the way, combined with the ability to retry operations that have failed. Each failure should have
Configuration variables
| Name | Description | Default Value |
|---|---|---|
| sync.audit.persistSuccess | Whether Sync should persist successful transactions in the audit | True |
| sync.audit.persistFailure | Whether Sync should persist failed transactions in the audit | True |
Audit domain object
Each Sync transaction would create an audit entry in the table. This entry would store the state of the operations as well as the ability to identify the resource, by storing the url from the feed event.
| Field | Type | Description |
|---|---|---|
| Id | UUID | Unique id of the log entry |
| success | Boolean | Whether the operation was successful |
| timestamp | Datetime | The timestamp of the operation |
| resourceName | String | The name resource that failed, i.e. Patient or Concept |
| resourceUrl | String | The url of the resource, either local or remote |
| type | Enum, values: PUSH, PULL | Whether this was push to master or pull from master |
| error | Text | The error message message persisted by Sync. Should contain the response from the server if this was a network issue. |
The data from this table should presented to administrators in a grid, with the ability to filter it by timestamp, resource name, success/failure and type . All interaction with this audit log, both reading and writing, should be facilitated by a SyncAuditService that will also allow programmatic access to the audit log.