Overview video
0:00 Diagnostic Recorder: what it does
0:03 The Diagnostic Recorder is a page in the admin area. It records what the platform does while you repeat an action that goes wrong, and shows the result as a timeline you can read.
0:14 You give the session a name and press Record. The status changes to Recording and a countdown shows when it will end by itself. Then you repeat the action in the same browser, for example by viewing your storefront as a customer and going to the checkout.
0:30 Each entry has a time, the region it came from, a type and a message. Here, the messages say which checkout options were not offered and the rule that stopped them. If your store is connected to a print system, its calls appear as external call entries too, showing the request that was sent and the response that came back.
0:50 You will find it under System in the admin area, with a Record button and a Trace Viewer. The step-by-step guide on this page shows how to use it.
Step-by-step video
0:00 Record and read a trace with the Diagnostic Recorder
0:04 In this tutorial we'll use the Diagnostic Recorder to record what the platform does while you reproduce a problem. We'll start a recording, repeat the action, read the trace, then stop and clear it. You need the Administrators role, and a test customer you can view your storefront as.
0:22 In the admin area, click System, then Diagnostic Recorder. The page warns that trace data can contain personal information, so treat it as confidential. The status reads Not recording. If the Trace Viewer already lists entries, clear them first.
0:40 Type a short name for the problem you are investigating in the Session label box, then click Record. The status can take a second or two to change.
0:49 The status now reads Recording, with a countdown that starts at ten minutes, and the button has become Stop recording. Now repeat the action that goes wrong in this same browser window, for example by impersonating a test customer, opening the checkout without placing an order, and then finishing the impersonation. Then come back to this page.
1:11 Entries appear in the Trace Viewer. Click the refresh arrow to load the latest, and look for the row that names what went wrong. Each row shows the time, the Region, which is the part of the platform, the type, and a message. Customer value is a decision made for the customer, such as an option that was not offered. The same line can appear several times in a row.
1:34 When you have reproduced the problem, click Stop recording. The status changes to Not recording, and the entries stay in the Trace Viewer so you can keep reading them.
1:44 Click Clear, then confirm. Entries are only kept for a limited time, so read them soon after you record, and clear the trace when you have finished.
1:54 That is the Diagnostic Recorder. The steps below cover each screen. Next time something goes missing, record it and read the trace.
No lines in the transcript match your search.