apmspan.get

Beschreibung

integer/array apmspan.get(object parameters)

Mit dieser Methode können Sie Spans 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 Type Description
time_from timestamp Gibt nur Spans zurück, die zum angegebenen Zeitpunkt oder danach gestartet wurden.

Parameterverhalten:
- erforderlich
time_till timestamp Gibt nur Spans zurück, die vor dem angegebenen Zeitpunkt gestartet wurden.

Parameterverhalten:
- erforderlich
traceids string/array Gibt nur Spans zurück, die zu den angegebenen Traces gehören.
spanids string/array Gibt nur Spans mit den angegebenen IDs zurück.
parent_spanids string/array Gibt nur Spans mit den angegebenen übergeordneten Spans zurück.
resource_attributes object/array Gibt nur Spans mit den angegebenen Ressourcenattributen zurück.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Spans 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.
span_attributes object/array Gibt nur Spans mit den angegebenen Spanattributen zurück.
Format: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Spans 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.
span_attributes_evaltype integer Auswertungsmethode für die Bedingungen in span_attributes.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
min_duration integer Gibt nur Spans zurück, deren Dauer größer oder gleich dem angegebenen Wert in Nanosekunden ist.
max_duration integer Gibt nur Spans zurück, deren Dauer kleiner als der angegebene Wert in Nanosekunden ist.
filter object Gibt nur Ergebnisse zurück, die exakt 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 abgeglichen werden soll.

Unterstützte Eigenschaften: traceid, spanid, parent_spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, status_code, status_message.
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: trace_state, span_name, service_name, scope_name, scope_version, status_message.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: timestamp, traceid, spanid, parent_spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, duration, status_code, status_message.
offset integer Anzahl der Datensätze, die vor der Rückgabe des Ergebnisses übersprungen werden.
countOutput boolean Diese Parameter werden in der Referenzdokumentation 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 der Span-Hierarchie eines Trace

Rufen Sie die ersten vier Spans des Traces „dee625f33cb0994e86c5cd4640e3b09c“ ab, sortiert nach Startzeit. Die Eigenschaft parent_spanid zeigt, wie die Spans miteinander verbunden sind: Der Root-Span hat kein übergeordnetes Element, und jeder andere Span verweist auf den Span, durch den er gestartet wurde.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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