apmmetric.get

Opis

integer/array apmmetric.get(object parameters)

Metoda umożliwia pobieranie punktów danych metryki zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
time_from timestamp Zwraca tylko punkty danych, których czas jest równy podanemu czasowi lub późniejszy.

Zachowanie parametru:
- wymagany
time_till timestamp Zwraca tylko punkty danych, których czas jest wcześniejszy niż podany czas.

Zachowanie parametru:
- wymagany
types integer/array Zwraca tylko punkty danych podanych typów.

Lista obsługiwanych typów metryk znajduje się na stronie obiektu metryki APM.
with_flags_on integer Zwraca tylko punkty danych, dla których ustawione są wszystkie podane flagi.
Aby określić kilka flag, użyj sumy ich wartości.
with_flags_off integer Zwraca tylko punkty danych, dla których nie jest ustawiona żadna z podanych flag.
Aby określić kilka flag, użyj sumy ich wartości.
resource_attributes object/array Zwraca tylko punkty danych z podanymi atrybutami zasobu.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie punkty danych.

Możliwe wartości operatora:
0 - (domyślnie) Zawiera;
1 - Jest równe;
2 - Nie zawiera;
3 - Nie jest równe;
4 - Istnieje;
5 - Nie istnieje.
resource_attributes_evaltype integer Metoda oceny warunków w resource_attributes.

Możliwe wartości:
0 - (domyślnie) And/Or;
2 - Or.
scope_attributes object/array Zwraca tylko punkty danych z podanymi atrybutami zakresu.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie punkty danych.

Możliwe wartości operatora:
0 - (domyślnie) Zawiera;
1 - Jest równe;
2 - Nie zawiera;
3 - Nie jest równe;
4 - Istnieje;
5 - Nie istnieje.
scope_attributes_evaltype integer Metoda oceny warunków w scope_attributes.

Możliwe wartości:
0 - (domyślnie) And/Or;
2 - Or.
attributes object/array Zwraca tylko punkty danych z podanymi atrybutami.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie punkty danych.

Możliwe wartości operatora:
0 - (domyślnie) Zawiera;
1 - Jest równe;
2 - Nie zawiera;
3 - Nie jest równe;
4 - Istnieje;
5 - Nie istnieje.
attributes_evaltype integer Metoda oceny warunków w attributes.

Możliwe wartości:
0 - (domyślnie) And/Or;
2 - Or.
filter object Zwraca tylko te wyniki, które dokładnie odpowiadają podanemu filtrowi.

Przyjmuje obiekt, w którym kluczami są nazwy właściwości, a wartościami pojedyncza wartość lub tablica wartości, z którymi należy porównać wyniki.

Obsługiwane właściwości: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, flags.
search object Zwraca wyniki pasujące do podanego wzorca (bez uwzględniania wielkości liter).

Przyjmuje obiekt, w którym kluczami są nazwy właściwości, a wartościami ciągi znaków, których należy szukać. Jeśli nie podano dodatkowych opcji, wyszukiwanie będzie wykonywane za pomocą LIKE "%…%".

Obsługiwane właściwości: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_description, metric_unit.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: type, resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, start_time_unix, time_unix.
offset integer Liczba rekordów pomijanych przed zwróceniem wyniku.
countOutput boolean Parametry te opisano w komentarzu referencyjnym.
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Wartości zwracane

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli użyto parametru countOutput.

Przykłady

Pobieranie punktów danych histogramu

Pobierz najnowszy punkt danych metryki histogramu http.server.request.duration usługi zabbix-frontend.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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