Audit Log - TrueCommerce/CloudFtpBridge GitHub Wiki
Starting with v3.0.0, files are no longer physically staged in archive folders. Instead, an audit log tracks files through each step in the transfer process.
Accessing the Log
Open the Cloud FTP Bridge admin panel in a browser and click on Audit Log in the menu.
Searching the Log
You can search for a specific file in the log by typing all or part of a file name in the search box and clicking Search. Click the red X icon to clear and reset the search.
Understanding File Stages
The log tracks each file through 10 possible stages of the transfer process. Below are the possible stages and their meaning:
Stage | Description |
---|---|
Transfer Started | The file has been discovered by the bridge and is ready to be transferred. |
Read - Started | The bridge has started to read the contents of the source file into memory. |
Read - Failed | Something went wrong while reading the source file. An error message describing the problem will be included. |
Read - Completed | The bridge has finished reading the source file and is ready to begin writing to the destination. |
Write - Started | The bridge has started writing the file contents to the destination. |
Write - Failed | Something went wrong while writing to the destination file. An error message describing the problem will be included. |
Write - Completed | The bridge has finished writing to the destination file. |
Delete Source - Started | The bridge has started the process of deleting the source file. |
Delete Source - Failed | Something went wrong while deleting the source file. This may result in the source file being copied again. We recommend setting up email alerts to be notified of this scenario. |
Delete Source - Completed | The bridge has finished deleting the source file. |
Transfer Completed | All steps of the file transfer from source to destination have completed successfully. |
Note Regarding File Identification
Because each file name is not guaranteed to be unique across runs, the log may display some confusing results if a file with the same name has been transferred more than once - particularly if it fails during one of the runs. When the log data is pulled, entries are sorted by date/time, grouped by file name, then sorted by file stage. We recommend taking note of the entry's timestamp if the stages of a file seem out of order in the log.
Log Retention
By default, log entries will be kept for 90 days before being automatically purged. To manually purge the log, stop the service (net stop TcCloudFtpBridge
), delete AuditLog.db
and AuditLog-log.db
from C:\ProgramData\TrueCommerce\PSGEngineering\CloudFtpBridge\v3
, then restart the service (net start TcCloudFtpBridge
).