apmtrace.get

Descrizione

integer/array apmtrace.get(object parameters)

Il metodo consente di recuperare le tracce 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 le tracce il cui span radice è iniziato al momento specificato o successivamente.

Comportamento del parametro:
- obbligatorio
time_till timestamp Restituisce solo le tracce il cui span radice è iniziato prima del momento specificato.

Comportamento del parametro:
- obbligatorio
traceids string/array Restituisce solo le tracce con gli ID specificati.
resource_attributes object/array Restituisce solo le tracce il cui span radice presenta gli attributi della risorsa specificati.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutte le tracce.

Valori possibili per 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.
span_attributes object/array Restituisce solo le tracce il cui span radice presenta gli attributi dello span specificati.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutte le tracce.

Valori possibili per operator:
0 - (predefinito) Contiene;
1 - Uguale;
2 - Non contiene;
3 - Non è uguale;
4 - Esiste;
5 - Non esiste.
span_attributes_evaltype integer Metodo di valutazione per le condizioni in span_attributes.

Valori possibili:
0 - (predefinito) And/Or;
2 - Or.
min_duration integer Restituisce solo le tracce la cui duration dello span radice è maggiore o uguale al valore specificato, in nanosecondi.
max_duration integer Restituisce solo le tracce la cui duration dello span radice è inferiore al valore specificato, in nanosecondi.
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: traceid, spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, status_code, status_message.
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 fornite opzioni aggiuntive, viene eseguita una ricerca LIKE "%…%".

Proprietà supportate: trace_state, span_name, service_name, scope_name, scope_version, status_message.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: timestamp, traceid, spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, duration, status_code, status_message.
offset integer Numero di record da ignorare prima di restituire il risultato.
countOutput boolean Questi parametri sono descritti nella documentazione 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 delle tracce lente

Recupera le due tracce più lente del servizio zabbix-nginx. Cerca le tracce dalle 10:00 alle 11:00 del 1° ottobre 2026 (UTC) e includi solo quelle con una durata di almeno 1 secondo.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "apmtrace.get",
    "params": {
        "output": ["timestamp", "traceid", "span_name", "service_name", "duration", "status_code", "span_count", "error_count"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "filter": {
            "service_name": "zabbix-nginx"
        },
        "min_duration": 1000000000,
        "sortfield": "duration",
        "sortorder": "DESC",
        "limit": 2
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "timestamp": "1790849274910226417",
            "traceid": "8a4f1c7e2b9d4e6fa0c3b5d7e9f1a2c4",
            "span_name": "POST /zabbix.php",
            "service_name": "zabbix-nginx",
            "duration": "30412907815",
            "status_code": "Error",
            "span_count": "49",
            "error_count": "2"
        },
        {
            "timestamp": "1790850512338104952",
            "traceid": "dee625f33cb0994e86c5cd4640e3b09c",
            "span_name": "POST /zabbix.php",
            "service_name": "zabbix-nginx",
            "duration": "1104826531",
            "status_code": "Unset",
            "span_count": "27",
            "error_count": "0"
        }
    ],
    "id": 1
}

Vedi anche

Origine

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