Table of Contents
Debug Logs Viewer
To understand what happens on your org and make your development process clearer, you have the ability to analyze Salesforce log files. To get the maximum amount of useful information from the logs, use Debug Logs Viewer. In order to start working with this functionality, you should open a log file. You can do this in different ways:
The log file will be opened in the editor. At the same time, a new temporary folder will appear in the Solution Explorer —
Miscellaneous files. All the log files that you opened in the current session of The Welkin Suite will be displayed here until you close them in the editor. Also, you can find these files in the Logs folder, which is placed in your project's folder.
All the functionality for analyzing large log files is present in Debug Logs Viewer. The log file that you opened contains the messages of different events highlighted with colors, so it's easier to skip unneeded details. And if you use the Code Map mode for the scrollbar, you are able to analyze the entire log file at a glance.
Currently, such event types are highlighted in the Debug Log Viewer:
- anonymous Execution — marked in gray color,
- callouts — marked in magenta color,
- checkpoints — marked in yellow color,
- errors — marked in red color,
- SOQL execution — marked in cyan color,
- system calls — marked in gray color,
- user debug entries — marked in lime color.
You can change the colors in the Options Menu:
Main Menu ⇒ Tools ⇒ Options… ⇒ Environment ⇒ Fonts and Colors; look for the items with the 'Apex Logs' prefix.
In the Debug Logs Viewer, the logs are displayed in both the tree view and the line view in the same window. Above the usual chronological line view, you will see all the events arranged by their relationship of dependence to one another. In addition, your current position is highlighted in the line view whenever you change it in the tree view, so you will never get lost in the logs. With the help of these features, going through the logs becomes more convenient, while you are able to find necessary information faster.
You can set the default view of the Debug Logs Viewer. This option is available from the Options Menu:
Main Menu ⇒ Tools ⇒ Options… ⇒ Text Editor ⇒ Apex Debug Log ⇒ Presentation. You can select one of the modes here:
- Expanded — all your log files are opened with the presentation of the log hierarchy only. It's suitable if you are mostly working with the hierarchy of your log file. You can see your log file itself using the Collapse or Expand buttons in the right bottom corner,
- Collapsed — the log tree view is hidden for the newly opened logs. It's useful when you need to see the log file without its hierarchy,
- Splitted — this view allows you to see the combined log and its tree view in your Log editor.
Filter Debug Log entries
You can easily select which types of log entries should be shown in the Debug Logs Viewer. To do this, click on the Filter button.
This list includes only the types, that are present in the current log file. Check the necessary types of events (or use the Select all / Select none options for quick adjusting) and click the Apply button.
You can search for the events using the filter input above the list — just start typing a name of a type. If you often use the same setting for filtering the log events, use the Apply and Make default button. All the next log files, opened in the Debug logs window during the current session, will use this filter.
NB: If you press Enter in the Filter window, this action will accomplish the Apply and Make default action. not the Apply one.
Go to source
The option Go to source easily lets you navigate to the source code right from the log file. Right click on a necessary event and select the Go to source option from the context menu. You will be navigated to the code which execution caused this event in the log file.
In this section:
This also may be useful: