apmmetric.get

Apraksts

integer/array apmmetric.get(object parameters)

Metode ļauj izgūt metrikas datu punktus 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 datu punktus, kuru laiks ir norādītajā laikā vai vēlāk.

Parametra darbība:
- obligāts
time_till timestamp Atgriezt tikai tos datu punktus, kuru laiks ir pirms norādītā laika.

Parametra darbība:
- obligāts
types integer/array Atgriezt tikai norādīto tipu datu punktus.

Atbalstīto metriku tipu sarakstu skatiet APM metrikas objekta lapā.
with_flags_on integer Atgriezt tikai tos datu punktus, kuriem ir iestatīti visi norādītie karodziņi.
Lai norādītu vairākus karodziņus, izmantojiet to vērtību summu.
with_flags_off integer Atgriezt tikai tos datu punktus, kuriem nav iestatīts neviens no norādītajiem karodziņiem.
Lai norādītu vairākus karodziņus, izmantojiet to vērtību summu.
resource_attributes object/array Atgriezt tikai tos datu punktus, kuriem ir norādītie resursa atribūti.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus datu punktus.

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.
scope_attributes object/array Atgriezt tikai tos datu punktus, kuriem ir norādītie tvēruma atribūti.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus datu punktus.

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) And/Or;
2 - Or.
attributes object/array Atgriezt tikai tos datu punktus, kuriem ir norādītie atribūti.
Formāts: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus datu punktus.

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

Iespējamās vērtības:
0 - (noklusējums) And/Or;
2 - Or.
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: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, flags.
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 virknes, kurās meklēt. Ja nav norādītas papildu opcijas, tiek veikta LIKE "%…%" meklēšana.

Atbalstītie rekvizīti: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_description, metric_unit.
sortfield string/array Kārtot rezultātu pēc norādītajiem rekvizītiem.

Iespējamās vērtības: type, resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, start_time_unix, time_unix.
offset integer Ierakstu skaits, ko izlaist 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

Histogrammas datu punktu izgūšana

Izgūstiet jaunāko http.server.request.duration histogrammas metrikas datu punktu pakalpojumam zabbix-frontend.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "apmmetric.get",
    "params": {
        "output": ["metric_name", "metric_unit", "time_unix", "count", "sum", "min", "max", "explicit_bounds", "bucket_counts", "exemplars"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "types": 2,
        "filter": {
            "service_name": "zabbix-frontend",
            "metric_name": "http.server.request.duration"
        },
        "sortfield": "time_unix",
        "sortorder": "DESC",
        "limit": 1
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "metric_name": "http.server.request.duration",
            "metric_unit": "s",
            "time_unix": "1790852390000000000",
            "count": "1842",
            "sum": "412.773",
            "min": "0.0061",
            "max": "1.098",
            "explicit_bounds": ["0.005", "0.05", "0.1", "0.25", "0.5", "1"],
            "bucket_counts": ["0", "211", "904", "512", "167", "41", "7"],
            "exemplars": [
                {
                    "traceid": "dee625f33cb0994e86c5cd4640e3b09c",
                    "spanid": "3f8b2c6d1e9a7054",
                    "value": "1.098",
                    "time_unix": "1790850513439147623",
                    "filtered_attributes": {}
                }
            ]
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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