API

1. 对外RPC接口说明

1.1. Lighthouse.init(String locators)

参数:locators,远程RPC服务配置信息

作用:用于RPC服务初始化。

1.2. LightHouse.queryGroupInfo(String token)

参数:token,统计组标识

作用:用于判断统计组是否存在和验证统计组秘钥信息。

1.3. LightHouse.queryStatInfo(int statId)

参数:statId,统计项id

作用:用于判断统计项是否存在和验证统计项秘钥信息。

1.4. LightHouse.stat(String token,final String secretKey,Map paramMap,long timestamp)

参数: token,统计组标识;secretKey,统计组秘钥;paramMap,原始消息参数信息;timestamp,消息事件时间戳;

作用:用于上报统计原始消息信息。

1.5. LightHouse.stat(String token,final String secretKey,Map paramMap,int repeat, long timestamp)

参数: token,统计组标识;secretKey,统计组秘钥;paramMap,原始消息参数信息;repeat,统计消息重复上报次数,默认为1,timestamp,消息事件时间戳;

作用:用于上报统计原始消息信息。

1.6. LightHouse.dataQuery(int statId, String secretKey, String dimensValue, long startTime, long endTime)

参数:statId,统计项标识;secretKey,统计组秘钥;dimensValue,维度信息;startTime:查询开始时间;endTime:查询结束时间;

作用:查询统计结果数据。

1.7. LightHouse.dataQuery(int statId, String secretKey, String dimensValue, List batchList)

参数:statId,统计项标识;secretKey,统计组秘钥;dimensValue,维度信息;batchList,批次时间;

作用:查询统计结果数据。

1.8. LightHouse.dataQueryWithDimensList(int statId, String secretKey, List dimensValueList, long startTime,long endTime)

参数:statId,统计项标识;secretKey,统计组秘钥;dimensValue,维度信息();batchList,批次时间;

作用:批量查询多条维度参数的统计结果数据。

dataQueryWithDimensList(int statId, String secretKey, List dimensValueList, List batchList)

参数:statId,统计项标识;secretKey,统计组秘钥;dimensValue,维度信息(没有维度参数传null,多维度统计按照统计项维度配置使用分号分割);batchList,批次时间;

作用:按照批次时间,批量查询多条维度参数的统计结果数据。

2. 其他说明

2.1. batchList参数

系统按照统计项TimeParam参数划分统计周期,使用统计周期的开始时间作为统计周期的批次时间。

比如:

  • 统计业务每分钟访问PV,则2024-05-02 13:15:00代表2024-05-02 13:15:00 至 2024-05-02 13:16:00的统计数据对应的批次时间。

  • 统计业务每2小时访问UV,则2024-05-02 14:00:00代表2024-05-02 14:00:00 至 2024-05-02 16:00:00的统计数据对应的批次时间。

  • 统计业务每天的订单量,则2024-05-02 00:00:00代表2024-05-02 00:00:00 至 2024-05-02 23:59:59的统计数据对应的批次时间。

2.2. dimensValue参数

没有维度参数传null,多维度统计按照统计项维度配置使用分号分割。

比如:

  • 查询业务每天订单金额,
<stat-item title="每天_订单金额" stat="sum(amount)" />

该示例没有统计维度则传null。

  • 查询每个各省份订单金额。
<stat-item title="每天_各省份_订单金额" stat="sum(amount)" dimens="provinceId"/>

该示例维度参数为省份,请传省份参数信息。

  • 查询每个省份各个业务线的订单金额,该示例为维度查询,请按照
<stat-item title="每天_各省份_各业务线_订单金额" stat="sum(amount)" dimens="provinceId;bizId"/>

该示例维度参数为省份和业务线,请按照provinceId;bizId的格式拼接维度参数。

results matching ""

    No results matching ""