微信接口

背景

为了打造更强大的小程序生态，简化小程序开发难度，微信官方提供了丰富的 API 接口，包括登录、支付、扫码等等，且这些微信官方接口往往是非常重要的能力，成功与否直接影响业务的正常运转，例如支付接口，可能会因为微信官方接口异常或商家生成订单系统异常进而返回支付参数不正确导致支付流程失败，故针对微信接口调用成功率的监控是非常必要的。

支持情况说明

默认监控接口

默认情况下，支付接口（requestPayment）、扫码接口（scanCode）、图片全屏预览（previewImage）三个接口实现了自动监控，用户只需使用含1.2.0版本以上探针，即可自动获取数据。

自定义监控接口

本模块可实现对微信官方提供的全部小程序 API 进行监控，用户可基于自身需求，通过探针初始化配置中 hookApis 指定想要监控的接口名(不需要写wx.前缀)，即可监控自定义需要监控的接口。

示例(只监控requestPayment接口)：

const monitor = require('./agent/tingyun-mp-agent.js');
monitor.config({
    ...,
    hookApis: ['requestPayment']
})

注意：

• 对于request接口，由单独的请求模块监控，此处配置将被忽略。

• 自定义监控接口提供 success, fail 回调的情况下才能监控成功、失败次数，否则只能监控调用次数。

指标说明

指标名称	指标定义
接口调用数	接口被调用的次数
接口调用成功率	（接口调用成功次数/接口调用总次数）*100%
接口影响用户数	用户从打开小程序到主动关闭或超时退出小程序的过程中调用该接口失败过至少超过一次的用户数。
接口失败用户数	用户从打开小程序到主动关闭或超时退出小程序的过程中调用该接口未成功过的用户数，一次或多次尝试都失败，到离开时也未成功。

报表说明

接口列表

展示列表展示接口的名称、调用次数、错误次数、成功率、影响用户数、失败用户数，且可搜索接口名称和各个指标排序。

接口详情

该模块展示分析接口调用详情，包含接口调用成功率趋势以及每条接口调用请求的记录。可基于用户 userid、IP 检索，查询调用记录。

• 详情列表

  展示调用接口的用户详情数据，包含成功、失败和取消三种类型。