Monitor app performance and adherence to a defined API access contract.
Dashboard
The Admin Team may issue alerts from time to time to notify platform members of issues, such as scheduled downtime sessions, that may impact application development. You can monitor alerts in your Dashboard.
Alert notifications are posted on your Dashboard page and are identified with API Name, Title, Environment (i.e., Sandbox, Production), Status, Priority, Creator ID, and Created Date/Timestamp.
You can comment on an alert directly from the Dashboard or you can double-click the alert entry to view and manage it in the associated API Board.
API Board
Alerts can be viewed in the API Board. You can filter posts to view alerts, sort by Most Popular, Most Marked, or Most Recent, and comment on an alert.
Performance Charts and Usage Logs
App performance including service response time, adherence to defined API Access Contracts, and transaction faults can be monitored and viewed in performance charts. Usage logs that include request and response message data for API, App, and Contract activity can be queried and viewed. See How do I monitor app performance?
You can respond to notifications directly in the Dashboard by using the sort filters to target your entry in the Dashboard, or by clicking the notification to display its Board entry. You can then respond to the notification. For a list of response options to posts or tickets, see Post/Ticket Management.
You can configure your account to receive email notifications when certain platform activities occur. Notifications can be updated on the User Settings page. The default state for notifications is enabled.
The Admin Team may send alert notifications from time to time about API maintenance announcements, API related news, etc. Alert notices are posted in the API Board of the API to which the alert pertains.
The Apps > Monitor > Overview section includes a barometer style Dashboard controls that allows you to view throughput, latency, and errors for messages in real-time for Sandbox and Production environments of APIs your app is connected to. Statistics are calculated for all APIs that you app is connected to, and for all operations included in the APIs. You can obtain statistics on a per-second or per-minute basis. The Dashboard displays statistics for the last 24 hours.
The Dashboard controls scale based on the number of messages received and the time interval selected (sec or min). For example, 50 messages were transmitted for your API in the last 5 seconds; the scale will change to 0-60.
The Dashboard provides the following control types:
Usage data is further categorized by API Usage and can be exported. See How do I export API usage data for APIs that my App is connected to?
Performance charts are included in the My Apps > Monitorpage. They provide a mechanism for all platform members to view the performance of their apps and the APIs their apps are consuming. Chart data can be used to monitor API usage over a span of time or to troubleshoot errors with API operation.
The Performance Chart functionality allows you to view performance in sandbox or production modes, provides monitoring for tracking service response time and transaction faults. Charts are populated by usage "roll-up" data that is gathered during the processing of web service request and response messages. Historic usage and performance data can be queried and viewed in the Usage Logs section. See How do I monitor app usage logs?
Performance Charts automatically scale the Y axis to show an appropriate range for the data shown. You can choose to scale to the average (i.e., default) based on the selected interval or set your own scaling.
Note: Updating of chart performance statistics using Refresh is based on your selected Duration and Interval which represents the total time range displayed.
Chart Types
The following performance charts types are supported. All chart data is presented in milliseconds (ms).
| Chart Name | Description |
|---|---|
| Min / Max / Avg Response Time | Minimum, Maximum, and Average Response Times for transactions are depicted in a candlestick bar chart on the Y axis. You can also hover over each time interval and view a Datapoint Pop-up that displays the Date, Time, Average, Max, and Min Response time of the transaction for the selected time interval. |
| Success / Fault Throughput | Successful transactions and faults are depicted in a single chart with two Y axes. Successful transactions are depicted in a column chart. A vertical bar displays the number of transactions that have successfully processed for the selected response time range. Faults are depicted in a scatter chart. A red dot represents the number of Faults associated with a specific time interval. |
Time Range
The Performance Chart includes a navigation control (located at the bottom of the chart) that allows you to navigate the Timeline based on the selected Duration and Time Interval. Throughput data can also be monitored on the timeline and is presented in a spline chart.
After you have targeted a timeline, there are several ways to view additional chart detail. The Zoom feature allows you to view chart data by clicking on a pre-defined interval (1 hour, 3 hour, 6 hour, 12 hour, All). The Data Point Popup allows you to hover over a specific datapoint to view response data detail including Date, Time, Average, Max, and Min.
Graph Controls
The Graph Controls section of a Performance Chart provides options for configuring the chart content (i.e., a specific API, or all APIs), data capture and display intervals (i.e., Duration and Interval), and navigating and zooming the chart Timeline. Each chart displays data based on the currently approved environment (i.e., Sandbox or Production).
| Field Name | Description |
|---|---|
| Duration | A drop-down menu that allows you to select the time interval to summarize report data. Options include 5 minutes, 15 minutes, 1 hour, 1 day, 1 week, 1 month, and 1 year. When you select a new duration, the Performance Chart data is automatically refreshed. |
| Interval | A drop-down menu that allows you to select the interval that the Performance Chart Timeline will present the data. Options adjust based on selected Duration. |
| Zoom | A button control that allows you to view chart data in pre-defined intervals of All, 1 hour, 3 hours, 6 hours, and 12 hours. Note that selecting All can be used to reset the chart display to the current time based on the selected Duration and Interval. |
| Refresh | A button that updates the chart data to the current time. |
| A button that allows you to print the current chart by loading the chart into the browser and launching the print dialog. |
My Apps includes a Monitor > Logs section that provides options for filtering and viewing usage logs associated with API activity that has occurred in either the platform production and sandbox environments.
| Field Name | Description |
|---|---|
| Duration | A drop-down menu that allows you to select a time period for gathering report data. Options include 5 minutes, 1 hour, 1, day, or custom date range. |
| Time Period | From / To field displays that allow you to select a date range to monitor performance from a calendar pop-up. The ability to specify a date as filter criteria is enabled when the Duration drop-down menu is set to "Custom." To configure a Time Period, click in the From: and To: fields and select a date from the Calendar Pop-up. The date is automatically entered in YYYY-MM-DD format. |
| Field Name | Description |
|---|---|
| Sent | The request date and request time (in milliseconds) when the request was received. This field is hyperlinked to a Usage Log Details report for the selected log record. |
| API | The API associated with the request. This field is hyperlinked to the API Details page of the selected API. |
| Method | The method associated with the request. |
| Result | The transaction result error code (i.e., successful, with errors, etc.). |
Usage Log Details (Transport Header)
| Field Name | Description |
|---|---|
| API | The name of the API the message is associated with. |
| Method | The name of API method the message is associated with. |
| URL | The URL of the RESTful web services whose method is being used. |
| Client Host | The host name of the client who made the request. |
| Time Sent | The request date and request time (in milliseconds) when a request is made. |
| Time Taken | The request date and request time (in milliseconds) when a request is made. |
| Status Code | The HTTP response status code. |
| Message Content | Request Message and Response Message content. |
Usage Log Details (Transport Headers for Request Message)
| Field Name | Description |
|---|---|
| Request Method | Method used by browser to send request to server (e.g., POST, GET, PUT or DELETE). |
| Accept-Encoding | The compression schema used for encoding data. |
| Authorization | Authentication credentials for HTTP authentication. |
| Content-Type | The length of the request body in octets. |
| User Agent | A media type is composed. |
| Host | The domain name of the server. |
| Message | The request message body. |
Usage Log Details (Transport Headers for Response Message)
| Field Name | Description |
|---|---|
| Date | The date and time that the message was sent. |
| Content-Type | A media type is composed. |
| Cache-Control | Tells all caching mechanisms from server to client whether they may cache the object. It is measured in seconds. |
| Expires | Displays the date/time after which the response is considered out-of-date. |
| Transfer-Encoding | The form of encoding used to transfer the entity to the user (e.g., deflate, gzip, etc.). |
| Message | The response message body. |
The monitoring process captures your app's usage data for the APIs it is connected to. The API Usage section includes an Export function that allows you to export usage data in a .csv file. You can open the .csv file into a selected application or download the .csv to your Downloads folder. Data to be exported is based on statistics gathered in the last 24 hours.