API请求

操作步骤

1. 登录APM控制台。
2. 单击左侧，选择“管理与监管 > 应用性能管理 APM”，进入APM服务页面。
3. 在左侧导航栏选择“前端监控 > API请求”，展示API请求的性能数据。
   图1 API请求性能数据
   
   • API失败率趋势图：展示API调用次数、慢请求占比以及API失败率。鼠标停留在折线节点处，可以展示该节点详细指标信息。
   • 调用平均耗时趋势图：展示API调用排队时间、连接时间、TTFB时间以及下载时间。鼠标停留在折线节点处，可以展示该节点详细指标信息。
   • API请求列表：展示API请求的链接、请求总数、平均请求耗时、慢请求次数、慢请求占比、错误次数、错误率。
     • 在搜索框设置输入“API”后，单击，查看满足搜索条件的API请求列表。
     • 单击列表右上角的自定义列表项，使界面上显示您需要查看的指标数据。
     • API请求列表默认按照“请求总数”降序排列。
     图2 API请求列表
     
   • 请求状态码分布：展示API请求状态码、请求总数以及请求次数占比。鼠标停留在环形图上，可以展示当前状态码的详细数量。
     单击列表右上角的自定义列表项，使界面上显示您需要查看的指标数据。

     图3 请求状态码分布
     

4. API请求列表以及请求状态码分布支持详细信息下钻。
   • API请求列表详细信息下钻。
     1. 单击“API请求列表”列中的某一条API，展示该API请求状况统计的请求总数、错误次数、错误率、慢请求次数、慢请求占比以及成功调用平均耗时。
        图4 请求状况统计
        
        1. 指定API链路追踪列表：展示指定API链路追踪列表。展示指标包括：上报时间、url、API、设备ID、会话ID、uid、tag、附加信息、请求耗时、等待耗时、连接耗时、TTFB请求时间、下载时间、API请求状态、状态码以及后台信息。
        2. 单击列表右上角的自定义列表项，使界面上显示您需要查看的指标数据。
        3. 在搜索框设置输入搜索条件后，单击，查看满足搜索条件的API链路追踪列表。
        4. 指定API链路追踪列表默认按照“上报时间”降序排列。
        5. 单击指定API链路追踪列表中，“会话ID”列的会话ID，跳转到会话追踪页面。
        6. 单击指定API链路追踪列表中，“操作”列的“分析”按钮，跳转到调用链追踪页面。
           图5 详情分析
           

           如果“分析”按钮置灰，鼠标放置在“分析”按钮上，则提示未采集到数据的原因可能有哪些。

           图6 未采集到数据的原因
           
     2. API失败率趋势图：展示指定API链路的调用次数以及API失败率。
        图7 API失败率趋势图
        

        表1 API请求相关参数说明

        参数名称	说明
        活跃用户数	访问站点用户的数量。同一个用户在一天内访问多次，只会被统计为一个UV。
        页面浏览量	页面浏览量（Page View），用户每次打开或刷新一个页面计为一次PV。
        平均加载时间	页面平均加载时间。
        JS错误数	JS错误的数量。
        慢接口占比	慢接口指加载耗时大于1000ms的调用，慢接口占比=慢接口数量/总接口数量。
        接口成功率	接口成功率=接口成功数/总接口。
        排队时间	API调用排队时间、连接时间、TTFB时间以及下载时间。
        连接时间	API调用连接时间。
        TTFB时间	API调用发出页面请求到接收到应答数据第一个字节的时间总和。
        下载时间	API调用下载时间。
        API	API请求的链接。
        请求总数	API请求的请求总数。
        平均请求耗时	API请求的平均请求耗时。
        慢请求次数	API请求的慢请求次数。
        慢请求占比	API请求的慢请求占比。
        错误次数	API请求的错误次数。
        错误率	API请求的错误率。
        状态码	调用API的状态码。
        请求次数占比	API请求次数占比。
        成功调用平均耗时	API请求成功调用平均耗时。
        上报时间	指定API链路的上报时间。
        url	指定API链路的链接。
        设备ID	指定API链路的设备ID。
        会话ID	指定API链路的会话ID。
        等待耗时	指定API链路的等待耗时。
        连接耗时	指定API链路的连接耗时。
        API请求状态	包括：正常请求，慢请求以及错误请求。
        uid	指定API链路的用户ID。
        tag	指定API链路的用户标签。
        请求耗时	指定API链路的请求耗时。
        附加信息	API请求附加信息。
        状态码	API请求状态码。
        后台信息	API请求后台信息。

   • 请求状态码分布详细信息下钻。
     1. 单击“状态码”列中，某一条状态码，展示该状态码的请求总数、错误次数、错误率、慢请求次数、慢请求占比以及成功调用平均耗时。
        图8 状态码下钻信息
        

        表2 状态码相关参数说明

        参数名称	说明
        请求总数	API请求的请求总数。
        错误次数	API请求的错误次数。
        错误率	API请求的错误率。
        慢请求次数	API请求的慢请求次数。
        慢请求占比	API请求的慢请求占比。
        成功调用平均耗时	API请求成功调用平均耗时。

        1. 指定API链路追踪列表：展示指定API链路追踪列表。展示指标包括：上报时间、url、API、设备ID、会话ID、uid、tag、附加信息、请求耗时、等待耗时、连接耗时、TTFB请求时间、下载时间、API请求状态、状态码以及后台信息。
        2. 单击列表右上角的自定义列表项，使界面上显示您需要查看的指标数据。
        3. 在搜索框设置输入搜索条件后，单击，查看满足搜索条件的API链路追踪列表。
        4. 指定API链路追踪列表默认按照“上报时间”降序排列。
        5. 单击指定API链路追踪列表中，“会话ID”列的会话ID，跳转到会话追踪页面。
        6. 单击指定API链路追踪列表中，“操作”列的“分析”按钮，跳转到调用链追踪页面。
           图9 详情分析
           

           如果“分析”按钮置灰，鼠标放置在“分析”按钮上，则提示未采集到数据的原因可能有哪些。

           图10 未采集到数据的原因
           
     2. API汇总列表。
        1. 单击“API”列，某一条API，展示该API请求状况统计的上报时间、url、API、设备ID、会话ID、uid、tag、附加信息、请求耗时、等待耗时、连接耗时、TTFB请求时间、下载时间、API请求状态、状态码以及后台信息。

           表3 指定API链路追踪相关参数说明

           参数名称	说明
           上报时间	指定API链路的上报时间。
           url	指定API链路的链接。
           API	指定API链路的请求的链接。
           设备ID	指定API链路的设备ID。
           会话ID	指定API链路的会话ID。
           uid	指定API链路的用户ID。
           tag	指定API链路的用户标签。
           附加信息	API请求附加信息。
           请求耗时	指定API链路的请求耗时。
           等待耗时	指定API链路的等待耗时。
           连接耗时	指定API链路的连接耗时。
           TTFB时间	API调用发出页面请求到接收到应答数据第一个字节的时间总和。
           下载时间	API调用下载时间。
           API请求状态	包括：正常请求，慢请求以及错误请求。
           状态码	API请求状态码。
           后台信息	API请求后台信息。

        2. 单击“请求状况统计xxx;状态码 xxx ”页面中，“操作”列的“分析”按钮，跳转到调用链追踪页面。
           图11 状态码详情分析
           

           如果“分析”按钮置灰，鼠标放置在“分析”按钮上，则提示未采集到数据的原因可能有哪些。