API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数,并以API请求发起端的环境、地域、网络等五种维度展示统计数据。

功能入口

  1. 登录ARMS控制台
  2. 在左侧导航栏单击前端监控
  3. 前端监控页面的应用列表中单击目标应用。
  4. 在左侧导航栏中单击API详情,跳转至API详情页面。

    本文将页面划分为3个区域进行说明。

    图 1. API详情
    API details

成功率

  • 成功率:从区域左上角的下拉列表中选择成功率,以折线图显示指定时间段内应用中所有API请求的成功率,对应右侧纵坐标。
  • 调用成功次数:在区域①中,以柱状图显示指定时间段内每小时的调用次数,对应左侧纵坐标。

    其中蓝色为成功次数,黄色为错误次数。

    将鼠标悬停在目标柱状图上,则显示该小时内的统计数据。例如12/02 17:00显示的是12月2日17:00至17:59的统计数据。

  • 各维度数据:在区域②中,显示指定时间段内的请求成功率在五种维度上的分布情况,维度包括操作系统设备浏览器中国省市网络制式。页面展示请求次数前五位的数据,以降序排列。例如在操作系统这一维度下,来自Android系统的请求次数最多。98.89%为来自Android系统的成功请求次数在来自Android系统的总请求次数中的比率。
    os维度
  • 筛选数据
    • 单击目标属性的条形图,例如上图中 android的条形图,页面会根据操作系统:android的条件筛选数据。区域①、②、③中均仅显示来自Android系统的请求的统计数据。
    • 也可以通过单击区域①上方的自定义筛选来选取筛选条件。API details filter
    • 也可以清除筛选条件API clear filter

成功耗时或失败耗时

  • 平均成功耗时或平均失败耗时:从区域①左上角的下拉列表中选择成功耗时失败耗时,以折线图显示指定时间段内应用中所有API的平均成功耗时或平均失败耗时,对应右侧纵坐标。
  • 成功调用总次数或失败调用总次数:在区域①中,以柱状图显示每小时的成功调用总次数或失败调用总次数,对应左侧纵坐标。

    其中蓝色为耗时 ≤1000ms的调用次数,黄色为耗时 ≥1000ms的调用次数。

    将鼠标悬停在目标柱状图,则显示该小时内的统计数据。例如12/02 17:00显示的是12月2日17:00至17:59的统计数据。

  • 耗时占比

    在区域②中,以饼图展示五种维度下,各属性的耗时占比。

    耗时占比 = 该属性的总耗时 / 站点的总耗时

    在饼图右侧以耗时从多至少的顺序列出各属性名称及其颜色标识。例如在操作系统这一维度下,来自Windows系统的请求的耗时比率最大。

    os耗时
  • 筛选数据:单击饼图上目标属性的色块,如表示windows的黄色色块,页面会根据操作系统:windows的条件筛选数据。区域①、②、③中均仅显示来自Windows的请求的统计数据。

    也可以通过单击区域①上方的自定义筛选来选取筛选条件和清除筛选条件

缓慢次数或错误次数

  • 从区域①左上角的下拉列表中选择缓慢次数错误次数,以柱状图显示指定时间段内应用中所有API的缓慢请求次数(耗时 ≥1000ms的调用次数)或错误请求次数,对应左侧纵坐标。
  • 各小时数据:将鼠标悬停在目标柱状图,则显示该小时内的统计数据。例如12/02 17:00显示的是12月2日17:00至17:59的统计数据。
  • 次数占比

    缓慢次数占比 = 该属性的缓慢次数 / 站点的总缓慢次数

    错误次数占比 = 该属性的错误次数 / 站点的总错误次数

    在区域②中,以饼图展示五种维度下,各属性的次数占比,并在饼图右侧以次数从多至少的顺序列出各属性名称及其颜色标识。例如在错误次数这一指标下,操作系统维度中,来自macOS的请求的错误次数比率最大。

    invalid request
  • 筛选数据:单击饼图上目标属性的色块,如表示macos的黄色色块,页面会根据操作系统:macos的条件筛选数据。区域①、②、③中均仅显示来自macOS的请求的统计数据。

    也可以通过单击区域①上方的自定义筛选来选取筛选条件和清除筛选条件

API请求列表

在区域③中显示各API在指定时间段内的请求情况。

  • 单击列表首行中的属性右侧的筛选图标,可对列表进行排序或者筛选。
    API list
  • 单击错误次数列的数字,显示指定时间段内错误请求的详情。
    error details
  • 单击缓慢次数列的数字,显示指定时间段内缓慢请求的详情。
    error details