Skip to content

Commit b5d2c0b

Browse files
committed
docs: update doc site with find feature section
1 parent ed3299b commit b5d2c0b

1 file changed

Lines changed: 38 additions & 38 deletions

File tree

lana-docs-site/docs/docs/features.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
sidebar_position: 4
33
---
44

5-
# Features
5+
# Features
66

7-
- [**Timeline / Flame chart**](#timeline--flame-chart) - Gain a deep understanding of code execution over time via a timeline flame chart and tooltips to show additional information about events.
8-
- [**Call Tree**](#call-tree) - View the execution path in a tree view with aggregated DML Count, SOQL Count, Throws Count, Row Count, Self Time and Total Time. Apply filters to filter the events.
9-
- [**Analysis**](#analysis) - Quickly identify which methods took the most time in aggregate.
10-
- [**Database**](#database) - Identify which SOQL + DML executed the most, returned the most rows and took the most time.
7+
- 🔥 [**Timeline / Flame chart**](#timeline--flame-chart) - Gain a deep understanding of code execution over time via a timeline flame chart and tooltips to show additional information about events.
8+
- 🌳 [**Call Tree**](#call-tree) - View the execution path in a tree view with aggregated DML Count, SOQL Count, Throws Count, Row Count, Self Time and Total Time. Apply filters to filter the events.
9+
- 🧠 [**Analysis**](#analysis) - Quickly identify which methods took the most time in aggregate.
10+
- 💾 [**Database**](#database) - Identify which SOQL + DML executed the most, returned the most rows and took the most time.
11+
- 🔍 [**Find**](#find) - Find, highlight and step through matching text and log events on the Timeline, Call Tree, Analysis
1112

12-
## Timeline / Flame chart
13+
## 🔥 Timeline / Flame chart
1314

1415
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.
1516

@@ -22,14 +23,6 @@ The Timeline shows a visualization of code execution during a request’s execut
2223
- Scroll left and right on the mouse to move the time line left are right, when zoomed
2324
- Click the mouse down and drag to move the timeline around both in the x and y direction, when zoomed
2425

25-
### Find
26-
27-
- CMD/CTRL + f to open find
28-
- Events with matching text are highlighted, there is a different highlight for the current match.
29-
- Previous match, next match and case sensitive search all supported.
30-
- If the next matching event is off screen that event will be centered on the timeline.
31-
- The find will match on Event Type or text in the event
32-
3326
### Go to Call Tree
3427

3528
Clicking an event in the Timeline will go to and select that event in the Call Tree.
@@ -47,21 +40,14 @@ The tooltip provides the following information.\
4740
**Duration** - Made up of **Total Time** (time spent in that event and its children) and **Self Time** (time directly spent in that event).\
4841
**Rows** - Shows **Total Rows** (rows from that event and its children) and **Self Rows** (rows directly from that event).
4942

50-
## Call Tree
43+
## 🌳 Call Tree
5144

5245
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.
5346

5447
![Call Tree](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.14/lana-calltree.png)
5548

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

58-
### Find
59-
60-
- CMD/CTRL + f to open find
61-
- Any matching text is highlighted, there is a different highlight for the current match.
62-
- Previous match, next match and case sensitive search all supported.
63-
- If the next matching text is within a parent that parent will be expanded.
64-
6551
### Go to Code
6652

6753
Clicking the link in the event column will open the corresponding file and line, if that file exists in the current workspace.
@@ -81,19 +67,12 @@ Each column can be sorted by clicking the column header, this will sort the rows
8167

8268
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.
8369

84-
## Analysis
70+
## 🧠 Analysis
8571

8672
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.
8773

8874
![analysis](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.14/lana-analysis.png)
8975

90-
### Find
91-
92-
- CMD/CTRL + f to open find
93-
- Any matching text is highlighted, there is a different highlight for the current match.
94-
- Previous match, next match and case sensitive search all supported.
95-
- If the next matching text is within a group that group will be expanded.
96-
9776
### Sort
9877

9978
By default the Analysis table is sorted with the events that took the longest by Self Time at the top.\
@@ -115,21 +94,14 @@ The rows can be grouped by Type or Namespace
11594
Click the header menu,``, and use `Export to CSV` to save the table content to a file.
11695
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.
11796

118-
## Database
97+
## 💾 Database
11998

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

122101
![database](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.14/lana-database.png)
123102

124103
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.
125104

126-
### Find
127-
128-
- CMD/CTRL + f to open find
129-
- Any matching text is highlighted, there is a different highlight for the current match.
130-
- Previous match, next match and case sensitive search all supported.
131-
- If the next matching text is within a group that group will be expanded.
132-
133105
### Sort
134106

135107
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.
@@ -160,3 +132,31 @@ For SOQL rows, to the right of the Call Stack is SOQL Analysis which shows infor
160132

161133
Click the header menu,``, and use `Export to CSV` to save the table content to a file.
162134
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.
135+
136+
## 🔍 Find
137+
138+
- CMD/CTRL + f to open find
139+
- Any matching text is highlighted, the current match has a lighter hightlight.
140+
- Previous match, next match and case sensitive search all supported.
141+
142+
### Timeline
143+
144+
- If the next matching event is off screen that event will be centered on the timeline.
145+
- The find will match on Event Type or text in the event
146+
- The tooltip is shown for the current matching event, making it easy to view the event details such as Total or Self time.
147+
148+
![Timeline find](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.16/lana-timeline-find.png)
149+
150+
### Call Tree
151+
152+
- If the next matching text is within a parent that parent will be expanded.
153+
- The row with the current matching text will also be highlighted
154+
155+
![Call Tree find](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.16/lana-calltree-find.png)
156+
157+
### Analysis + Database
158+
159+
- If the next matching text is within a group that group will be expanded.
160+
- The row with the current matching text will also be highlighted
161+
162+
![Analysis find](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.16/lana-analysis-find.png)

0 commit comments

Comments
 (0)