Application Logging
Applicability: Cranium, Synapse - core 0318

We apologize but sometimes there are bugs that pop-up within Cranium and Synapse. Typically, we can reproduce the bug which is essential for correcting the problem. Sometimes, a bug occurs from an interaction between Cranium or Synapse and your specific computer environment. This is when generating a function call log file can be very helpful.

The following window displays an example log file. The file contains the application's sequence of function calls.

Tip: Log only when necessary

Function call logging can result in a significant degradation in performance. Logging should only be used as a diagnostic tool when instructed by us.

Example: Begin function call logging
  1. Select the Start Logging command from the Options menu.
  2. The application activates the Start Logging File dialog.
    1
    Browse button for entering the name of the log file.
    2
    Logging Options: some function arguments may contain the names of chemicals, techniques, etc., which may be written into the log file. If you do not wish this information to be recorded, select the Private option. This will only report the characteristics of the argument, e.g., a positive number or a ten character string.
    3
    Display Options: check the "Show when done" option to display the log file once logging has ended.
  3. Pressing the dialog's Start button begins the logging activity and displays the Notification Dialog.
Example: Start the application with logging enabled
  1. Open a File Explorer window and navigate to the application folder. This is typically found at

    C:\Program Files (x86)\Molecular Knowledge Systems\Cranium

    or

    C:\Program Files (x86)\Molecular Knowledge Systems\Synapse

  2. Double-click the left mouse button on the shortcut with the "logging" suffix, i.e.,

    "Cranium - logging" or "Synapse - logging"

    The application will display the notice dialog notifying you that logging has started.

  3. Perform the tasks causing the problem. When you have completed these tasks, select the End Logging command from the Options menu.
  4. The application will save a log file to the "Documents" folder. The file's name has the form:

    MKS Log 2020-08-24-00-23-25.mkslog

    where the digits denote the date and time. Note that even if the application unexpectedly terminates during a logging session, a log file will still be written.
  5. Email the log file to Molecular Knowledge Systems for analysis.
Related Documentation