O&M and monitoring enable you to monitor the API call status in the production environment over a specified time frame and project, facilitating the prompt identification and resolution of issues.
Permission description
Super administrator has access to view and manage the API call status for all DataService Studio projects.
O&M user is authorized to view and manage the API call status for the DataService Studio projects they oversee.
Service project administrator can view and manage the API call status for the service projects under their purview.
Introduction to the O&M monitoring page
By default, the O&M monitoring page displays the API call status in the production environment for the past 10 minutes, covering all service projects linked to the current account. This default view is available to super administrators, project administrators, and O&M users, helping them quickly detect and address any abnormalities. Additionally, users can customize the date range and select specific service projects for more targeted O&M monitoring data.
The O&M monitoring page provides an overview of O&M data, API call statuses, and options to configure traffic shaping and alerts for APIs:
View O&M overview: These sections provide a visual and clear presentation of various metrics such as the number of published and online APIs, API call rates, total calls, abnormal call rates, error rates, offline percentages, and the number of affected apps within a specified time period and service project. This information aids in quickly grasping the overall and abnormal API call statuses.
View abnormal impact analysis: It displays the Top 10 abnormal call times and Top 10 affected applications (APPs), allowing you to promptly understand the APIs causing abnormal impacts. You can then contact the relevant API owner, check error codes, and configure alerts and traffic shaping for the API.
View access trend analysis: It displays the trend of abnormal calls and abnormal impact trends. The abnormal call trend shows the trend of call times and abnormal call times within the time period, analyzing whether there is a correlation. The abnormal impact trend shows the trend of abnormal API calls and affected APPs within the time period. For example, if the number of abnormal API calls is small but the number of affected APPs is large, it indicates that these APIs have a wide impact and need to be fixed promptly.
View API operation status: These sections offer statistics on API data and support the analysis of abnormal API impacts, configuration of alerts, and traffic shaping.
View application call status across different applications in the application operation status area, organized by application dimension.
API impact analysis: This section showcases all applications calling a specific API and presents the Top 10 affected apps in a column chart, offering a comprehensive view of the API's reach and the extent of its impact.
Configure API traffic shaping: These tools support the implementation of traffic control for APIs and applications.
Configure API alerts: These features allow for the setting of monitoring alert rules for APIs, aiding in the quick detection and management of issues.
When you use private gateways or public gateways (with dedicated instance + SLS mode enabled), you can view number of affected APPs, Top 10 affected applications (APPs), number of affected APPs, and application call status information.
O&M monitoring entry
On the Dataphin home page, click Service in the top menu bar.
Follow the operation guide depicted below to navigate to the O&M Monitoring page.
