apmspan.get

Descripción

integer/array apmspan.get(object parameters)

El método permite recuperar spans según los parámetros indicados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración del rol de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(object) Parámetros que definen el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
time_from timestamp Devuelve solo los spans que comenzaron en el momento indicado o después.

Comportamiento del parámetro:
- obligatorio
time_till timestamp Devuelve solo los spans que comenzaron antes del momento indicado.

Comportamiento del parámetro:
- obligatorio
traceids string/array Devuelve solo los spans que pertenecen a las trazas indicadas.
spanids string/array Devuelve solo los spans con los ID indicados.
parent_spanids string/array Devuelve solo los spans con los spans principales indicados.
resource_attributes object/array Devuelve solo los spans con los atributos de recurso indicados.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Una matriz vacía devuelve todos los spans.

Valores posibles de operator:
0 - (predeterminado) Contiene;
1 - Es igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
resource_attributes_evaltype integer Método de evaluación de las condiciones en resource_attributes.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
span_attributes object/array Devuelve solo los spans con los atributos de span indicados.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Una matriz vacía devuelve todos los spans.

Valores posibles de operator:
0 - (predeterminado) Contiene;
1 - Es igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
span_attributes_evaltype integer Método de evaluación de las condiciones en span_attributes.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
min_duration integer Devuelve solo los spans cuya duración sea mayor o igual al valor indicado, en nanosegundos.
max_duration integer Devuelve solo los spans cuya duración sea menor que el valor indicado, en nanosegundos.
filter object Devuelve solo los resultados que coincidan exactamente con el filtro indicado.

Acepta un objeto cuyas claves son nombres de propiedades y cuyos valores son un único valor o una matriz de valores con los que se debe comparar.

Propiedades compatibles: traceid, spanid, parent_spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, status_code, status_message.
search object Devuelve los resultados que coincidan con el patrón indicado (sin distinguir entre mayúsculas y minúsculas).

Acepta un objeto cuyas claves son nombres de propiedades y cuyos valores son cadenas que se deben buscar. Si no se proporcionan opciones adicionales, se realizará una búsqueda LIKE "%…%".

Propiedades compatibles: trace_state, span_name, service_name, scope_name, scope_version, status_message.
sortfield string/array Ordena el resultado según las propiedades indicadas.

Valores posibles: timestamp, traceid, spanid, parent_spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, duration, status_code, status_message.
offset integer Número de registros que se deben omitir antes de devolver el resultado.
countOutput boolean Estos parámetros se describen en los comentarios de referencia.
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores devueltos

(integer/array) Devuelve uno de los siguientes valores:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperación de la jerarquía de spans de un trace

Recupere los primeros cuatro spans del trace "dee625f33cb0994e86c5cd4640e3b09c", ordenados por hora de inicio. La propiedad parent_spanid muestra cómo están relacionados los spans: el span raíz no tiene padre y cada uno de los demás spans hace referencia al span que lo inició.

Solicitud:

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

Respuesta:

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

Véase también

Fuente

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