apmtrace.get

Apraksts

integer/array apmtrace.get(object parameters)

Šī metode ļauj izgūt izsekošanas datus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama visu veidu lietotājiem. Atļaujas izsaukt šo metodi var atsaukt lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
time_from timestamp Atgriezt tikai tās izsekošanas, kuru saknes spans sākās norādītajā laikā vai vēlāk.

Parametra darbība:
- obligāts
time_till timestamp Atgriezt tikai tās izsekošanas, kuru saknes spans sākās pirms norādītā laika.

Parametra darbība:
- obligāts
traceids string/array Atgriezt tikai izsekošanas ar norādītajiem ID.
resource_attributes object/array Atgriezt tikai tās izsekošanas, kuru saknes spanam ir norādītie resursa atribūti.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visas izsekošanas.

Iespējamās operatora vērtības:
0 - (noklusējums) Satur;
1 - Ir vienāds ar;
2 - Nesatur;
3 - Nav vienāds ar;
4 - Pastāv;
5 - Nepastāv.
resource_attributes_evaltype integer Novērtēšanas metode nosacījumiem parametrā resource_attributes.

Iespējamās vērtības:
0 - (noklusējums) And/Or;
2 - Or.
span_attributes object/array Atgriezt tikai tās izsekošanas, kuru saknes spanam ir norādītie spana atribūti.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visas izsekošanas.

Iespējamās operatora vērtības:
0 - (noklusējums) Satur;
1 - Ir vienāds ar;
2 - Nesatur;
3 - Nav vienāds ar;
4 - Pastāv;
5 - Nepastāv.
span_attributes_evaltype integer Novērtēšanas metode nosacījumiem parametrā span_attributes.

Iespējamās vērtības:
0 - (noklusējums) And/Or;
2 - Or.
min_duration integer Atgriezt tikai tās izsekošanas, kuru saknes spana duration ir lielāks par norādīto vērtību vai vienāds ar to (nanosekundēs).
max_duration integer Atgriezt tikai tās izsekošanas, kuru saknes spana duration ir mazāks par norādīto vērtību (nanosekundēs).
filter object Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram.

Pieņem objektu, kurā atslēgas ir rekvizītu nosaukumi, bet vērtības ir viena vērtība vai vērtību masīvs, ar ko veikt atbilstības pārbaudi.

Atbalstītie rekvizīti: traceid, spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, status_code, status_message.
search object Atgriezt rezultātus, kas atbilst norādītajam paraugam (reģistrs netiek ņemts vērā).

Pieņem objektu, kurā atslēgas ir rekvizītu nosaukumi, bet vērtības ir meklējamās virknes. Ja nav norādītas papildu opcijas, tiek veikta LIKE "%…%" meklēšana.

Atbalstītie rekvizīti: trace_state, span_name, service_name, scope_name, scope_version, status_message.
sortfield string/array Kārtot rezultātu pēc norādītajiem rekvizītiem.

Iespējamās vērtības: timestamp, traceid, spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, duration, status_code, status_message.
offset integer Ierakstu skaits, kas jāizlaiž pirms rezultāta atgriešanas.
countOutput boolean Šie parametri ir aprakstīti atsauces komentāros.
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Lēnāko izsekojumu izgūšana

Izgūstiet divus lēnākos zabbix-nginx servisa izsekojumus. Meklējiet izsekojumus no 10:00 līdz 11:00 2026. gada 1. oktobrī (UTC) un iekļaujiet tikai tos, kuru izpilde ilga 1 sekundi vai ilgāk.

Pieprasījums:

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

Atbilde:

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

Skatiet arī

Avots

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