apmmetric.get

Descripción

integer/array apmmetric.get(object parameters)

El método permite recuperar puntos de datos de métricas 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 de roles 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 únicamente los puntos de datos cuyo tiempo sea igual o posterior al tiempo indicado.

Comportamiento del parámetro:
- obligatorio
time_till timestamp Devuelve únicamente los puntos de datos cuyo tiempo sea anterior al tiempo indicado.

Comportamiento del parámetro:
- obligatorio
types integer/array Devuelve únicamente los puntos de datos de los tipos indicados.

Consulte la página del objeto de métrica de APM para obtener una lista de los tipos de métricas compatibles.
with_flags_on integer Devuelve únicamente los puntos de datos que tengan establecidos todos los indicadores indicados.
Para especificar varios indicadores, utilice la suma de sus valores.
with_flags_off integer Devuelve únicamente los puntos de datos que no tengan establecido ninguno de los indicadores indicados.
Para especificar varios indicadores, utilice la suma de sus valores.
resource_attributes object/array Devuelve únicamente los puntos de datos con los atributos de recurso indicados.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Una matriz vacía devuelve todos los puntos de datos.

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 de resource_attributes.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
scope_attributes object/array Devuelve únicamente los puntos de datos con los atributos de ámbito indicados.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Una matriz vacía devuelve todos los puntos de datos.

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

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

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

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
filter object Devuelve únicamente 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: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, flags.
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: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_description, metric_unit.
sortfield string/array Ordena el resultado según las propiedades indicadas.

Valores posibles: type, resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, start_time_unix, time_unix.
offset integer Número de registros que se omitirán 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 puntos de datos de histogramas

Recupere el punto de datos más reciente de la métrica de histograma http.server.request.duration del servicio zabbix-frontend.

Solicitud:

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

Respuesta:

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

Véase también

Origen

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