Viewing TIBCO BusinessWorks™ App Instrumentation with the API
Use the API to view TIBCO BusinessWorks App instance metrics used to monitor the app. App metrics include information such as the average, minimum, maximum, and total time elapsed since starting, the average, maximum, and total execution time, and the maximum elapsed time. You can use these statistics to create a Dashboard for your app instances.
To view app instrumentation 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/userinfomethod 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}/appsmethod. - App Instance ID — ID of the app instance to be accessed, which can be retrieved using the
GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instancesmethod. instrumentationTypeparameter — Specifies the instrumentation to be returned. If not specified, the API returns the enable/disable status of the app instance. Types include:- processstat - Breaks down the information by process, such as rawhttp_rest_soap.rawHttpReceiver1 or rawhttp_rest_soap.soap_client.
- activitystat - Breaks down the information by activity, such as Log, Sleep, SendHTTPRequest, operation, SendHTTPResponse, Timer, or HTTPReceiver.
Use the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances/{instanceId}/monitoring/bw/instrumentation method to view instrumentation for a TIBCO BusinessWorks App instance.