Performance Debugger Log
Overview
Beginning in Oracle CPQ 24D, administrators can use the new Performance Debugger REST API to create granular performance logs for Configuration configure and update actions.
If an administrator suspects there is a performance issue, they can initiate the Create a Performance Debugger Log REST API call to create a log for the desired action.
They can then use bulk download services to retrieve a CSV format log for analysis. Oracle CPQ 24D adds a new Configuration Performance Logs category to download the performance log.
The Id returned in the Create a Performance Debugger Log REST API response is used to identify the Configuration Performance Log to be downloaded.
The log will record the Time (in milliseconds) for the associated rule conditions and actions.
Administration
Create Performance Debugger Log
Complete the following steps to create a Configuration Performance Debugger Log.
-
Initiate a Create a Performance Debugger Log REST API web service call for the desired action.
URI Endpoint Sample
https://sitename.oracle.com/rest/v18/performanceDebuggerer/actions/createLog
Request Body Sample - Add to an Existing Transaction
{
"actionName": "CONFIG_ADD_TO_TXN" ,
"favoriteId": 3023525714,
"bsid" : 3023337829
}
Request Body Sample - Add to Cart
{
"actionName": "CONFIG_ADD_TO_CART",
"favoriteId": 3023525714,
"invocationId": 6993047
}
Request Body Sample - Configure
{
"actionName": "CONFIG_CONFIGURE",
"description": "CONFIGURE: Vision Vehicles SUV",
"productFamily": "visionVehicles",
"productLine": "consumerVehicles",
"model": "sUV"
}
Note: You can retrieve the Product Family, Product Line, and Model variable names from the product configurator URL.
For example, http://sitename.oracle.com/config/visionVehicles/consumerVehicles/sUV?product_line=consumerVehicles&segment=visionVehicles&_from_punchin=true&model=sUV&_has_jet_access=true
In this URL the configuration variable names are:
- Product Family: visionVehicles
- Product Line: consumerVehicles
- Model: sUV
Request Body Sample - Create a New Transaction from Configuration (i.e. Invocation)
{
"favoriteId": 3023525714,
"invocationId": 12068225,
"actionName": "CONFIG_INVOKE"
}
Request Body Sample - Reconfigure (Inbound)
{
"bsId": 12068225,
"documentNumber": 2,
"actionName": "CONFIG_RECONFIGURE"
}
Request Body Sample - Reconfigure and Save
{
"actionName": "CONFIG_SAVE_AFTER_RECONFIGURE",
"bsid" : 3023337829,
"documentNumber": 2
}
Request Body Sample - Update
{
"description": "This is a test payload",
"favoriteId": 18350193,
"actionName": "CONFIG_UPDATE"
}
Note: You can create a Favorite, and go to that Favorite to extract the favorite id.
For example, http://sitename.oracle.com/commerce/favorites/detail/3023244929
In this URL the favoriteId is: 3023244929
Response Body Sample
{
"id": "3034221367"
}
-
Copy the id from the response.
-
Navigate to Admin > Bulk Data Services > Download.
-
Select Configuration Performance Logs, and then click Next.
-
Enter the id from the Create a Performance Debugger Log REST API response, and then click Download.
-
When the download task is complete, click on the Model link to download the debugger log to your local system.
-
Navigate to downloaded zip file, and then unzip the file to view the downloaded CSV log file.
Related Topics
See Also