apmspan.get

Descrizione

integer/array apmspan.get(object parameters)

Il metodo consente di recuperare gli span 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 gli span iniziati all'ora specificata o successivamente.

Comportamento del parametro:
- obbligatorio
time_till timestamp Restituisce solo gli span iniziati prima dell'ora specificata.

Comportamento del parametro:
- obbligatorio
traceids string/array Restituisce solo gli span appartenenti alle trace specificate.
spanids string/array Restituisce solo gli span con gli ID specificati.
parent_spanids string/array Restituisce solo gli span con gli span padre specificati.
resource_attributes object/array Restituisce solo gli span con gli attributi della risorsa specificati.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutti gli span.

Valori possibili di operator:
0 - (predefinito) Contiene;
1 - Uguale;
2 - Non contiene;
3 - Diverso da;
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 gli span con gli attributi dello span specificati.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutti gli span.

Valori possibili di operator:
0 - (predefinito) Contiene;
1 - Uguale;
2 - Non contiene;
3 - Diverso da;
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 gli span la cui durata è maggiore o uguale al valore specificato, in nanosecondi.
max_duration integer Restituisce solo gli span la cui durata è 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, parent_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 specificate 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, parent_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 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 della gerarchia degli span di una traccia

Recupera i primi quattro span della traccia "dee625f33cb0994e86c5cd4640e3b09c", ordinati in base all'ora di inizio. La proprietà parent_spanid mostra la relazione tra gli span: lo span radice non ha un elemento padre, mentre ogni altro span fa riferimento allo span che lo ha avviato.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "apmspan.get",
    "params": {
        "output": ["spanid", "parent_spanid", "service_name", "span_name", "duration", "status_code"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "traceids": "dee625f33cb0994e86c5cd4640e3b09c",
        "sortfield": "timestamp",
        "sortorder": "ASC",
        "limit": 4
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "spanid": "7c1a9e2f4b6d8a03",
            "parent_spanid": "",
            "service_name": "zabbix-nginx",
            "span_name": "POST /zabbix.php",
            "duration": "1104826531",
            "status_code": "Unset"
        },
        {
            "spanid": "3f8b2c6d1e9a7054",
            "parent_spanid": "7c1a9e2f4b6d8a03",
            "service_name": "zabbix-frontend",
            "span_name": "POST /zabbix.php",
            "duration": "1098230418",
            "status_code": "Unset"
        },
        {
            "spanid": "b3390ad41931ed08",
            "parent_spanid": "3f8b2c6d1e9a7054",
            "service_name": "zabbix-frontend",
            "span_name": "mysqli::real_connect",
            "duration": "36671360",
            "status_code": "Ok"
        },
        {
            "spanid": "e41f7a2c9d5b3086",
            "parent_spanid": "3f8b2c6d1e9a7054",
            "service_name": "zabbix-frontend",
            "span_name": "mysqli_query",
            "duration": "19704118",
            "status_code": "Ok"
        }
    ],
    "id": 1
}

Vedi anche

Origine

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