Generating Smart Engine Reports with the API

Use the API to generate reports for app instances that have Smart Engine enabled. After the report is successfully generated, download it and display it in your browser.

Note: Reports are auto-generated when trigger conditions are met, such as increased memory usage, high CPU usage, or more live threads for a specified amount of time. Therefore, you may see more reports than expected when you get the list of available Smart Engine reports.

Considerations for generating reports:

Smart Engine must be enabled for the app instance you want included in the report. See Enabling or Disabling Smart Engine with the API.

To generate a Smart Engine report you need the following:

Subscription Locator — The Subscription Locator of the Organization you want to access. To find Subscription Locators for your organizations use the GET /v1/userinfo method to return a list of all of the organizations for your OAuth Token with their Subscription Locators. You can use 0 as the Subscription Locator for the organization that owns the OAuth token.
App ID — ID of the app to be accessed, which can be retrieved using the GET /v1/subscriptions/{subscriptionLocator}/apps method.
App Instance ID — ID of the app instance to be accessed, which can be retrieved using the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances method.

Use the POST /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances/{instanceId}/bw/smartengine/reports/generate method to generate a Smart Engine report for an app instance.
Set the optional engineData parameter to true to generate an APPNODE_DATA file in the report zip file.

The engineData parameter collects engine data for the following commands:

THREAD_DUMP
HEAP_DUMP
VM_ARGUMENTS
ENVIRONMENT_VARIABLES
SYSTEM_PROPERTIES
THREAD_SNAPSHOT
MEMORY_SNAPSHOT
SYSTEM_PROCESS_INFORMATION
CPU_INFORMATION
LMETRICS
LCFG
LP
LA
LENDPOINTS
LAPI

Generating Smart Engine Reports with the API

Related Topics