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 - (по умолчанию) И/ИЛИ;
2 - ИЛИ.
scope_attributes object/array Возвращать только точки данных с указанными атрибутами области действия.
Формат: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Пустой массив возвращает все точки данных.

Возможные значения оператора:
0 - (по умолчанию) Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.
scope_attributes_evaltype integer Метод вычисления условий в scope_attributes.

Возможные значения:
0 - (по умолчанию) И/ИЛИ;
2 - ИЛИ.
attributes object/array Возвращать только точки данных с указанными атрибутами.
Формат: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Пустой массив возвращает все точки данных.

Возможные значения оператора:
0 - (по умолчанию) Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.
attributes_evaltype integer Метод вычисления условий в attributes.

Возможные значения:
0 - (по умолчанию) И/ИЛИ;
2 - ИЛИ.
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.

Примеры

Получение точек данных гистограммы

Получите последнюю точку данных метрики-гистограммы http.server.request.duration службы zabbix-frontend.

Запрос:

{
    "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
}

См. также

Источник

CApmMetric::get() в ui/include/classes/api/services/CApmMetric.php.