DataService Studio provides robust monitoring for API operations, enabling insights into abnormal impact analysis, access trends, application call statuses, detailed API operations, impact analysis, rate limiting configurations, and API alerts. This topic guides you through API monitoring processes.
Service monitoring entry
Navigate to Service > O&M from the top menu bar on the Dataphin home page.
In the left-side navigation pane, click Service Monitoring to access the Service Monitoring page.
On the Service Monitoring page, select the service project and time range in the upper right corner to view monitoring data. Time range options include Last 10 Minutes, Last 24 Hours, Last 7 Days, and Custom (up to the last 90 days).
View the maintenance dashboard
Should the API gateway in use lack log collection capabilities, it will not include failed call counts in the call statistics, nor will it be able to collect logs of these failed calls. Enabling log collection for the gateway is highly recommended to ensure comprehensive log information is captured.
Selecting a 5-minute summary for application call access trend analysis will result in a 5-minute delay in statistics.
The system automatically switches between 1-minute and 5-minute statistical logs for abnormal analysis and access trend analysis, prioritizing 1-minute call statistics when available.
Click the Maintenance Dashboard tab on the Service Monitoring page.
The maintenance overview displays metrics such as Published APIs, Online APIs, Number Of API Calls, Online API Call Rate, API Call Count, Number Of Call Exceptions, Error Rate, Offline Percentage, Exceptional APIs, Number Of Impacted Apps.
Overview Data
Description
Published APIs
The total number of APIs published to the market within the specified service project.
Online APIs
The total number of APIs that have been authorized and published within the specified service project.
Number Of API Calls
The number of APIs called within the specified service project during the specified time period.
Online API Call Rate
The total number of API calls within the specified service project during the specified time period divided by the total number of online APIs, multiplied by 100%.
API Call Count
The total number of API calls within the specified service project during the specified time period.
Number Of Call Exceptions
The total number of API call errors within the specified service project during the specified time period.
Error Rate
The total number of API call errors within the specified service project during the specified time period divided by the total number of calls, multiplied by 100%.
Offline Percentage
The total number of offline errors returned by API call errors within the specified service project during the specified time period divided by the total number of calls, multiplied by 100%.
Exceptional APIs
The total duration of API calls within the specified service project during the specified time period divided by the total number of API calls.
Impacted Apps
The number of apps with call exceptions within the specified service project during the specified time period.
View abnormal impact analysis
Within the specified time range and service project, the display features the top 10 applications affected by abnormalities and the Top 10 APIs With Call Exceptions. You can hover over a specific API's exception graph to see the number of exceptions. Alternatively, click View Call Details (call detail logs must be enabled in the system configuration) to proceed to the DataService Studio > Management > Call Logs page, where you can examine the detailed logs for the selected period.
View access trend analysis
Access trend analysis, including Exception Trend and Impact Trend, allows you to switch between 1-minute and 5-minute summaries. Hover over the graph to see specific call and exception counts.
Exception Trend: Shows the number of API calls and exceptions.
Impact Trend: Indicates the number of exceptions and impacted applications, aiding in identifying problematic APIs and apps.
View application call status
Navigate to the Service Monitoring page and select the Application Call Analysis tab.
Application operation status is displayed, including name, group, associated project, owner, attached APIs, call counts, exceptions, average response time, error rate, offline percentage, and last call time.
By clicking Actions in the Call Analysis column, you can examine the API call distribution for the specified application and carry out tasks including exporting data to Excel or reviewing call logs.
Export Call Analysis: Export application call analysis by clicking the Export To Excel button.
View Call Logs: You can perform this operation if call detail logging is active in the system configuration. To view log details for a specific time period, click View Call Logs next to the error rate, which will direct you to the DataService Studio > Management > Call Logs page.
View API operation status
Click the API Operation Analysis tab on the Service Monitoring page.
API operation status is displayed, including name, ID, associated project, authorized applications, call counts, exceptions, average response time, error rate, offline percentage, creator, and last call time.
Perform operations on the target API such as impact analysis, rate limiting configuration, alert configuration, and viewing call logs.
API Impact Analysis: Displays information on all applications that invoke the API. For more information, see API Impact Analysis.
Rate Limiting Configuration: This feature is limited to APIs in the development environment of the associated project, ensuring protection against scenarios like resource allocation shortages. For more information, see Rate Limiting Configuration.
Alert Configuration: Enables the setting of alert parameters for APIs within the associated project, allowing for the swift reception of notifications regarding API operation anomalies and facilitating rapid response. For more information, see Alert Configuration.
View Call Logs: You can perform this operation if call detail logs are activated in the system settings. To view log details for a specified time period, click View Call Logs in the Actions column. This will direct you to the DataService Studio > Management > Call Logs page.
API Impact Analysis
In the API Operation Status area, click API Impact Analysis for the desired API.
The API Impact Analysis dialog box shows all applications calling the API, including the app's name, IP address of the access source, statistical interval, call counts, exceptions, and error rate. It also presents the Top 10 impacted apps in a column chart.
IP Address of the Access Source: Includes the top 10 IPs with the most calls during the statistical period.
View Call Logs: Access detailed call logs by clicking View Call Logs after the number of exceptions. This takes you to the DataService Studio > Management > Call Logs page.
