apmmetric.get

Beschreibung

integer/array apmmetric.get(object parameters)

Mit dieser Methode können Sie Datenpunkte für Metriken entsprechend den angegebenen Parametern abrufen.

Diese Methode steht Benutzern jeden Typs zur Verfügung. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
time_from timestamp Gibt nur Datenpunkte zurück, deren Zeit bei der angegebenen Zeit oder danach liegt.

Parameterverhalten:
- erforderlich
time_till timestamp Gibt nur Datenpunkte zurück, deren Zeit vor der angegebenen Zeit liegt.

Parameterverhalten:
- erforderlich
types integer/array Gibt nur Datenpunkte der angegebenen Typen zurück.

Eine Liste der unterstützten Metriktypen finden Sie auf der Seite zum APM-Metrikobjekt.
with_flags_on integer Gibt nur Datenpunkte zurück, bei denen alle angegebenen Flags gesetzt sind.
Um mehrere Flags anzugeben, verwenden Sie die Summe ihrer Werte.
with_flags_off integer Gibt nur Datenpunkte zurück, bei denen keines der angegebenen Flags gesetzt ist.
Um mehrere Flags anzugeben, verwenden Sie die Summe ihrer Werte.
resource_attributes object/array Gibt nur Datenpunkte mit den angegebenen Ressourcenattributen zurück.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Datenpunkte zurück.

Mögliche Werte für operator:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Ist vorhanden;
5 - Ist nicht vorhanden.
resource_attributes_evaltype integer Auswertungsmethode für die Bedingungen in resource_attributes.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
scope_attributes object/array Gibt nur Datenpunkte mit den angegebenen Scope-Attributen zurück.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Datenpunkte zurück.

Mögliche Werte für operator:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Ist vorhanden;
5 - Ist nicht vorhanden.
scope_attributes_evaltype integer Auswertungsmethode für die Bedingungen in scope_attributes.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
attributes object/array Gibt nur Datenpunkte mit den angegebenen Attributen zurück.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Datenpunkte zurück.

Mögliche Werte für operator:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Ist vorhanden;
5 - Ist nicht vorhanden.
attributes_evaltype integer Auswertungsmethode für die Bedingungen in attributes.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
filter object Gibt nur Ergebnisse zurück, die genau mit dem angegebenen Filter übereinstimmen.

Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen verglichen werden soll.

Unterstützte Eigenschaften: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, flags.
search object Gibt Ergebnisse zurück, die dem angegebenen Muster entsprechen (ohne Beachtung der Groß-/Kleinschreibung).

Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen Werte Zeichenfolgen sind, nach denen gesucht werden soll. Wenn keine zusätzlichen Optionen angegeben werden, wird eine LIKE "%…%"-Suche durchgeführt.

Unterstützte Eigenschaften: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_description, metric_unit.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: type, resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, start_time_unix, time_unix.
offset integer Anzahl der Datensätze, die vor der Rückgabe des Ergebnisses übersprungen werden sollen.
countOutput boolean Diese Parameter werden im Referenzkommentar beschrieben.
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Abrufen von Histogramm-Datenpunkten

Rufen Sie den neuesten Datenpunkt der Histogrammmetrik http.server.request.duration des Dienstes zabbix-frontend ab.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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