search

certinia / debug-log-analyzer

Salesforce Apex debug log analyzer for Visual Studio Code - Visualize code execution via a Flame chart and identify performance and SOQL/DML problems via Method and Database analysis
https://marketplace.visualstudio.com/items?itemName=financialforce.lana
BSD 3-Clause "New" or "Revised" License
84 stars 18 forks source link
analysis analyzer apex debug debuglog log performance profiler salesforce vscode

readme

Apex Log Analyzer for Salesforce

Version Download Installs Ratings

Apex Log Analyzer makes performance analysis of Salesforce debug logs much easier and quicker. Visualize code execution via a Flame chart and Call Tree, identify and resolve performance and SOQL/DML problems via Method and Database Analysis.

preview

WARNING

In general set the APEX_CODE debug flag to be FINE or higher, with a lower level the log will likely not contain enough detail for meaningful analysis.

The quality of data shown depends entirely on the data contained in the log files.\ Special care should be taken when looking at log files that have been truncated as you are only seeing a part of the execution and that may lead you to misunderstand what is really happening.

A log level of FINE seems to give a good balance between log detail and execution time.\ Higher log levels result in higher reported execution time than would be seen with logging off.\ This is due to the over head associated with logging method entry and exit.

Getting Started | Features | Settings | Explore the Docs | Contributing | Contributors | License

Getting Started

Installation

install

Search for Apex Log Analyzer from the extensions side bar in VS Code and click Install or install from the VS Code market place by clicking install on Visual Studio Code Market Place: Apex Log Analyzer

Pre-Release

Click Switch to Pre-Release Version on the banner to get bleeding edge changes and help us to resolve bugs before the stable release.

Command Pallette

Open command pallette (CMD/CTRL + Shift + P), paste ext install financialforce.lana, and press enter.

ext install financialforce.lana

Show Analysis

Start the analysis either from a log you have already downloaded or by downloading a log from an org. On larger logs the analysis window make take a few seconds to appear.

From an Open Log File

With the .log file open in VSCode.

  1. Open command pallette (CMD/CTRL + Shift + P) -> 'Log: Show Apex Log Analysis'\ or
  2. Click the 'Log: Show Apex Log Analysis' code lens at the top of the file\ show analysis lens\ or
  3. Right click -> 'Log: Show Apex Log Analysis' or
  4. Click editor 'Log: Show Apex Log Analysis' icon button at top of editor or
  5. Right click editor tab -> 'Log: Show Apex Log Analysis'

Download a log

  1. Open command pallette (CMD/CTRL + Shift + P) -> 'Log: Retrieve Apex Log And Show Analysis

✨ Features

Timeline / Flame chart

The Timeline shows a visualization of code execution during a request’s execution. Each color represents a different Salesforce event type e.g DB, Method, SOQL etc. The length of a bar relates to realtime taken, a longer bar means that method took longer.

timeline

Zoom + pan

Go to Call Tree

Tooltip

tooltip

Hovering over an element provides information on the item. If you click on an item it will take you to that row in the Call Tree.

The tooltip provides the following information.\ Event Name - e.g METHOD_ENTRY, EXECUTION_STARTED, SOQL_EXECUTION_BEGIN etc\ Event Description - Additional information about the event such as method name or SOQL query executed.\ Timestamp - The start and end timestamp for the given event which can be cross referenced in the log file.\ Duration - Made up of Total Time (time spent in that event and its children) and Self Time (time directly spent in that event).\ Rows - Shows Total Rows (rows from that event and its children) and Self Rows (rows directly from that event).

Call Tree

Shows the call stack which can be expanded and collapsed. Clicking on a link will take you to that line in the class if it can be found in the current open project.

Call Tree

Each row shows event type, details such as method signature, self and total time as well as aggregated DML, SOQL, Throws and Row counts.

Go to Code

Clicking the link in the event column will open the corresponding file and line, if that file exists in the current workspace.

Sort

Each column can be sorted by clicking the column header, this will sort the rows within the tree structure e.g sorting by self time will sort the children within a parent with the largest self time to the top but only within that parent.

Filtering

  1. Details (events with 0 time) are hidden by default but can be shown/ hidden.
  2. Show only debug statements using the Debug Only filter.
  3. Show Log events for specific namespaces using the namespace column filter
  4. Min and Max filtering can be done on the Total Time and Self Time columns.

Keyboard Navigation

The Call Tree can be navigated with the keyboard. The up and down keys will move between rows, the left and right keys will expand and collapse a parent within the tree.

Analysis

Show analysis of method calls by showing Self Time, Total Time, Count (number of times a method was called), name and type. Each column can be sorted ascending or descending by clicking the column header.

analysis

Sort

By default the Analysis table is sorted with the events that took the longest by Self Time at the top.\ Each column can be sorted by clicking the column header, this will sort the rows ascending or descending.

Filtering

  1. Show Log events for specific namespaces using the namespace column filter

Group

The rows can be grouped by Type or Namespace

  1. Namespace: Shows the rows aggregated by their namespace e.g default, MyNamespace
  2. Type: Shows the rows aggregated by namespace event type e.g METHOD_ENTRY, DML_ENTRY

Export to CSV + copy to clipboard

Click the header menu,⋮, and use Export to CSV to save the table content to a file. Focus the Analysis table and use CMD / CTRL + c to copy the table content to clipboard. This can then be pasted into a spreadsheet or other file.

Database

Shows the SOQL and DML that occurred the number of rows returned, the time taken and for SOQL the selectivity and number of aggregations.

database

The Selectivity column will have a green tick if the query is selective, a red cross if it is not and will be blank if the selectivity could not be determine. Sorting on this column will sort the rows by relative query cost, this number can be seen by hovering the cell on the selectivity column.

Sort

The rows can be sorted ascending or descending by DML/SOQL, Row Count and Time Taken and by Selectivity and Aggregations on the SOQL table. By default the rows within each group are sorted descending with the rows that have the highest row count at the top. Row within each group can be sorted by clicking the column header, this will sort the rows ascending or descending.

If the grouping is removed the sorting applies the same but across all rows instead of within each group.

Filtering

  1. In the SOQL view show Log events for specific namespaces using the namespace column filter

Group

By default rows are grouped by the SOQL/ DML text, grouping can be removed and the rows shows as a flat list using the Group by item in the header menu. The groups are default sorted with the groups with the most items at the top.

SOQL Statements can also be grouped by package namespace including the default namespace

DML / SOQL Call Stack

Clicking a row will show the SOQL/DML call stack, clicking on a link will take you to where that SOQL/DML occurred in the call tree.

SOQL Analysis

For SOQL rows, to the right of the Call Stack is SOQL Analysis which shows information about SOQL performance for the given query and how to improve it.

Export to CSV + copy to clipboard

Click the header menu,⋮, and use Export to CSV to save the table content to a file. Focus the Analysis table and use CMD / CTRL + c to copy the table content to clipboard. This can then be pasted into a spreadsheet or other file.

Find

Timeline

Timeline find

Call Tree

Call Tree find

Analysis + Database

Analysis find

🛠️ Settings

Timeline color settings

The default colors shown on the timeline can be changed in the VSCode settings.\ Either in the UI preferences -> extensions -> Apex Log Analyzer

color settings

or

settings.json

"lana.timeline.colors": {
  "Code Unit": "#88AE58",
  "Workflow": "#51A16E",
  "Method": "#2B8F81",
  "Flow": "#337986",
  "DML": "#285663",
  "SOQL": "#5D4963",
  "System Method": "#5C3444"
}

Contributing

Help us to make things better by Contributing\ Find out how to Build the extension

🎉 Contributors

Thanks to the everyone who has contributed ❤️ 🙏;

License

Copyright © Certinia Inc. All rights reserved.