跳至主内容

获取推送事件统计

此方法用于获取推送事件统计数据和错误信息。

当HTTP收集器未使用SSL证书,或 设置推送事件配置 方法未使用HTTP收集器生成的授权标头时,会出现配置错误。必须满足这些前提条件才能成功使用事件推送服务。

警告

通过事件推送服务API发送但未能成功投递的事件会保存在缓冲区中,该缓冲区最多可容纳1000条消息。

当计数器超过1000条消息且消息仍无法投递时,事件推送服务将自动停止尝试发送消息,并将 状态 属性重置为 0 (禁用)。

参数

无需输入参数。

返回值

该方法返回一个包含推送事件统计信息的对象。

属性

类型

描述

result

Object

该对象提供推送事件服务发送或接收的所有消息及错误的综合统计信息。统计时间范围从服务激活时至请求发起时。

count

Object

该对象提供推送事件消息的总体统计数据。

errorMessages

Integer

事件推送服务发送的导致错误的消息总数。

events

Integer

已发送事件总数。

sentMessages

Integer

成功发送的消息总数。

testEvents

Integer

通过 sendTestPushEvent 方法生成的测试事件数量。

sentBytes

Integer

HTTP请求正文(如使用)的总大小之和(单位:字节)。

注意

该属性不包含HTTP请求头数据的大小。

error

Integer

接收到的错误总数。

connectionError

Integer

接收到的连接错误总数。

configurationError

Integer

接收到的配置错误总数。

serviceError

Integer

接收到的服务错误总数。

statusCode2xx

Integer

返回2xx状态码的次数。

statusCode300

Integer

返回3xx状态码的次数。

statusCode400

Integer

返回4xx状态码的次数。

statusCode500

Integer

返回5xx状态码的次数。

timeout

Integer

请求超时的次数。

lastUpdateTime

整数

事件推送统计信息最后一次更新的时间。

最大值

对象

表示用于存储排队等待发送的事件的缓冲区的状态。

该缓冲区存储了所有发送失败并被排队等待稍后发送的事件。统计信息可以通过 resetPushEventStats 方法清除。

消息队列字节数

整数

自上次使用 resetPushEventStats 方法以来,排队等待发送的消息大小的总和。

消息队列长度

整数

自上次使用 resetPushEventStats 方法以来,排队等待发送的消息数量的总和。

注意

缓冲区最多可容纳1000个事件。

示例

请求 :

{
       "params": {},
       "jsonrpc": "2.0",
       "method": "getPushEventStats",
       "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
  }

响应 :

{
    "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb",
    "jsonrpc": "2.0",
    "result": {
        "count": {
            "errorMessages": 12,
            "events": 2182,
            "sentMessages": 21,
            "testEvents": 0,
            "sentBytes": 954586
        },
        "error": {
            "configurationError": 0,
            "connectionError": 7,
            "serviceError": 0,
            "statusCode2xx": 0,
            "statusCode300": 0,
            "statusCode400": 5,
            "statusCode500": 0,
            "timeout": 0
        },
        "lastUpdateTime": "2024-02-08T09:29:39",
        "max": {
            "messageQueueBytes": 933694,
            "messageQueueLength": 8
        }
    }
}