apmmetric.get

描述

integer/array apmmetric.get(object parameters)

此方法允许您根据给定参数检索指标数据点。

任何类型的用户都可以使用此方法。 可以在用户角色设置中撤销调用此方法的权限。 有关更多信息，请参阅用户角色。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数 类型 描述
time_from timestamp 仅返回时间大于或等于给定时间的数据点。

参数行为：
- 必需
time_till timestamp 仅返回时间早于给定时间的数据点。

参数行为：
- 必需
types integer/array 仅返回指定类型的数据点。

支持的指标类型列表，请参阅 APM 指标对象页面。
with_flags_on integer 仅返回设置了所有指定 标志 的数据点。
如需指定多个标志，请使用其值的总和。
with_flags_off integer 仅返回未设置任何指定 标志 的数据点。
如需指定多个标志，请使用其值的总和。
resource_attributes object/array 仅返回具有指定资源属性的数据点。
格式：[{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...]。
空数组将返回所有数据点。

可能的 运算符 值：
0 - （默认） 包含；
1 - 等于；
2 - 不包含；
3 - 不等于；
4 - 存在；
5 - 不存在。
resource_attributes_evaltype integer 用于评估 resource_attributes 中条件的评估方法。

可能的值：
0 - （默认） And/Or；
2 - Or。
scope_attributes object/array 仅返回具有指定作用域属性的数据点。
格式：[{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...]。
空数组将返回所有数据点。

可能的 运算符 值：
0 - （默认） 包含；
1 - 等于；
2 - 不包含；
3 - 不等于；
4 - 存在；
5 - 不存在。
scope_attributes_evaltype integer 用于评估 scope_attributes 中条件的评估方法。

可能的值：
0 - （默认） And/Or；
2 - Or。
attributes object/array 仅返回具有指定属性的数据点。
格式：[{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...]。
空数组将返回所有数据点。

可能的 运算符 值：
0 - （默认） 包含；
1 - 等于；
2 - 不包含；
3 - 不等于；
4 - 存在；
5 - 不存在。
attributes_evaltype integer 用于评估 attributes 中条件的评估方法。

可能的值：
0 - （默认） And/Or；
2 - Or。
filter object 仅返回与给定过滤器完全匹配的结果。

接受一个对象，其中键为属性名称，值为要匹配的单个值或值数组。

支持的属性：resource_schema_url、scope_schema_url、scope_name、scope_version、service_name、metric_name、metric_unit、flags。
search object 返回与给定模式匹配的结果（不区分大小写）。

接受一个对象，其中键为属性名称，值为要搜索的字符串。如果未提供其他选项，则执行 LIKE "%…%" 搜索。

支持的属性：resource_schema_url、scope_schema_url、scope_name、scope_version、service_name、metric_name、metric_description、metric_unit。
sortfield string/array 按给定属性对结果进行排序。

可能的值：type、resource_schema_url、scope_schema_url、scope_name、scope_version、service_name、metric_name、metric_unit、start_time_unix、time_unix。
offset integer 返回结果前要跳过的记录数。
countOutput boolean 这些参数在参考说明中进行了描述。
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) 返回以下内容之一：

  • 对象数组；
  • 如果使用了 countOutput 参数，则返回检索到的对象数量。

示例

获取直方图数据点

获取 zabbix-frontend 服务的 http.server.request.duration 直方图指标的最新数据点。

请求：

{
    "jsonrpc": "2.0",
    "method": "apmmetric.get",
    "params": {
        "output": ["metric_name", "metric_unit", "time_unix", "count", "sum", "min", "max", "explicit_bounds", "bucket_counts", "exemplars"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "types": 2,
        "filter": {
            "service_name": "zabbix-frontend",
            "metric_name": "http.server.request.duration"
        },
        "sortfield": "time_unix",
        "sortorder": "DESC",
        "limit": 1
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": [
        {
            "metric_name": "http.server.request.duration",
            "metric_unit": "s",
            "time_unix": "1790852390000000000",
            "count": "1842",
            "sum": "412.773",
            "min": "0.0061",
            "max": "1.098",
            "explicit_bounds": ["0.005", "0.05", "0.1", "0.25", "0.5", "1"],
            "bucket_counts": ["0", "211", "904", "512", "167", "41", "7"],
            "exemplars": [
                {
                    "traceid": "dee625f33cb0994e86c5cd4640e3b09c",
                    "spanid": "3f8b2c6d1e9a7054",
                    "value": "1.098",
                    "time_unix": "1790850513439147623",
                    "filtered_attributes": {}
                }
            ]
        }
    ],
    "id": 1
}

另请参阅

来源

ui/include/classes/api/services/CApmMetric.php 中的 CApmMetric::get()。