Backoffice Monitoring

SAP Commerce provides custom metrics that improve the overall observability of the SAP Commerce Backoffice.

Because the ZK AU framework is nontransparent to the user, all user activities in the Backoffice use the same /backoffice/zkau request. This lack of transparency hides performance issues and prevents any visibility into user activities. To address these issues and improve performance troubleshooting, SAP Commerce provides custom metrics that improve the overall observability of the SAP Commerce Backoffice.
  • Backoffice User Activity: Because the Search feature is so popular, the system captures Simple/Advanced search actions and searches table names.

    The system identifies search requests with TableName. The system parses requests per table and establishes baselines for each individual request. This helps to identify database table issues.

    For example, if there are slow search actions, this issue can indicate that the table is too large. Solutions can include cleaning out redundant or obsolete entries, improve indexing, or optimizing queries.

  • Rule Publish Activity: Because RuleEngine actions are event-based and not monitored by default, a custom RuleEngine service tracks rule publish actions, then names service requests by rule name.

    The RuleEngine service also captures database calls, errors, and exceptions that occurred during rule publishing.

The Backoffice uses ZK Loader to load pages upon receiving URL requests. The ZK Loader then sends AU requests from the client to the server to notify of any occurring events.

Metrics

Metric and Source Data Captured

Simple Search

This metric breaks down and names search requests by table name.

This metric triggers when a user clicks Search in the default search view.

com.hybris.backoffice.widgets.advancedsearch.AdvancedSearchController.doSimpleSearch()
Occurrence

Advanced Search

This metric triggers when a user clicks Search in the advanced search view.

com.hybris.backoffice.widgets.advancedsearch.AdvancedSearchController.doAdvancedSearch()
Occurrence

Search Table Name

This metric extracts the table name from the parameter.

This metric triggers when a user clicks Search in either the default or advanced view, or if the user navigates to other pages using Previous/Next.

de.hybris.platform.genericsearch.impl.DefaultGenericSearchService.search()

Parameter: GenericSearchQuery.getQuery().getInitialTypeCode().toString()

Rule Publish

This metric extracts the rule name from the parameter and tracks rule publish activities by rule name.

When a user publishes a rule in Backoffice, it triggers an event. All hybris instances listen to the event and apply the rule by executing the switchKieModule() method.

Rule Engine runs in nonblocking mode in the process background. This process can be CPU expensive and result in possible issues because of excessive memory or CPU usage.

de.hybris.platform.ruleengine.init.impl.DefaultRuleEngineKieModuleSwapper.switchKieModule()

Parameter: RuleEngineActionResult.getName()