管理运维监控API

为了保障应用能够正常调用API,同时能够保护系统,数据服务支持监控API的运行情况,便于及时处理异常指标。本文为您介绍如何监控API。

使用限制

  • 当使用的API网关未开通日志采集时,网关的失败的调用次数不会计入调用统计,也无法采集调用失败的日志,强烈建议使用的网关配置日志采集以采集完整的日志信息

  • 应用调用的访问趋势分析若选择5分汇总,那么系统会每5分钟进行一次统计,因此会有5分钟的延迟。

  • 异常分析和访问趋势分析根据是否可获取1分钟统计日志和5分钟统计日志进行自动切换,系统优先使用1分钟调用统计。

运维监控入口

  1. Dataphin首页的顶部菜单栏,选择服务 > 运维

  2. 在左侧导航栏单击运维监控,进入运维监控页面。

  3. 运维监控页面,查看所选项目下特定时间范围内的运维监控数据,在右上角选择所属服务项目及时间范围,支持的时间范围为近十分钟24小时7自定义(可选择最近90天)。

查看运维大盘

  1. 运维监控页面,单击顶部菜单栏的运维大盘页签。

  2. 您可以分别查看同步调用和异步调用的运维总览数据。

    总览数据

    描述

    API数核心指标

    (同步调用和异步调用指标一致)

    发布API

    指定服务项目内所有发布到市场上的API总数。

    在线API

    指定服务项目内所有已授权应用且已发布的API总数。

    调用API

    在指定时间段内,指定服务项目内所有调用API的个数。

    调用异常API

    在指定时间段内,指定服务项目内API调用总时长/API调用总次数。

    API调用次数核心指标

    API调用次数

    在指定时间段内,指定服务项目内所有API的调用总次数。

    调用异常次数

    在指定时间段内,指定服务项目内所有API的调用错误总次数。

    调用异常率

    在指定时间段内,指定服务项目内所有API的调用错误总次数/调用总次数*100%。

    offline异常次数

    在指定时间段内,指定服务项目内API调用错误返回offline错误总次数。

    offline异常率

    在指定时间段内,指定服务项目内API调用错误返回offline错误总次数/调用总次数*100%。

    公共API调用

    仅异步调用可查看该指标。在指定时间段内,指定服务项目内公共API的调用次数按照项目级别统计。所依赖的公共API如下:

    • GetJobRequestStatus:获取API调用的执行状态。

    • GetJobRequestResult:获取API调用后返回请求的结果。

    • GetJobExecutionLog:获取API执行的日志。

    • CloseJobRequest:完成API的查询请求。

    • CancelJobRequest:取消API的查询请求。

查看异常影响分析

查看指定服务项目在指定时间段内所有API调用异常的APP数,包含同步调用和异步调用,可在应用调用分析详情中查看。

为您展示服务项目下所有API异常影响APP排行TOP10,同时您可以单击操作列下的查看调用详情(需在系统配置中开启调用明细日志),跳转至数据服务 > 运维 > 调用日志页面查看所选时间范围内的日志详情。

image

查看访问趋势分析

访问趋势分析包括调用异常趋势调用异常影响趋势,您可以切换最近1分钟汇总或最近5分钟汇总的访问趋势分析数据。鼠标悬停至异常图上查看某一时间点的调用次数和调用异常次数。

  • 调用异常趋势:为您展示应用调用API的次数及调用API异常的次数。

  • 调用异常影响趋势:为您展示API调用异常影响次数及API调用影响的应用数,帮助您发现及处理调用异常的APIAPP。

    image

公共API趋势分析

仅异步调用模式可查看公共API趋势分析,包括访问趋势分析异常趋势分析,您可以切换最近1分钟汇总或最近5分钟汇总的公共API趋势分析数据。鼠标悬停至折线图查看某一时间点的公共API调用次数。

  • 访问趋势分析:为您展示当前项目下公共API调用的次数。

  • 异常趋势分析:为您展示当前项目下公共API调用的异常次数,帮助您发现及处理调用异常的公共API。

image

查看应用调用情况

  1. 运维监控页面,单击应用调用分析页签。

  2. 应用运行情况以应用为维度为您展示应用名称、应用分组、所属服务项目、负责人、绑定API数、调用次数、调用异常次数、平均调用时长、错误率、offline百分比、最近调用时间。

  3. 您可以单击操作列下的调用分析,查看目标应用的每个API的调用分布情况,并可对调用分析执行导出Excel和查看调用日志操作。

    • 导出调用分析:单击右上角的导出Excel按钮,导出应用的调用分析。

    • 查看应用调用分析:支持查看APP应用下在指定时间段和服务项目内API的应用调用分析详情,包含同步调用和异步调用。同时,您可以单击错误率后的查看调用日志(需在系统配置中开启调用明细日志),跳转至数据服务 > 运维 > 调用日志页面查看所选时间范围内的日志详情。

查看API运行情况

  1. 运维监控页面,单击API运行分析页签。

  2. API运行情况以API为维度为您展示API的名称及ID、所属服务项目、调用模式、授权应用数、调用次数、调用异常次数、平均调用时长、错误率、offline百分比、创建人、最近调用时间。

  3. 您可以对目标API执行如下操作。

    • 限流设置:仅支持对开发环境下所属项目的API进行限流设置,防止资源分配不足等场景,详情请参见限流设置

    • 告警设置:支持对所属项目的API设置告警设置,可及时接收API运行异常信息,快速做出响应,详情请参见告警设置

    • 查看调用日志:当在系统配置中开启调用明细日志时支持该操作。单击操作列下的查看调用日志,跳转至数据服务 > 管理 > 调用日志页面查看所选时间范围内的日志详情。

image