Skip to content

Commit 58c8fce

Browse files
Merge pull request certinia#633 from lukecotter/chore-doc-site-updates
chore: doc site updates
2 parents 28a42b3 + f4f302a commit 58c8fce

32 files changed

Lines changed: 364 additions & 243 deletions

CHANGELOG.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2222
- **✂️ Copy Text in Views**: You can now highlight and copy text from the Call Tree, Analysis, and Database views without the text clearing immediately after highlighting ([#504]).
2323
- **💎 Improved HiDPI Rendering**: Sharpened rendering for the timeline on HiDPI displays ([#588]).
2424
- **🔍 Call Tree Search**: Search in the Call Tree now only includes the visible filtered rows ([#539]).
25-
- **🎨 Search Input Styling:**: The grid search input fits into VS Code styles better ([#619]).
26-
**📈 Call Tree Governor Limits:** The Call Tree now displays formatted governor limits for `CUMULATIVE_LIMIT_USAGE` events by default, as well as SOQL, SOSL, DML, and Method profiling events ([#309]).
25+
- **📈 Call Tree Governor Limits:** The Call Tree now displays formatted governor limits for `CUMULATIVE_LIMIT_USAGE` events by default, as well as SOQL, SOSL, DML, and Method profiling events ([#309]).
26+
- **📖 [Documentation site](https://certinia.github.io/debug-log-analyzer) updates** ([#616]).
27+
- **🎨 Table Dropdown Styling:**: The style of grid dropdowns matches VS Code better ([#619]).
2728

2829
### Fixed
2930

@@ -388,6 +389,7 @@ Skipped due to adopting odd numbering for pre releases and even number for relea
388389

389390
<!-- Unreleased -->
390391

392+
[#616]: https://github.com/certinia/debug-log-analyzer/issues/616
391393
[#504]: https://github.com/certinia/debug-log-analyzer/issues/504
392394
[#581]: https://github.com/certinia/debug-log-analyzer/issues/581
393395
[#582]: https://github.com/certinia/debug-log-analyzer/issues/582

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
**Analyze Salesforce Apex Debug logs with blazing speed.**
99
Apex Log Analyzer is a blazing-fast VS Code extension for Salesforce developers. Instantly visualize and debug Apex logs with interactive flame charts, dynamic call trees, and detailed SOQL/DML breakdowns. Identify performance bottlenecks, gain deep insight into complex transactions and optimize slow Apex methods faster than ever.
1010

11-
![Apex Log Analyzer Preview](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-preview.gif)
11+
![Apex Log Analyzer Preview](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/assests/v1.18/lana-preview.gif)
1212

1313
[Installation](#%EF%B8%8F-installation 'Install Apex Log Analyzer in VS Code') |
1414
[Debug Log Levels](#%EF%B8%8F-recommended-debug-log-levels 'Go to Recommended Debug Log Levels') |
@@ -90,7 +90,7 @@ The Flame Chart view shows a timeline of the Salesforce Apex log execution — i
9090
- **Click to Navigate** – Click any event to instantly view it in the interactive Call Tree.
9191
- **Stacked by Time** – See how execution time is distributed across nested method calls and system events.
9292

93-
![Flame Chart](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-timeline.png)
93+
![Flame Chart](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/assests/v1.18/lana-timeline.png)
9494

9595
> 🧠 Great for spotting long-running operations, inefficient queries, and bottlenecks.
9696
@@ -104,7 +104,7 @@ Explore nested method calls with performance metrics:
104104
- **Keyboard Navigation**
105105
- **Click to go to Code** – Jump to the source method in your project
106106

107-
![Call Tree](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-calltree.png)
107+
![Call Tree](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/assests/v1.18/lana-calltree.png)
108108

109109
## 🧠 Apex Analysis
110110

@@ -115,7 +115,7 @@ See which methods are the slowest, most frequent. or expensive.
115115
- **Filter to specific event types**
116116
- **Copy or Export to CSV**
117117

118-
![Analysis](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-analysis.png)
118+
![Analysis](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/assests/v1.18/lana-analysis.png)
119119

120120
## 🗄️ Database Analysis
121121

@@ -128,7 +128,7 @@ Highlight slow Salesforce SOQL queries, non-selective filters, and DML issues.
128128
- **Sort by SOQL or DML, Duration, Selectivity, Aggregates, Row Count**
129129
- **Copy or Export to CSV**
130130

131-
![Database](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-database.png)
131+
![Database](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/assests/v1.18/lana-database.png)
132132

133133
## 🔍 Global Search
134134

@@ -159,8 +159,8 @@ Or go to: `Preferences > Extensions > Apex Log Analyzer`.
159159
## 📚 Documentation
160160

161161
- [User Guide & Docs](https://certinia.github.io/debug-log-analyzer/)
162-
- [Contribute](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/CONTRIBUTING.md)
163-
- [Develop](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/DEVELOPING.md)
162+
- [Contribute](https://github.com/certinia/debug-log-analyzer/blob/main/CONTRIBUTING.md)
163+
- [Develop](https://github.com/certinia/debug-log-analyzer/blob/main/DEVELOPING.md)
164164

165165
## ❤️ Contributors
166166

lana-docs-site/docs/community/changelog.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
2+
id: changelog
23
title: Changelog
34
hide_title: true
45
sidebar_position: 3
56
sidebar_label: Changelog
7+
description: Stay updated with the latest features, improvements, and bug fixes in the Apex Log Analyzer. Explore our comprehensive changelog for detailed release notes and community updates.
8+
keywords: [apex log analyzer changelog, apex log analyzer release notes]
69
---
710

811
```mdx-code-block

lana-docs-site/docs/community/contributing.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2+
id: contributing
23
title: Contributing
34
hide_title: true
45
sidebar_position: 2
56
sidebar_label: Contributing
7+
description: Contribute to the Apex Log Analyzer for Salesforce open-source project. Find guidelines, best practices, and steps for making your first contribution to the community.
8+
keywords:
9+
[
10+
contribute to apex log analyzer for Salesforce,
11+
add new features to apex log analyzer,
12+
fix apex log analyzer bugs,
13+
]
614
---
715

816
```mdx-code-block
Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
11
---
2+
id: support
3+
title: 🤝 Support
24
sidebar_position: 1
5+
sidebar_label: Support
6+
description: Help and support with the Apex Log Analyzer for Salesforce. Connect with our community to get support, share your experiences, raise feature requests, report bugs and find answers to your questions.
7+
keywords:
8+
[
9+
apex log analyzer community,
10+
apex log analyzer support,
11+
salesforce apex log analyzer feature requests,
12+
salesforce apex log analyzer bug reports,
13+
salesforce apex log analyzer discussion,
14+
]
315
---
416

5-
# Support
6-
717
Before participating, please read our [Code of Conduct](https://github.com/certinia/debug-log-analyzer/blob/main/CODE_OF_CONDUCT.md).
818

9-
## Discussion
19+
## ✨ Feature requests and Bugs {#feature-requests}
1020

11-
For discussion about best practices or if you have any questions or need help, please start a [discussion on github](https://github.com/certinia/debug-log-analyzer/discussions)
21+
For new feature requests, open a [feature request issue](https://github.com/certinia/debug-log-analyzer/issues/new/choose) or [bug report issue](https://github.com/certinia/debug-log-analyzer/issues/new/choose) on github. Our issues can be sorted by upvotes, which gives us a way to prioritise what to work on next.
1222

13-
## Feature requests and Bugs {#feature-requests}
23+
Just wanting to look at the backlog, head over to the **[open issues](https://github.com/certinia/debug-log-analyzer/issues)**.
24+
If you see an idea you like then join the conversation to get your ideas into the feature.
1425

15-
For new feature requests, open a [feature request issue](https://github.com/certinia/debug-log-analyzer/issues/new/choose) or [bug report issue](https://github.com/certinia/debug-log-analyzer/issues/new/choose) on github. Our issues can be sorted by upvotes, which gives us a way to prioritise what to work on next.
26+
## 💬 Discussion
27+
28+
For discussion about best practices or if you have any questions or need help, please start a [discussion on github](https://github.com/certinia/debug-log-analyzer/discussions)

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

Lines changed: 0 additions & 187 deletions
This file was deleted.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
id: analysis
3+
title: Analysis
4+
description: Analyze Salesforce debug logs with detailed metrics on method calls, including Self Time, Total Time, Count, Name, and Type. Easily sort, filter, and group log events by namespace or type, and export or copy results for efficient troubleshooting and performance optimization.
5+
keywords:
6+
[
7+
salesforce debug log analysis,
8+
apex performance metrics,
9+
salesforce troubleshooting,
10+
apex log analyzer,
11+
salesforce performance optimization,
12+
filter salesforce logs,
13+
salesforce developer tools,
14+
]
15+
image: https://github.com/certinia/debug-log-analyzer/blob/main/lana/assests/v1.18/lana-analysis.png
16+
---
17+
18+
## 🧠 Analysis
19+
20+
Analyze Salesforce debug logs with detailed metrics on method calls, including Self Time, Total Time, Count, Name, and Type. Easily sort, filter, and group log events by namespace or type, and export or copy results for efficient troubleshooting and performance optimization.
21+
22+
![Analysis view screenshot showing method call metrics such as Self Time, Total Time, Count, Name, and Type](https://github.com/certinia/debug-log-analyzer/blob/main/lana/assests/v1.18/lana-analysis.png)
23+
24+
### Sort
25+
26+
By default the Analysis table is sorted with the events that took the longest by Self Time at the top.\
27+
Each column can be sorted by clicking the column header, this will sort the rows ascending or descending.
28+
29+
### Filtering
30+
31+
1. Show Log events for specific namespaces using the namespace column filter
32+
33+
### Group
34+
35+
The rows can be grouped by Type or Namespace
36+
37+
1. Namespace: Shows the rows aggregated by their namespace e.g `default`, `MyNamespace`
38+
1. Type: Shows the rows aggregated by namespace event type e.g `METHOD_ENTRY`, `DML_ENTRY`
39+
40+
### Export to CSV + copy to clipboard
41+
42+
Use `Export to CSV` above the table to save the table content to a file or `Copy to Clipboard`.
43+
You can also focus the Analysis tables and use `CMD / CTRL + c` to copy the table content to clipboard. This can then be pasted into a spreadsheet or other file.

0 commit comments

Comments
 (0)