Skip to content

Commit e8a3dcc

Browse files
lcottercertinialcottercertinia
authored
Merge pull request certinia#626 from lukecotter/chore-doc-site-seo
2 parents 50ab261 + 2a2c90a commit e8a3dcc

9 files changed

Lines changed: 372 additions & 61 deletions

File tree

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

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,34 @@
11
---
2-
sidebar_position: 4
2+
id: features
3+
title: ✨ Features
4+
description: Explore the key features of Apex Debug Log Analyzer for Salesforce, including Timeline/Flame Chart, Call Tree, Analysis, Database, and Find functionality.
5+
sidebar_position: 2
6+
keywords:
7+
[
8+
salesforce,
9+
apex,
10+
vscode,
11+
logs,
12+
features,
13+
debug log analyzer,
14+
salesforce development,
15+
apex log analysis,
16+
visual studio code extension,
17+
salesforce debugging,
18+
apex logs,
19+
salesforce tools,
20+
salesforce extension,
21+
salesforce log analyzer,
22+
apex performance,
23+
salesforce productivity,
24+
salesforce troubleshooting,
25+
salesforce log analysis,
26+
apex code analysis,
27+
salesforce best practices,
28+
]
29+
image: https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-timeline.png
330
---
431

5-
# ✨ Features
6-
732
- 🔥 [**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.
833
- 🌳 [**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.
934
- 🧠 [**Analysis**](#-analysis) - Quickly identify which methods took the most time in aggregate.

‎lana-docs-site/docs/docs/gettingstarted.md‎

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,37 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 1
3+
id: gettingstarted
4+
title: Getting Started
5+
descrition: A step-by-step guide to installing, configuring, and using the Apex Log Analyzer extension for Visual Studio Code to analyze Salesforce Apex debug logs efficiently.
6+
keywords: [salesforce, apex, vscode, logs, getting started, debug log analyzer, install]
7+
image: https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-timeline.png
38
---
49

5-
# Getting Started
10+
## Installation
11+
12+
![install](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/install-lana.webp)
13+
14+
Search for `Apex Log Analyzer` from the extensions side bar in VS Code and click `Install` or
15+
install from the VS Code market place by clicking install on [Visual Studio Code Market Place: Apex Log Analyzer](https://marketplace.visualstudio.com/items?itemName=financialforce.lana)
16+
17+
### Pre-Release
18+
19+
Click `Switch to Pre-Release Version` on the banner to get bleeding edge changes and help us to resolve bugs before the stable release.
20+
21+
## View Analysis
22+
23+
### Command Pallette
24+
25+
Open command pallette (CMD/CTRL + Shift + P), paste `ext install financialforce.lana`, and press enter.
26+
27+
```sh
28+
ext install financialforce.lana
29+
```
630

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

10-
## From an Open Log File
34+
### From an Open Log File
1135

1236
With the `.log` file open in VSCode.
1337

@@ -22,6 +46,13 @@ With the `.log` file open in VSCode.
2246
or
2347
1. Right click editor tab -> 'Log: Show Apex Log Analysis'
2448

25-
## Download a log
49+
### Download a log
2650

2751
1. Open command pallette (CMD/CTRL + Shift + P) -> 'Log: Retrieve Apex Log And Show Analysis
52+
53+
## ⚙️ Recommended Debug Log Levels
54+
55+
- Set `APEX_CODE` level to `FINE` or higher — lower levels may omit important execution details.
56+
- Be aware that higher debug levels introduce logging overhead, which can inflate recorded execution times.
57+
- Avoid truncated logs — they can result in incomplete or misleading analysis.
58+
- Recommended settings for a good balance of detail and performance: `APEX_CODE,FINE; APEX_PROFILING,FINE; CALLOUT,INFO; DB,FINEST; NBA,INFO; SYSTEM,DEBUG; VALIDATION,INFO; VISUALFORCE,FINE; WAVE,INFO; WORKFLOW,FINE`

‎lana-docs-site/docs/docs/installation.md‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎lana-docs-site/docs/docs/intro.md‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎lana-docs-site/docs/docs/settings.md‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 3
3+
id: settings
4+
title: Settings
5+
description: How to configure and customize, Apex Log Analyzer VS Code extension for Salesforce developer.
6+
keywords:
7+
[
8+
salesforce,
9+
apex,
10+
log,
11+
debug,
12+
apex log analyzer settings,
13+
vscode settings,
14+
customize apex debug log analyzer,
15+
salesforce log analysis,
16+
]
17+
image: https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-timeline.png
318
---
419

5-
# Settings
6-
720
## Timeline color settings
821

922
The default colors shown on the timeline can be changed in the VSCode settings.\

‎lana-docs-site/docusaurus.config.ts‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,22 @@ const config: Config = {
5959
],
6060
],
6161
themeConfig: {
62+
announcementBar: {
63+
id: 'lana-1.18', // Unique ID to prevent showing again if dismissed
64+
content:
65+
'🎉️ <b><a target="_blank" rel="noopener noreferrer" href="https://marketplace.visualstudio.com/items?itemName=financialforce.lana">Apex Log Analyzer v1.18</a> is out!<b>',
66+
isCloseable: true,
67+
},
6268
// Replace with your project's social card
6369
image: 'img/lana-timeline.png',
70+
metadata: [
71+
{
72+
name: 'keywords',
73+
content:
74+
'salesforce, apex, vscode, log analyzer, debug log analyzer, debug logs, performance',
75+
},
76+
{ name: 'author', content: 'Certinia' },
77+
],
6478
navbar: {
6579
title: 'Apex Log Analyzer for Salesforce',
6680
logo: {
@@ -70,8 +84,8 @@ const config: Config = {
7084
},
7185
items: [
7286
{
73-
type: 'docSidebar',
74-
sidebarId: 'docSidebar',
87+
type: 'doc',
88+
docId: 'docs/features',
7589
position: 'left',
7690
label: 'Docs',
7791
},
@@ -84,8 +98,9 @@ const config: Config = {
8498
},
8599
{
86100
href: `https://github.com/${organizationName}/${projectName}`,
87-
label: 'GitHub',
88101
position: 'right',
102+
'aria-label': 'GitHub Repository',
103+
className: 'header-github-link',
89104
},
90105
{
91106
type: 'search',
@@ -100,12 +115,16 @@ const config: Config = {
100115
title: 'Docs',
101116
items: [
102117
{
103-
label: 'Introduction',
104-
to: '/',
118+
label: 'Getting Started',
119+
to: 'docs/gettingstarted',
120+
},
121+
{
122+
label: 'Features',
123+
to: 'docs/features',
105124
},
106125
{
107-
label: 'Installation',
108-
to: 'docs/installation',
126+
label: 'Settings',
127+
to: 'docs/settings',
109128
},
110129
],
111130
},

‎lana-docs-site/src/css/custom.css‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,22 @@
2828
--ifm-color-primary-lightest: #4fddbf;
2929
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
3030
}
31+
32+
.header-github-link::before {
33+
content: '';
34+
width: 24px;
35+
height: 24px;
36+
display: flex;
37+
background-color: var(--ifm-navbar-link-color);
38+
mask-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E");
39+
transition: background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);
40+
}
41+
42+
.header-github-link:hover::before {
43+
background-color: var(--ifm-navbar-link-hover-color);
44+
}
45+
46+
div[class^='announcementBar_'] {
47+
font-size: 20px;
48+
font-weight: 700;
49+
}

‎lana-docs-site/src/pages/index.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
id: index
3+
title: Apex Log Analyzer
4+
description: Apex Log Analyzer is a blazing-fast VS Code extension for Salesforce. Visualize and debug Apex logs with interactive flame charts, dynamic call trees, and detailed SOQL/DML breakdowns. Identify performance bottlenecks, gain deep transaction insights and optimize slow Apex.
5+
slug: /
6+
sidebar_position: 1
7+
keywords:
8+
[
9+
salesforce,
10+
apex,
11+
debug logs,
12+
performance analysis,
13+
flame chart,
14+
log analyzer,
15+
vscode,
16+
vscode,
17+
logs,
18+
apex log analysis,
19+
visual studio code extension,
20+
salesforce debugging,
21+
apex logs,
22+
salesforce tools,
23+
salesforce extension,
24+
salesforce log analyzer,
25+
apex performance,
26+
salesforce productivity,
27+
salesforce troubleshooting,
28+
salesforce log analysis,
29+
apex code analysis,
30+
]
31+
image: https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-timeline.png
32+
hide_title: true
33+
hide_table_of_contents: true
34+
---
35+
36+
import Link from '@docusaurus/Link';
37+
import styles from './styles.module.css';
38+
39+
<div className={styles.homePage}>
40+
<div>
41+
<h1 classname={styles.homePageHeader}>🚀 Apex Log Analyzer</h1>
42+
43+
<p className={styles.homePageDescription}>
44+
Apex Log Analyzer for VS Code lets Salesforce developers debug Apex logs instantly with <strong>flame charts</strong>, <strong>call trees</strong>, and <strong>SOQL/DML</strong> insights - <strong>find bottlenecks fast</strong>
45+
</p>
46+
47+
<div className={styles.heroButtons}>
48+
<Link className="button button--primary button--lg" to="/docs/gettingstarted">Get Started</Link>
49+
<span className={styles.indexCtasGitHubButtonWrapper}>
50+
<iframe
51+
className={styles.indexCtasGitHubButton}
52+
src="https://ghbtns.com/github-btn.html?user=certinia&amp;repo=debug-log-analyzer&amp;type=star&amp;count=true&amp;size=large"
53+
width={160}
54+
height={30}
55+
title="GitHub Stars"
56+
/>
57+
</span>
58+
</div>
59+
60+
</div>
61+
62+
<img
63+
src="https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-preview.gif"
64+
alt="Animated preview of the Apex Log Analyzer VS Code extension visualizing Salesforce Apex logs with flame charts and call trees"
65+
className={styles.previewImg}
66+
/>
67+
68+
<div className={styles.featureOverview}>
69+
<div/>
70+
71+
<div className={styles.cardGrid}>
72+
73+
<div className="card">
74+
<div className="card__header">
75+
<h3>Flame Chart Visualization</h3>
76+
</div>
77+
<div className="card__body">
78+
<p>See method timings in a modern flame chart. Instantly spot Apex transaction bottlenecks.</p>
79+
</div>
80+
</div>
81+
82+
<div className="card">
83+
<div className="card__header">
84+
<h3>Fast Log Parsing</h3>
85+
</div>
86+
<div className="card__body">
87+
<p>Processes massive Apex debug logs in milliseconds using a high-performance parser - no lag, no waiting.</p>
88+
</div>
89+
</div>
90+
91+
<div className="card">
92+
<div className="card__header">
93+
<h3>Governor Limit Tracking</h3>
94+
</div>
95+
<div className="card__body">
96+
<p>Stay under limits with a clear, interactive view of SOQL, DML, time and more.</p>
97+
</div>
98+
</div>
99+
100+
<div className="card">
101+
<div className="card__header">
102+
<h3>Event Filtering</h3>
103+
</div>
104+
<div className="card__body">
105+
<p>Hide noise. Focus only on what you care about - from method calls to debug statements and limits.</p>
106+
</div>
107+
</div>
108+
109+
</div>
110+
111+
<section className={styles.visualImpactSection}>
112+
<div className={styles.visualContent}>
113+
<h2>Turn 200,000+ Lines of Logs into Actionable Insights</h2>
114+
<p>Raw log files are hard to scan, and easy to misread. The Apex Log Analyzer renders a high-resolution flame chart that maps out every method call, time taken, and nested operations.</p>
115+
<ul>
116+
<li>🌈 Color-coded log events</li>
117+
<li>🔎 Zoom & pan into areas of interest</li>
118+
<li>⏱ Time-based scaling to pinpoint slowdowns</li>
119+
</ul>
120+
<Link className="button button--secondary" to="/docs/features#-timeline--flame-chart">Learn More</Link>
121+
</div>
122+
<div className={styles.visualImage}>
123+
<img src="https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/images/lana-timeline.png" alt="Flame chart of Apex log execution time" />
124+
</div>
125+
</section>
126+
127+
</div>
128+
129+
</div>

0 commit comments

Comments
 (0)