Enable Backup debug and protocol logging

During Backup and Recovery issue investigations, it may be beneficial to enable debug and protocol logging for Backup Manager in order to pinpoint any faults.

To enable Backup debug and protocol logging

  1. Stop the Backup Service Controller service within Windows Services Console.
  2. Locate config.ini file:

    3. File location depends on operating system:

    • Windows: C:\Program Files\Backup Manager\config.ini
    • Windows (64bit): C:\Program Files (x86)\Backup Manager\config.ini
    • macOS: /Library/Application Support/MXB/Backup Manager
    • Linux: /opt/MXB/etc/config.ini
  3. Edit config.ini to add the following to the end of the file:

    4. [Logging]

    LoggingLevel=Debug

    SingleLogMaxSizeInMb=100

    TotalLogsMaxSizeInMb=2000

    The last two lines prevent log files from filling the hard drive. In some instances, to gather sufficient logging you may need to increase the limit of total logs to ensure all necessary data is captured.

  4. Create a directory name BackupFP.Protocol in the operating system specific location (listed below):
    • Windows: C:\ProgramData\Managed Online Backup\Backup Manager\logs\
    • macOS: /Library/Application Support/MXB/logs/
    • Linux: /opt/MXB/var/log/
  5. Start the Backup Service Controller service within Windows Services Console.

    6. Changes will not take place until the service is restarted.

You can now replicate the issue being investigated as needed with the extra logging now configured.

The logs can be viewed or provided to the N-able support team as part of a support case:

  • Windows: C:\ProgramData\Managed Online Backup\Backup Manager\logs
  • macOS: /Library/Application Support/MXB/logs
  • Linux: /opt/MXB/var/log

Disable Backup debug and protocol logging

When your need for extra logging has ended, revert the changes made that enabled the extra logging:

  1. Stop the Backup Service Controller service within Windows Services Console.
  2. Locate config.ini file:

    3. File location depends on operating system:

    • Windows (32bit): C:\Program Files\Backup Manager\config.ini
    • Windows (64bit): C:\Program Files (x86)\Backup Manager\config.ini
    • macOS: /Library/Application Support/MXB/Backup Manager
    • Linux: /opt/MXB/etc/config.ini
  3. Edit config.ini to remove the following from the file:

    4. [Logging]

    LoggingLevel=Debug

    SingleLogMaxSizeInMb=100

    TotalLogsMaxSizeInMb=2000

  4. Remove the BackupFP.Protocol directory in the operating-system specific location (listed below):
    • Windows: C:\ProgramData\Managed Online Backup\Backup Manager\logs\
    • macOS: /Library/Application Support/MXB/logs/
    • Linux: /opt/MXB/var/log/
  5. Start the Backup Service Controller service within Windows Services Console.

    6. Changes will not take place until the service is restarted