apmlog.get

Apraksts

integer/array apmlog.get(object parameters)

Metode ļauj izgūt žurnāla ierakstus 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 Atgriež tikai to notikumu žurnāla ierakstus, kas notikuši norādītajā laikā vai vēlāk.

Parametra darbība:
- obligāts
time_till timestamp Atgriež tikai to notikumu žurnāla ierakstus, kas notikuši pirms norādītā laika.

Parametra darbība:
- obligāts
traceids string/array Atgriež tikai žurnāla ierakstus, kas izveidoti norādīto izsekojumu laikā.
spanids string/array Atgriež tikai žurnāla ierakstus, kas izveidoti norādīto span laikā.
with_flags_on integer Atgriež tikai tos žurnāla ierakstus, kuriem ir iestatīti visi norādītie izsekojuma karodziņi.
Lai norādītu vairākus karodziņus, izmantojiet to vērtību summu.
with_flags_off integer Atgriež tikai tos žurnāla ierakstus, kuriem nav iestatīts neviens no norādītajiem izsekojuma karodziņiem.
Lai norādītu vairākus karodziņus, izmantojiet to vērtību summu.
resource_attributes object/array Atgriež tikai žurnāla ierakstus ar norādītajiem resursa atribūtiem.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus žurnāla ierakstus.

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) Un/Vai;
2 - Vai.
scope_attributes object/array Atgriež tikai žurnāla ierakstus ar norādītajiem tvēruma atribūtiem.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus žurnāla ierakstus.

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.
scope_attributes_evaltype integer Novērtēšanas metode nosacījumiem parametrā scope_attributes.

Iespējamās vērtības:
0 - (noklusējums) Un/Vai;
2 - Vai.
log_attributes object/array Atgriež tikai žurnāla ierakstus ar norādītajiem žurnāla atribūtiem.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus žurnāla ierakstus.

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.
log_attributes_evaltype integer Novērtēšanas metode nosacījumiem parametrā log_attributes.

Iespējamās vērtības:
0 - (noklusējums) Un/Vai;
2 - Vai.
filter object Atgriež 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, trace_flags, severity_text, severity_number, service_name, resource_schema_url, scope_schema_url, scope_name, scope_version, event_name.
search object Atgriež 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, tiek veikta LIKE "%…%" meklēšana.

Atbalstītie rekvizīti: severity_text, service_name, body, resource_schema_url, scope_schema_url, scope_name, scope_version, event_name.
sortfield string/array Kārto rezultātu pēc norādītajiem rekvizītiem.

Iespējamās vērtības: timestamp, traceid, spanid, trace_flags, severity_text, severity_number, service_name, resource_schema_url, scope_schema_url, scope_name, scope_version, event_name.
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

Izsekošanas kļūdu žurnālu izgūšana

Izgūstiet žurnāla ierakstus ar ERROR smaguma pakāpi (smaguma pakāpes numuri 17-20), kas ir saistīti ar izsekošanu "8a4f1c7e2b9d4e6fa0c3b5d7e9f1a2c4".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "apmlog.get",
    "params": {
        "output": "extend",
        "time_from": 1790848800,
        "time_till": 1790852400,
        "traceids": "8a4f1c7e2b9d4e6fa0c3b5d7e9f1a2c4",
        "filter": {
            "severity_number": [17, 18, 19, 20]
        },
        "sortfield": "timestamp",
        "sortorder": "ASC"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "timestamp": "1790849305091452376",
            "traceid": "8a4f1c7e2b9d4e6fa0c3b5d7e9f1a2c4",
            "spanid": "5d2e8f1a9c3b7046",
            "trace_flags": "1",
            "severity_text": "ERROR",
            "severity_number": "17",
            "service_name": "zabbix-frontend",
            "body": "mysqli_query(): (HY000/1205): Lock wait timeout exceeded; try restarting transaction",
            "resource_schema_url": "https://opentelemetry.io/schemas/1.26.0",
            "resource_attributes": {
                "service.name": "zabbix-frontend",
                "host.name": "6583ceeb5f94",
                "host.arch": "x86_64",
                "os.type": "linux"
            },
            "scope_schema_url": "",
            "scope_name": "zabbix-frontend",
            "scope_version": "",
            "scope_attributes": {},
            "log_attributes": {
                "log.file.path": "/var/log/zabbix/zabbix_frontend.log",
                "code.filepath": "/usr/share/zabbix/include/db.inc.php"
            },
            "event_name": ""
        }
    ],
    "id": 1
}

Žurnāla ziņojumu meklēšana

Iegūstiet laiku, pakalpojumu un ziņojumu 10 jaunākajiem žurnāla ierakstiem, kuru ziņojumā ir ietverts teksts "timeout".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "apmlog.get",
    "params": {
        "output": ["timestamp", "service_name", "severity_text", "body"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "search": {
            "body": "timeout"
        },
        "sortfield": "timestamp",
        "sortorder": "DESC",
        "limit": 10
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "timestamp": "1790849305091452376",
            "service_name": "zabbix-frontend",
            "severity_text": "ERROR",
            "body": "mysqli_query(): (HY000/1205): Lock wait timeout exceeded; try restarting transaction"
        },
        {
            "timestamp": "1790848961730284115",
            "service_name": "zabbix-frontend",
            "severity_text": "ERROR",
            "body": "mysqli_query(): (HY000/1205): Lock wait timeout exceeded; try restarting transaction"
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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