Capture Diagnostic Report on Application Shutdown
Posted by Jeyram Sachchithananthan, Last modified by Aly Essa on 15 June 2021 10:35 AM

Overview


The diagnostic report collects logs, reports, Java virtual machine heap and configurations of your FileCatalyst application. This information is extremely useful to FileCatalyst engineers for analysis and troubleshooting. The information is assembled into a zip archive under the diagnostics subfolder of your application's installation directory, from where it can be forwarded to the FileCatalyst Support team. The diagnostics archive will be stored in the diagnostics folder with a filename similar to "FileCatalyst<product>_<YYYY-MM-DD-HH-MM-SS>_diagnostics.zip."

When the application UI becomes unresponsive or a specific behaviour creates a crash report the diagnostic report can not be triggered using the UI. Instead, you can configure your application to capture a diagnostic when a shutdown or application termination signal is observed or recorded.


Environment


FileCatalyst Server v3.7.3 and newer

FileCatalyst HotFolder v3.7.3 and newer
FileCatalyst TransferAgent v3.7.3 and newer
FileCatalyst Central v3.7.3 and newer

Resolution


System Properties are only visible and available when the advanced feature has been enabled. Do not enable these settings unless specified by a FileCatalyst Technician. 

Note: Application restart is necessary for these values to take effect. The system properties are case-sensitive. 

FileCatalyst Server

  1. Enable Advanced View
    • Launch the Server Remote Admin GUI.
    • Select the Actions menu from the top menu bar.
    • Navigate to and select the Advanced View.
      This action enables advanced features such as System Properties.

       

  2. Add System Property
    • From the left menu bar select Advanced.
    • Navigate to System Properties tab.
    • Select Add Property.
    • Property Name: unlimited.fc.diagnostics.captureHeapOnShutdown
    • Value: true
      Note: The system properties are case-sensitive.




FileCatalyst HotFolder

  1. Enable Advanced view features and System Properties 
    • Launch the HotFolder Remote Admin GUI
    • Select the Settings menu.
    • Navigate to Miscellaneous.
    • Select the option Enable Advanced View.
    • Apply the changes.



  2. Add the system property to capture diagnostics on shutdown
    • From the left menu bar select Advanced.
    • Navigate to the System Properties tab.
    • Select Add Property.
    • Property Name: unlimited.fc.diagnostics.captureHeapOnShutdown
    • Value: true
      Note: The system properties are case-sensitive



FileCatalyst Central

  1. Login to your FileCatalyst Central web portal via an admin user with a "Full Admin" access role.
  2. From the Server Configuration pane navigate to the System Properties.
  3. Select the Add System Property.
  4. Property Name: unlimited.fc.diagnostics.captureHeapOnShutdown
  5. Property Value: true
    Note: The system properties are case-sensitive.


Comments (0)