Summary
The ClinSpark Agent writes most of its interactions with local devices and ClinSpark interfaces to a local ‘log’ file for troubleshooting purposes.
When encountering an error within a given workflow, the ClinSparkAgent.log file can lend valuable insight into the processes which may be at fault. The Foundry Health support team will also frequently request this file be retrieved from local site PCs when troubleshooting issues.
...
Navigate to home (root) directory. This is typically the C: drive, and should be preceded by an “OS” as shown.
Open up the “Users” folder
Open up the current active user folder (in this example, haeuserww)
Open the AppData folder. By default, this is a hidden directory in Windows. If this folder is not displaying, click “View” on the top of the window, and check the box that says “Hidden Items.” The AppData folder should then display.
Open the Roaming folder. In the Roaming folder should be a file called ClinSparkAgent.log. The file extension may or may not display depending on configured Windows settings. Windows may default to treat this file as a text document, as represented in the screenshot.
Multiple Log Files
The Agent will write out statements to the log file up until a certain amount (usually when exceeding 100,000 lines). At some point, the current log file is ‘archived’ and a new file is started. This ensures that the log files on local PCs are of reasonable size and allow the logs to be reviewed and shared with relative ease over time.
...
When this process occurs, the archived log file will append with a numbered sequence at the end of the file name. For example:
| Code Block |
|---|
ClinSparkAgent.log.1 |
When support team members ask to review log files, it would be ideal to include all of the logs present. Otherwise, the most current log file (without and number appended in the file name) is often the most relevant file.
Log File Review Tips
Realtime Log Monitoring
Often it’s useful to reference the log file for constant review while testing certain workflows. This can give insight into what statements are being written to the log file immediately as actions are performed. Depending on the operating environment of the Agent, and the user who is accessing the log file for this kind of review, it may be helpful to consider real-time monitoring capabilities through the use of a terminal command similar to ‘tail’.
...