跳至主内容

获取推送事件统计

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

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

警告

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

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

参数

无需输入参数。

返回值

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

属性

类型

描述

result

Object

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

count

Object

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

errorMessages

Integer

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

events

Integer

已发送事件总数。

sentMessages

Integer

成功发送的消息总数。

testEvents

Integer

使用 sendTestPushEvent 方法。

sentBytes

整数

HTTP请求正文总大小的总和(使用时),以字节为单位。

注意

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

error

整数

接收到的错误总数。

connectionError

整数

接收到的连接错误总数。

configurationError

整数

接收到的配置错误总数。

serviceError

整数

接收到的服务错误总数。

statusCode2xx

整数

返回2xx状态码的次数。

statusCode300

整数

返回3xx状态码的次数。

statusCode400

整数

返回4xx状态码的次数。

statusCode500

整数

返回5xx状态码的次数。

timeout

整数

请求超时的次数。

lastUpdateTime

整数

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

max

对象

表示存储待发送事件的缓冲区的状态。

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

messageQueueBytes

整数

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

messageQueueLength

整数

自上次使用 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
        }
    }
}