Debug Extractor Docs

This is a tool developed to extract and open debug files from Synology NAS. Read documentation for more information about setup with the text editors and how the tool works.

Requirements

• 7zip
• At least one of the following:
  • Visual Studio Code
  • Sublime Text 3

Limitations

• Visual Studio Code has to be added to PATH environment variable in order to work as per Electron limitations when using the direct executable file. (It should be added by default on VS Code instalation)
• Cannot properly open SRM debug files.
• Cannot change default extraction path (C:\tickets\).

• Debug files bigger than 400MB could freeze the program for a few seconds.

• Name given to the ticket cannot contain the following:
  • Spaces ( )
  • Double quotes (“)
  • Forward - Backward slash (/ \)
  • Greater and less signs (< >)
  • Opening - Closing question mark (¿ ?)

The basics

The functioning of this program is very simple: Extract and Open.
Now you can take advantage of some of the perks you have by using either Visual Studio Code or Sublime Text.

First of all, the logs are stored and organized by name in a custom directory, this is:

• C:\tickets\

You can give them the name you want, this being the ticket number, the description of the ticket, name of the package, etc. (See Limitations section to know what type of names you can set).

In the case that no name is set, the ticket will be stored as the current name of the debug file. If that name already exists on the tickets folder, a random token will be added at the end of the file name. Example:

• C:\tickets\debug(1)\
• C:\tickets\debug(1)_839461\
• C:\tickets\debug(1)_294607\
• …

When opening a debug file you have two options:

• Move the original debug file to the extracted directory
• Delete the original debug file

By default the file will not be deleted and it will be stored to the extraction directory.
You will also have the option to launch a browser tab/window with the office server debug analyzer tool.

To open the debug, you can choose between Visual Studio Code and Sublime Text 3.
Both of these text editor provide some useful shortcuts and functions that allow you to find and manage the logs and keywords you need to work with.
You can check the next section to take a look at what these text editors provide you.

Setup

General set up

To easily access the tool you can pin it on your task bar:

Remember to not delete the main directory were you have extracted the source .zip file.

You can pin the default folder to you Quick Access for a faster access to your debugs:

For a better organization you can sort the folders by date so you will have the more recent extracted folders on top:

In the case that you have either 7Zip, VS Code or Sublime Text 3 installed in non-default locations, you can set custom paths for them.

To do this you can go to the Settings tab on the top left of the program window:

After clicking this tab the config.yml file will open and you will be able to edit set the custom path for the programs you desire:

Please follow the instructions stated on the file itself to correctly set the paths for the program you want to use.

Visual Studio Code

Visual Studio Code extensions and configurations for better log reading:

• Setup:
  • In user setting .json file (File -> Preferences -> Settings -> Open Settings (JSON) on the top right of the screen) add this lines to support all the different files the debug.dat file contains:

    "files.associations": {
    "*log*": "log",
    "messages": "log",
    "*error*": "log"
    },
    

• Extensions:
  • Log File Highlighter
• Useful shortcuts:
  • Search keyword in all files: Ctrl + Shift + F
  • Search keyword in opened file: Ctrl + F
  • Search file: Ctrl + E or Ctrl + P

Sublime Text 3

Sublime Text 3 extensions and configurations for better log reading:

• Setup:
  • In Sublime Text preferences file add this lines into the settings json file to avoid openning 2 windows each time a debug file is open (add between the brackets):

    "hot_exit": false,
    "remember_open_files": false
    

• Useful shortcuts:
  • Search keyword in all files: Ctrl + Shift + F
  • Search keyword in opened file: Ctrl + F
  • Search file: Ctrl + P

Bug Report

You can check the daemon.log that is on the source directory of the tool, create an Issue on the repository attaching the logs and a description of the behavior.