Monitor Your PWA Kit Site

Use observability tools to monitor the performance of your Progressive Web App (PWA) Kit site. Site performance is a shared responsibility model: you’re responsible for the performance of project customizations and Salesforce is responsible for the performance of the B2C Commerce platform.

This guide summarizes how to use platform and third-party tools to monitor the performance of your PWA Kit site.

Key Monitoring Tools

Here are the main tools that we recommend you use to monitor your PWA Kit site.

B2C Commerce Reports & Dashboards provide data that you can use to identify trends over time and to make smarter business decisions based on your B2C Commerce data. Use Reports & Dashboards to understand general trends in your API response times.
- To see the load on your B2C Commerce instance, click App Launcher and then select Reports & Dashboards > Real Time > Sales & Performance.
- Get insights into your site’s Salesforce Commerce API (SCAPI) requests, by checking the Technical SCAPI Dashboard.
- To get insights into your site’s Open Commerce API (OCAPI) requests, check the Technical OCAPI Dashboard.

Data appears in Reports & Dashboards 24 hours after any corresponding event happens.

Note

With Log Center, you can review error logs and metrics.
- Search for and view logs generated by Managed Runtime (MRT) and PWA Kit projects. See Debug Using Log Center.
- Set up notifications so you can find out when your storefront is functioning abnormally and investigate. Consider setting up a Search with Notifications for the HookInvocationException in Log Center.
- For detailed information about hook timing, collect request/response details by adding the HTTP request header sfdc_verbose: true. Hook timing is logged to Log Center.
- Set up Log Center Streaming to turn on enterprise-scale monitoring and automation and to stream logs to third-party log aggregation tools.
- View Shopper Login and API Access Service (SLAS) Error Logs in Log Center.
You can resolve performance issues in your custom pipelines and code by using Pipeline Profiler and Code Profiler.

More Monitoring Tools

Here are additional tools that you can optionally use to monitor the performance of your PWA Kit site.

Understand the Performance of API Hooks

If your hooks make external service calls, monitor the availability of downstream services by using Web Service Performance and Incident Analysis.

You can also review the logs generated from your services. See Web Service Logging and Troubleshooting. Then you can build notifications in Log Center for your chosen logs.

Understand the Performance of Backend Jobs

Check the Job Statistics page in Business Manager. See Jobs.

Production jobs are usually order export, async operations and sometimes high-scale price book imports.

Staging jobs are usually catalog and price book. Remember to also monitor jobs in staging.

Integrate your Site with Your Application Performance Monitoring (APM) Tool

Poll the OCAPI Admin API Search Job Executions and push the output data to an APM.

Set up Embedded Content Delivery Network (eCDN) Log Push.

Set up Real-time Performance and Error Alerts

If you have the Signature Success Plan, turn on Proactive Services.

Identify the Root Cause of a SCAPI Request Timeout

Follow the steps in Troubleshoot Request Timeouts.

Include the correlationID identified in Troubleshoot Request Timeouts if you need to open a support case.