The Log Center works outside its tool window too. The status bar shows what's stored and what runs, the gutter marks the code lines that logged errors, and every source a log names opens in your project
Status bar
The Log Center widget shows in the status bar while logs are stored on this computer or the Log Center has an instance open. With no stored logs it hides
Sandbox 01
version2
Files
Issues
Events
Anomalies
Monitor
Storage
Parse
Tail
Parse New Data (3)
RefArch (3)
~/Projects/storefront
| It reads | When |
|---|---|
| 12.4K events | The events stored for every instance. Below 10,000 it shows the full count, such as 1,204 events |
| 27K+ events | An instance isn't counted yet. It's counted once the Log Center opens it |
| 1.2 GB stored | No instance is counted yet, so it shows their size on disk |
| 12.4K events · Parsing 2 | Files parse or wait their turn |
| 12.4K events · Tailing 3 | Files are tailed. With both, it reads Parsing 2 · Tailing 3 |
- While files parse, a small bar fills with the share of their bytes read. Until a parse knows its file's size, a short segment glides back and forth
- While files are only tailed, a dot beats every 2 seconds
- The bar is blue and the dot green at a normal load. At Elevated and High load they take the load colours. The load is the Log Center's own share of all your CPU cores: Elevated from 40%, High from 70%
- It moves only while work runs, and changes at most twice a second
- The counts come from the instances the Log Center opened since the IDE started, and stay after it closes them
The card
Rest the pointer on the widget for its card. It follows the counts while it shows
| Part | Shows |
|---|---|
| The head | Log Center, with the events and size of all instances when more than one is stored |
| A row per instance | Its cloud, its connection's name, its events and its size. Under the name: its kind when the name doesn't say it, its short host, such as zzrx-001, and its files, such as 2,140 files |
| The work of an instance | Under its row while it's busy: Parsing 2, 1 queued · 45% parsed and Tailing 3 files |
| The foot | Open Log Center, and while work runs, Load with a meter that reads Normal, Elevated or High |
- Rows come by kind: production, staging, development, sandboxes, other instances, then the instances with stored logs and no connection, which read Stored logs only
- Up to 6 rows show: the project's instance, then the busy ones, then the largest. The rest read 2 more instances
- The cloud takes the colour of the instance's kind. It's lit for the active connection and grey for stored logs only
- Rest the pointer on a row whose name or host is shortened for the full host
- Click a row to open that instance in the Log Center
Click the widget
A click opens the Log Center at the selected instance tab, else at the project's instance, else at the first instance with work. A busy instance opens on Monitor, see Monitor
Hide the widget
Right-click the status bar and clear Log Center to hide the widget in every project. Check it again to bring it back
Errors in the gutter
Code lines that logged errors or warnings get a mark in the editor gutter. The mark is the icon of the line's worst level, as the Log Center lists show it: the error icon when one of its issues is an error, else the warning icon
WarnWhich lines get a mark
- The lines named by the open issues of the project's instance, the one of the active connection, at Error or Warn. Fixed issues lose their marks, issues in the backlog keep theirs
- Only while the Log Center has that instance open: its tab is open, or its files parse or are tailed. Once it's closed and nothing runs, the marks go about 10 minutes later
- Scripts, Digital Script files and ISML templates open in an editor get them. A file you open shows its marks within a few seconds
- The issue needs a script line, and its path must match exactly one file of the project, see Log sources in your project. A path that several files match gets no mark
- The newest 2,000 open issues count. New events update the marks at most every 2 seconds
Read a mark
- Hover it for SFCC Logs: 328 occurrences, last 2 min ago: the occurrences of every issue on the line, and when the latest was logged
- Click it for the SFCC Logs list of the line's issues, errors first, then the latest. Each row has the level, the issue's title and 328 occurrences, last 2 min ago
- Pick an issue to select it in Issues of the Log Center
- Open in Log Center at the end selects the issue, or shows the events of all of them in Events when the line has several
Edit a marked line
- The mark moves with its line as you type above or below it
- Change the line itself and the mark turns grey: the code differs from what wrote the log. The tooltip adds This line changed after the log was written
- New lines typed before or after it leave it as it is
- The mark gets its colour back when the line logs again after your change
Highlight the lines
Turn on Highlight lines with log errors to mark the line's text as a weak warning too. The Problems tool window then lists it as SFCC Logs: and the issue's title, plus (and 2 more issues) when more issues share the line
Show log issues in the editor gutter and Highlight lines with log errors sit under Editor in Settings › Tools › Intellij SFCC › Log Center, see Settings. A change applies at once, in every open project
Log sources in your project
Logs name code as script paths, templates, routes, hooks, jobs and Script API classes. The Log Center looks for them in the open project only
| A log names | Such as | It looks |
|---|---|---|
| A script path | app_custom/cartridge/scripts/cart.js:36 | Below the linked cartridges, then the project's content roots. The first folder may name the cartridge |
| A Digital Script import | app_custom:scripts/util.ds | In the cartridge folder of the cartridge it names |
| A global module | modules/server/route.js:69 | In the linked global modules folder, whatever its name |
| A template | [Template:checkout/confirmation]#12 | Under cartridge/templates/default/ of each linked cartridge, then its other locale folders |
| A route, hook, job or Script API class | Cart-Show, dw.order.calculate, Job [ExportOrders], dw.crypto.MessageDigest | In the plugin's indexes, once the IDE finishes indexing |
- One match opens at its line and column
- Several matches open a list, such as Open app_custom/cartridge/scripts/cart.js:36, with each file's icon and its cartridge on the right
- No match shows Not in this project: and the source
- A path must be relative, without
.., and a symbolic link can't lead out of the folder it's in - The answers follow your project: they're looked up again when files, content roots or linked cartridges change
| Where | The mapping |
|---|---|
Open Source, Cmd+Enter (Ctrl+Enter), F4 | Opens the selected row's source, see Keyboard |
| The Source column of Issues and Events | Shows a path that no project file matches in red |
| The cards in the details | In this project names the file a script line opens, or reads No file of this project matches it, see The details |
| The Code tab of an issue | Shows the project code the issue names |
| The Source and Cartridge filters | Keep Mapped, Unresolved or No source events, or the events whose script opens a file of a cartridge, see The filter popup |
| SFCC logs in the editor | Make paths, routes and other names links to the code, see Links to code |
| The gutter | Marks the lines of a path that matches one file, see Errors in the gutter |
Troubleshooting
| Symptom | What to do |
|---|---|
| No Log Center widget | Nothing is stored yet, so parse or tail a file. Or the widget is off: right-click the status bar and check Log Center |
| The widget reads 1.2 GB stored with no events | No stored instance is counted since the IDE started. Open one in the Log Center |
| No gutter marks | Check that Show log issues in the editor gutter is on, the instance's connection is active, the Log Center has the instance open and the issue isn't fixed. Then open the issue's source from the Log Center: a list or Not in this project means no single file matches |
| A mark sits on a line that doesn't fit | The log names the line of the code that ran on the instance. Upload your copy, see Upload, and let it log again |
| Not in this project: … | Link the cartridge or the global modules folder, see Cartridges, or open the project that holds the code |
| A route or hook opens nothing | Wait for indexing to finish, then try again |