apmspan.get

Apraksts

integer/array apmspan.get(object parameters)

Šī metode ļauj izgūt spanus 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.

Parameter Type Description
time_from timestamp Atgriezt tikai tos intervālus, kas sākās norādītajā laikā vai vēlāk.

Parametra darbība:
- obligāts
time_till timestamp Atgriezt tikai tos intervālus, kas sākās pirms norādītā laika.

Parametra darbība:
- obligāts
traceids string/array Atgriezt tikai tos intervālus, kas pieder norādītajām trasēm.
spanids string/array Atgriezt tikai tos intervālus ar norādītajiem ID.
parent_spanids string/array Atgriezt tikai tos intervālus ar norādītajiem vecāka intervāliem.
resource_attributes object/array Atgriezt tikai tos intervālus ar norādītajiem resursa atribūtiem.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus intervālus.

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

Iespējamās vērtības:
0 - (noklusējuma) And/Or;
2 - Or.
span_attributes object/array Atgriezt tikai tos intervālus ar norādītajiem intervāla atribūtiem.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus intervālus.

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

Iespējamās vērtības:
0 - (noklusējuma) And/Or;
2 - Or.
min_duration integer Atgriezt tikai tos intervālus, kuru ilgums ir lielāks par norādīto vērtību vai vienāds ar to, nanosekundēs.
max_duration integer Atgriezt tikai tos intervālus, kuru ilgums 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 salīdzināšanu.

Atbalstītie rekvizīti: traceid, spanid, parent_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ģistrjutība netiek ņemta 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, tiks 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, parent_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ž:

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

Piemēri

Izsekojuma span hierarhijas izgūšana

Izgūstiet pirmos četrus izsekojuma span, kas sakārtoti pēc sākuma laika, izsekojumam "dee625f33cb0994e86c5cd4640e3b09c". Īpašība parent_spanid parāda, kā span ir savstarpēji saistīti: saknes span nav vecāka, bet katrs pārējais span atsaucas uz span, kas to sāka.

Pieprasījums:

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

Atbilde:

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

Skatiet arī

Avots

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