ArkClaw 企业版基于应用性能监控提供完整的指标查询能力，除基础可视化看板之外，应用性能监控提供了指标统一的查询接口，可根据实际需求自定义查询指标信息。本文以 arkclaw_enterprise_total_token_usage_sum 预置指标为例为您介绍如何查询 ArkClaw 企业版指标信息。

背景信息

可使用应用性能监控提供的 Draw 接口，进行 ArkClaw 企业版的指标数据查询。

项
值
接口名
Draw，指标绘图查询
Action
Draw
Version
2022-11-09
文档
Draw 接口帮助文档
协议
HTTPS POST，Body 为 JSON

预置指标 arkclaw_enterprise_total_token_usage_sum 的基础信息参考。

分类	说明
预置指标	arkclaw_enterprise_total_token_usage_sum
指标含义	Arkclaw 实例输入、输出、缓存 Token 消耗总量。
分组维度	根据实际需求配置分组维度，可选字段包含： service：实例 ID user_email：用户邮箱 user_name：用户名称 user_department：用户部门 claw_space_id：Claw 空间 ID openclaw_token：Token类型 openclaw_channel：渠道 openclaw_provider：服务提供方 openclaw_model：模型

使用限制

虽然 Draw 同时支持「预置指标查询」和「PromQL 查询」两种模式，但由于 Arkclaw 企业版指标中的用户信息来自外部接口或底层打点关联，因此，无法直接使用 promql 查询，只能使用预置指标查询。

查询示例

由于接口参数较为复杂，为了减少调试成本，本文以 arkclaw_enterprise_total_token_usage_sum 预置指标为例，为您介绍预置指标查询中几种常见的查询示例。

示例一：单值查询/瞬时查询

示例二：时间序列查询

本示例以 Token 总量汇总查询为例进行说明，

注意

单值查询请求中的参数需要指定 "instant": true ，返回结果为 Table 格式。

通过修改 metric 查询指定的指标，查询 Arkclaw 指标时，直接将 metric_category 指定为 claw 即可。

通过修改 filters 设置过滤条件， group_by_fields 可以指定分组维度。

通过修改 start_time 、end_time 指定查询时间范围。

请求示例

说明

若 ArkClaw 实例存在自定义标签，filters 中可使用此标签进行数据筛选；group_by_fields 中可使用此标签进行分组查询。ArkClaw 实例自定义标签相关更多说明参见：标签管理。

返回示例

该查询的返回格式如下，重点关注返回中的 Columns 和 Rows。每次只查询一个指标的场景，Columns 最后一列固定为查询的结果值，前列则是相关的属性信息；ValueColumns 标识哪些列是指标值列。

Columns：结果中每一列的含义。

Rows：每个元素代表一行结果，其中，每一列的含义与 Columns 一一对应。

本示例以 Token 总量趋势查询为例进行说明。

注意

时间序列查询请求中，graph_type 参数需指定 time_series，该请求会返回时间序列格式的数据，每条时间序列包含按时间粒度对齐的数据点和对应的标签信息。

通过修改 metric 查询指定的指标，查询 Arkclaw 指标时，直接将 metric_category 指定为 claw 即可。

通过修改 filters 设置过滤条件， group_by_fields 可以指定分组维度。

通过修改 start_time 、end_time 指定查询时间范围。

请求示例

说明

若 ArkClaw 实例存在自定义标签，filters 中可使用此标签进行数据筛选；group_by_fields 中可使用此标签进行分组查询。ArkClaw 实例自定义标签相关更多说明参见：标签管理。

返回示例

该查询的返回格式如下，重点关注返回中的 TimeSeries。其中，TimeSeries 中的每个对象是一条时间序列；Points 是这条时间序列中每个点的时间与对应的值；TagKvs 是这条时间序列所有的属性信息。

说明

若 ArkClaw 实例存在自定义标签，filters 中可使用此标签进行数据筛选；group_by_fields 中可使用此标签进行分组查询。

项	值
接口名	Draw，指标绘图查询
Action	Draw
Version	2022-11-09
文档	Draw 接口帮助文档
协议	HTTPS POST，Body 为 JSON

全栈可观测平台