apmmetric.get

Descrizione

integer/array apmmetric.get(object parameters)

Il metodo consente di recuperare i punti dati delle metriche in base ai parametri specificati.

Questo metodo è disponibile per gli utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
time_from timestamp Restituisce solo i punti dati il cui orario è uguale o successivo all'orario specificato.

Comportamento del parametro:
- obbligatorio
time_till timestamp Restituisce solo i punti dati il cui orario è precedente all'orario specificato.

Comportamento del parametro:
- obbligatorio
types integer/array Restituisce solo i punti dati dei tipi specificati.

Per un elenco dei tipi di metriche supportati, consultare la pagina dell'oggetto metrica APM.
with_flags_on integer Restituisce solo i punti dati che hanno impostati tutti i flag specificati.
Per specificare più flag, utilizzare la somma dei relativi valori.
with_flags_off integer Restituisce solo i punti dati che non hanno impostato nessuno dei flag specificati.
Per specificare più flag, utilizzare la somma dei relativi valori.
resource_attributes object/array Restituisce solo i punti dati con gli attributi della risorsa specificati.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutti i punti dati.

Possibili valori di operator:
0 - (predefinito) Contiene;
1 - Uguale;
2 - Non contiene;
3 - Non uguale;
4 - Esiste;
5 - Non esiste.
resource_attributes_evaltype integer Metodo di valutazione per le condizioni in resource_attributes.

Valori possibili:
0 - (predefinito) And/Or;
2 - Or.
scope_attributes object/array Restituisce solo i punti dati con gli attributi dell'ambito specificati.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutti i punti dati.

Possibili valori di operator:
0 - (predefinito) Contiene;
1 - Uguale;
2 - Non contiene;
3 - Non uguale;
4 - Esiste;
5 - Non esiste.
scope_attributes_evaltype integer Metodo di valutazione per le condizioni in scope_attributes.

Valori possibili:
0 - (predefinito) And/Or;
2 - Or.
attributes object/array Restituisce solo i punti dati con gli attributi specificati.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutti i punti dati.

Possibili valori di operator:
0 - (predefinito) Contiene;
1 - Uguale;
2 - Non contiene;
3 - Non uguale;
4 - Esiste;
5 - Non esiste.
attributes_evaltype integer Metodo di valutazione per le condizioni in attributes.

Valori possibili:
0 - (predefinito) And/Or;
2 - Or.
filter object Restituisce solo i risultati che corrispondono esattamente al filtro specificato.

Accetta un oggetto in cui le chiavi sono nomi di proprietà e i valori sono un singolo valore o un array di valori da confrontare.

Proprietà supportate: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, flags.
search object Restituisce i risultati che corrispondono al modello specificato (senza distinzione tra maiuscole e minuscole).

Accetta un oggetto in cui le chiavi sono nomi di proprietà e i valori sono stringhe da cercare. Se non vengono specificate opzioni aggiuntive, viene eseguita una ricerca LIKE "%…%".

Proprietà supportate: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_description, metric_unit.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: type, resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, start_time_unix, time_unix.
offset integer Numero di record da ignorare prima di restituire il risultato.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce:

  • un array di oggetti;
  • il numero di oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Recupero dei punti dati dell'istogramma

Recupera il punto dati più recente della metrica dell'istogramma http.server.request.duration del servizio zabbix-frontend.

Richiesta:

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

Risposta:

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

Vedi anche

Origine

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