En esta página
Objeto de métrica
Los siguientes objetos están directamente relacionados con la API de métrica.
Item
Los items web no se pueden crear, actualizar ni eliminar directamente mediante la API de Zabbix.
El objeto item tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| itemid | ID | ID del item. Comportamiento de la propiedad: - solo lectura - obligatoria para operaciones de actualización |
| delay | string | Intervalo de actualización del item. Acepta un número de segundos (por ejemplo, 1, 60, 300), un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 2h, 1d) o, de forma opcional, uno o varios intervalos personalizados, todos separados por punto y coma. Los intervalos personalizados pueden ser una combinación de intervalos flexibles y de planificación.Acepta macros de usuario. Si se utiliza una macro, el valor debe ser una única macro. No se admiten varias macros ni macros combinadas con texto. Los intervalos flexibles se pueden escribir como dos macros separadas por una barra diagonal (por ejemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Ejemplo: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Comportamiento de la propiedad: - obligatoria si type está establecido en "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), "Telemetry query" (24), o si type está establecido en "Zabbix agent (active)" (7) y key_ no contiene "mqtt.get" |
| hostid | ID | ID del host o template al que pertenece el item. Comportamiento de la propiedad: - constante - obligatoria para operaciones de creación |
| interfaceid | ID | ID de la interfaz del host del item. Comportamiento de la propiedad: - obligatoria si el item pertenece a un host y type está establecido en "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" o "SNMP agent"- compatible si el item pertenece a un host y type está establecido en "Simple check", "External check", "SSH agent", "TELNET agent" o "HTTP agent"- solo lectura para objetos descubiertos |
| key_ | string | Clave del item. Comportamiento de la propiedad: - obligatoria para operaciones de creación - solo lectura para objetos heredados o descubiertos |
| name | string | Nombre del item. Admite macros de usuario. Comportamiento de la propiedad: - obligatoria para operaciones de creación - solo lectura para objetos heredados o descubiertos |
| name_resolved | string | Nombre del item con las macros de usuario resueltas. Comportamiento de la propiedad: - solo lectura |
| type | integer | Tipo del item. Valores posibles: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 9 - Web item; 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser; 24 - Telemetry query. Comportamiento de la propiedad: - obligatoria para operaciones de creación - solo lectura para objetos heredados o descubiertos |
| url | string | Cadena de URL. Admite macros de usuario, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Comportamiento de la propiedad: - obligatoria si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| value_type | integer | Tipo de información del item. Valores posibles: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary; 6 - JSON. Comportamiento de la propiedad: - obligatoria para operaciones de creación - solo lectura para objetos heredados o descubiertos |
| allow_traps | integer | Permite rellenar el valor de forma similar al item trapper. 0 - (predeterminado) No permitir aceptar datos entrantes; 1 - Permitir aceptar datos entrantes. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos descubiertos |
| authtype | integer | Método de autenticación. Valores posibles si type está establecido en "SSH agent":0 - (predeterminado) contraseña; 1 - clave pública. Valores posibles si type está establecido en "HTTP agent":0 - (predeterminado) ninguno; 1 - básico; 2 - NTLM; 3 - Kerberos; 4 - Digest. Comportamiento de la propiedad: - compatible si type está establecido en "SSH agent" o "HTTP agent"- solo lectura para objetos heredados (si type está establecido en "HTTP agent") u objetos descubiertos |
| description | string | Descripción del item. Comportamiento de la propiedad: - solo lectura para objetos descubiertos |
| error | string | Texto del error si hay problemas al actualizar el valor del item. Comportamiento de la propiedad: - solo lectura |
| flags | integer | Origen del item. Valores posibles: 0 - un item normal; 4 - un item convertido a partir de un prototipo. Comportamiento de la propiedad: - solo lectura |
| follow_redirects | integer | Seguir las redirecciones de respuesta al sondear datos. Valores posibles: 0 - No seguir redirecciones; 1 - (predeterminado) Seguir redirecciones. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| headers | array | Matriz de encabezados que se enviarán al realizar una solicitud HTTP. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| history | string | Unidad de tiempo durante la que se deben conservar los datos históricos. También acepta una macro de usuario. Predeterminado: 31d. Comportamiento de la propiedad: - solo lectura para objetos descubiertos |
| http_proxy | string | Cadena de conexión del proxy HTTP(S). Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| inventory_link | integer | ID del campo del inventario del host que rellena el item. Consulte la página del inventario del host para obtener una lista de los campos de inventario del host compatibles y sus ID. Predeterminado: 0. Comportamiento de la propiedad: - compatible si value_type está establecido en "numeric float", "character", "numeric unsigned" o "text"- solo lectura para objetos descubiertos |
| ipmi_sensor | string | Sensor IPMI. Comportamiento de la propiedad: - obligatoria si type está establecido en "IPMI agent" y key_ no está establecido en "ipmi.get"- compatible si type está establecido en "IPMI agent"- solo lectura para objetos heredados o descubiertos |
| jmx_endpoint | string | Cadena de conexión personalizada del JMX agent. Valor predeterminado: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Comportamiento de la propiedad: - compatible si type está establecido en "JMX agent"- solo lectura para objetos descubiertos |
| lastclock | timestamp | Momento en que se actualizó por última vez el valor del item. De forma predeterminada, solo se muestran los valores correspondientes a las últimas 24 horas. Puede ampliar este período cambiando el valor del parámetro Max history display period en la sección de menú Administration > General. Comportamiento de la propiedad: - solo lectura |
| lastns | integer | Nanosegundos del momento en que se actualizó por última vez el valor del item. De forma predeterminada, solo se muestran los valores correspondientes a las últimas 24 horas. Puede ampliar este período cambiando el valor del parámetro Max history display period en la sección de menú Administration > General. Comportamiento de la propiedad: - solo lectura |
| lastvalue | string | Último valor del item. De forma predeterminada, solo se muestran los valores correspondientes a las últimas 24 horas. Puede ampliar este período cambiando el valor del parámetro Max history display period en la sección de menú Administration > General. Comportamiento de la propiedad: - solo lectura |
| logtimefmt | string | Formato de la hora en las entradas del registro. Comportamiento de la propiedad: - compatible si value_type está establecido en "log"- solo lectura para objetos heredados o descubiertos |
| master_itemid | ID | ID del item maestro. Comportamiento de la propiedad: - obligatoria si type está establecido en "Dependent item"- solo lectura para objetos heredados o descubiertos |
| output_format | integer | Indica si la respuesta debe convertirse a JSON. 0 - (predeterminado) Almacenar sin procesar; 1 - Convertir a JSON. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| params | string | Parámetros adicionales según el tipo de item: - script ejecutado para items SSH agent y TELNET agent; - consulta SQL para items Database monitor; - fórmula para items Calculated; - script para items Script y Browser. Comportamiento de la propiedad: - obligatoria si type está establecido en "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" o "Browser"- solo lectura para objetos heredados (si type está establecido en "Script" o "Browser") u objetos descubiertos |
| parameters | object/array | Parámetros adicionales si type está establecido en "Script" o "Browser". Matriz de objetos con las propiedades name y value, donde name debe ser único.Comportamiento de la propiedad: - compatible si type está establecido en "Script" o "Browser"- solo lectura para objetos heredados o descubiertos |
| password | string | Contraseña para la autenticación. Comportamiento de la propiedad: - obligatoria si type está establecido en "JMX agent" y username está establecido- compatible si type está establecido en "Simple check", "SSH agent", "TELNET agent", "Database monitor" o "HTTP agent"- solo lectura para objetos heredados (si type está establecido en "HTTP agent") u objetos descubiertos |
| post_type | integer | Tipo del cuerpo de datos de publicación almacenado en la propiedad posts.Valores posibles: 0 - (predeterminado) Datos sin procesar; 2 - Datos JSON; 3 - Datos XML. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| posts | string | Datos del cuerpo de la solicitud HTTP(S). Comportamiento de la propiedad: - obligatoria si type está establecido en "HTTP agent" y post_type está establecido en "JSON data" o "XML data"- compatible si type está establecido en "HTTP agent" y post_type está establecido en "Raw data"- solo lectura para objetos heredados o descubiertos |
| prevvalue | string | Valor anterior del item. De forma predeterminada, solo se muestran los valores correspondientes a las últimas 24 horas. Puede ampliar este período cambiando el valor del parámetro Max history display period en la sección de menú Administration > General. Comportamiento de la propiedad: - solo lectura |
| privatekey | string | Nombre del archivo de clave privada. Comportamiento de la propiedad: - obligatoria si type está establecido en "SSH agent" y authtype está establecido en "public key"- solo lectura para objetos descubiertos |
| publickey | string | Nombre del archivo de clave pública. Comportamiento de la propiedad: - obligatoria si type está establecido en "SSH agent" y authtype está establecido en "public key"- solo lectura para objetos descubiertos |
| query_fields | array | Matriz de campos de consulta que se enviarán al realizar una solicitud HTTP. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| request_method | integer | Tipo de método de solicitud. Valores posibles: 0 - (predeterminado) GET; 1 - POST; 2 - PUT; 3 - HEAD. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| retrieve_mode | integer | Parte de la respuesta que se debe almacenar. Valores posibles si request_method está establecido en "GET", "POST" o "PUT":0 - (predeterminado) Cuerpo; 1 - Encabezados; 2 - Se almacenarán el cuerpo y los encabezados. Valores posibles si request_method está establecido en "HEAD":1 - Encabezados. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| snmp_oid | string | OID de SNMP. Comportamiento de la propiedad: - obligatoria si type está establecido en "SNMP agent"- solo lectura para objetos heredados o descubiertos |
| ssl_cert_file | string | Ruta del archivo de clave pública SSL. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| ssl_key_file | string | Ruta del archivo de clave privada SSL. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| ssl_key_password | string | Contraseña del archivo de clave SSL. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| state | integer | Estado del item. Valores posibles: 0 - (predeterminado) normal; 1 - no compatible. Comportamiento de la propiedad: - solo lectura |
| status | integer | Estado del item. Valores posibles: 0 - (predeterminado) item habilitado; 1 - item deshabilitado. |
| status_codes | string | Rangos de códigos de estado HTTP requeridos, separados por comas. También admite macros de usuario como parte de una lista separada por comas. Ejemplo: 200,200-{$M},{$M},200-400 Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| templateid | ID | ID del item del template principal. Sugerencia: Utilice la propiedad hostid para especificar el template al que pertenece el item.Comportamiento de la propiedad: - solo lectura |
| timeout | string | Tiempo de espera de la solicitud de sondeo de datos del item. Acepta un número de segundos (por ejemplo, 1, 60, 300) o un valor con un sufijo de tiempo (por ejemplo, 300s, 1m). También acepta macros de usuario.El rango de valores posibles es: 1-600s. Predeterminado: "" - utilizar la configuración del proxy/global. Comportamiento de la propiedad: - compatible si type está establecido en "Zabbix agent" (0), "Simple check" (3) y key_ no comienza por "vmware." ni "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) y snmp_oid comienza por "walk[" o "get[", "Script" (21), "Browser" (22)- solo lectura para objetos heredados y descubiertos, - si se aplica el valor predeterminado y el item pertenece a un host supervisado por un proxy o grupo de proxies inaccesible, se utiliza el tiempo de espera global. |
| trapper_hosts | string | Hosts permitidos. Comportamiento de la propiedad: - solo lectura para objetos descubiertos - compatible si type está establecido en "Zabbix trapper", o si type está establecido en "HTTP agent" y allow_traps está establecido en "Allow to accept incoming data".Si se omite la propiedad, se establece automáticamente en la macro de usuario {$TRAPPER.ALLOWED_HOSTS} (valor predeterminado). De forma predeterminada, {$TRAPPER.ALLOWED_HOSTS} es 127.0.0.1,::1.Si la propiedad se establece en una cadena vacía, se denegarán las conexiones entrantes de todos los hosts. |
| trends | string | Unidad de tiempo durante la que se deben conservar los datos de tendencias. También acepta una macro de usuario. Predeterminado: 365d. Comportamiento de la propiedad: - compatible si value_type está establecido en "numeric float" o "numeric unsigned"- solo lectura para objetos descubiertos |
| units | string | Unidades del valor. Comportamiento de la propiedad: - compatible si value_type está establecido en "numeric float" o "numeric unsigned"- solo lectura para objetos heredados o descubiertos |
| username | string | Nombre de usuario para la autenticación. Comportamiento de la propiedad: - obligatorio si type está establecido en "SSH agent", "TELNET agent", o si type está establecido en "JMX agent" y password está establecido- compatible si type está establecido en "Simple check", "Database monitor" o "HTTP agent"- solo lectura para objetos heredados (si type está establecido en "HTTP agent") u objetos descubiertos |
| uuid | string | Identificador único universal utilizado para vincular el item importado con otros ya existentes. Se genera automáticamente si no se proporciona. Comportamiento de la propiedad: - compatible si el item pertenece a un template |
| valuemapid | ID | ID del mapa de valores asociado. Comportamiento de la propiedad: - compatible si value_type está establecido en "numeric float", "character" o "numeric unsigned"- solo lectura para objetos heredados o descubiertos |
| verify_host | integer | Indica si se debe validar que el nombre del host de la conexión coincida con el del certificado del host. Valores posibles: 0 - (predeterminado) No validar; 1 - Validar. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| verify_peer | integer | Indica si se debe validar que el certificado del host sea auténtico. Valores posibles: 0 - (predeterminado) No validar; 1 - Validar. Comportamiento de la propiedad: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados o descubiertos |
| query | object | Configuración de la consulta de telemetría. Define qué consulta el item en el origen de datos de telemetría, cómo filtra los datos y cómo agrega el resultado. Comportamiento de la propiedad: - obligatoria si type está establecido en "Telemetry query"- solo lectura para objetos heredados o descubiertos |
| time_shift | string | Hasta qué momento anterior a la hora actual termina el intervalo de tiempo que consulta el item. Acepta un número de segundos (por ejemplo, 1, 60, 300) o un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 2h, 1d). También acepta macros de usuario.El rango de valores posibles es: 0-86400s. Predeterminado: 15s. Comportamiento de la propiedad: - compatible si type está establecido en "Telemetry query" |
| lookback_limit | string | Hasta qué momento anterior a la hora actual consulta datos el item cuando no existe una consulta anterior que continuar (por ejemplo, en la primera ejecución del item), o cuando la consulta anterior es más antigua que delay (por ejemplo, porque Zabbix server estaba inactivo).Acepta un número de segundos (por ejemplo, 1, 60, 300) o un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 2h, 1d). También acepta macros de usuario.El rango de valores posibles es: 1-259200s. Predeterminado: 10m. Comportamiento de la propiedad: - compatible si type está establecido en "Telemetry query" |
| granularity | string | Duración de cada segmento en el que se divide el intervalo de tiempo completo de la consulta. Acepta un número de segundos (por ejemplo, 1, 60, 300) o un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 2h, 1d). También acepta macros de usuario.El rango de valores posibles es: 1-86400s. Predeterminado: 15s. Comportamiento de la propiedad: - compatible si type está establecido en "Telemetry query" |
Encabezado HTTP
El objeto header tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del encabezado HTTP. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor del encabezado. Comportamiento de la propiedad: - obligatorio |
Campo de consulta HTTP
El objeto de campo de consulta define un nombre y un valor que se utilizan para especificar un parámetro de URL. Tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del parámetro. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor del parámetro. Comportamiento de la propiedad: - obligatorio |
Consulta de telemetría
El objeto de consulta de telemetría tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| signal_type | integer | Tipo de señal que consulta el item. Valores posibles: 0 - Trazas; 1 - Métricas; 2 - Registros. Comportamiento de la propiedad: - required |
| metric_point_type | integer | Tipo de punto de métrica que consulta el item. Valores posibles: 0 - Suma; 1 - Medidor; 2 - Histograma; 3 - Histograma exponencial. Comportamiento de la propiedad: - required si signal_type está establecido en "Métricas" |
| columns | array | Matriz de columnas de datos de telemetría que consulta el item. Puede estar vacía. Comportamiento de la propiedad: - required |
| aggregated_columns | array | Matriz de columnas agregadas de datos de telemetría que consulta el item y de cómo calcula un valor a partir de los registros de las columnas. Comportamiento de la propiedad: - required |
| filter | object | Filtro de consulta de telemetría para los registros de columnas de la consulta. Comportamiento de la propiedad: - required |
Columnas de datos de telemetría
El objeto de columnas de datos de telemetría tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| column | string | Nombre de la columna de datos de telemetría que consulta el item. Consulte columnas de datos de telemetría compatibles. Para varias columnas de valor único, cada valor de column debe ser único. Para varias columnas que contienen pares clave-valor, cada par de valores column y attribute_key debe ser único. |
| attribute_key | string | Nombre de la clave que consulta el item dentro de la columna que contiene pares clave-valor. Para varias columnas que contienen pares clave-valor, cada par de valores column y attribute_key debe ser único.Comportamiento de la propiedad: - obligatorio si column está establecido en una columna que contiene pares clave-valor |
Columnas agregadas de datos de telemetría
El objeto de columnas agregadas de datos de telemetría tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| column | string | Nombre de la columna de datos de telemetría que consulta el item. Consulte columnas de datos de telemetría compatibles. Para varias columnas, cada valor de column debe ser único.Esta propiedad no es compatible si function está establecido en "Count".Comportamiento de la propiedad: - obligatoria si function está establecido en "Min", "Max", "Average", "Sum" o "Percentile" |
| function | integer | Función que el item aplica a los registros de la columna. Valores posibles: 1 - Min; 2 - Max; 3 - Average; 4 - Count; 5 - Sum; 8 - Percentile. Comportamiento de la propiedad: - obligatoria |
| parameters | array | Percentil que el item calcula a partir de los registros de la columna. Valor posible: un número del 0 al 100, indicado como una cadena. Comportamiento de la propiedad: - obligatoria si function está establecido en "Percentile" |
| alias | string | Nombre único del valor calculado, utilizado para identificarlo en el valor del item. Cada valor de alias debe ser único.Comportamiento de la propiedad: - obligatoria |
Filtro de datos de telemetría
El objeto de filtro de datos de telemetría tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| conditions | array | Condiciones del filtro de datos de telemetría que debe cumplir un registro de una columna de datos de telemetría. Comportamiento de la propiedad: - required |
| evaltype | integer | Método de evaluación de la condición del filtro. Valores posibles: 0 - And/Or; 1 - And; 2 - Or; 3 - Expresión personalizada. Comportamiento de la propiedad: - required |
| eval_formula | string | Expresión generada que se utilizará para evaluar las condiciones del filtro. La expresión contiene identificadores que hacen referencia a condiciones de filtro específicas mediante su formulaid. El valor de eval_formula es igual al valor de formula para los filtros con una expresión personalizada.Comportamiento de la propiedad: - read-only |
| formula | string | Expresión definida por el usuario que se utilizará para evaluar las condiciones de los filtros con una expresión personalizada. La expresión debe contener identificadores que hagan referencia a condiciones de filtro específicas mediante su formulaid. Los identificadores utilizados en la expresión deben coincidir exactamente con los definidos en las condiciones del filtro: no puede quedar ninguna condición sin utilizar ni omitirse ninguna.Comportamiento de la propiedad: - required si evaltype está establecido en "Expresión personalizada" |
Condiciones de filtrado de datos de telemetría
El objeto de condiciones de filtrado de datos de telemetría tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| column | string | Nombre de la columna de datos de telemetría a la que se aplica la condición de filtrado. Consulte las columnas de datos de telemetría compatibles. Comportamiento de la propiedad: - obligatoria |
| attribute_key | string | Nombre de la clave a la que se aplica la condición, dentro de la columna que contiene pares clave-valor. Comportamiento de la propiedad: - obligatoria si column está configurada con una columna que contiene pares clave-valor |
| operator | integer | Operador de la condición de filtrado. Valores posibles para columnas de valor único: 0 - Es igual a; 1 - No es igual a; 2 - Contiene; 3 - No contiene. Valores posibles para columnas que contienen pares clave-valor: 0 - Es igual a; 1 - No es igual a; 12 - Existe. Comportamiento de la propiedad: - obligatoria |
| value | string | Valor con el que se debe comparar. Comportamiento de la propiedad: - obligatoria si operator está configurado como "Es igual a", "No es igual a", "Contiene" o "No contiene" |
| formulaid | string | ID único arbitrario que se utiliza para hacer referencia a la condición desde una expresión personalizada. Solo puede contener letras mayúsculas. El usuario debe definir el ID al modificar las condiciones de filtrado, pero se generará uno nuevo al solicitarlas posteriormente. Comportamiento de la propiedad: - obligatoria si evaltype del objeto Filtro de consulta de telemetría está configurado como "Expresión personalizada" |
Etiqueta de item
El objeto de etiqueta de item tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tag | string | Nombre de la etiqueta del item. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor de la etiqueta del item. Comportamiento de la propiedad: - solo lectura. |
| object | integer | Tipo de objeto del que se heredó la etiqueta. Valores posibles: 0 - template; 1 - host. Comportamiento de la propiedad: - solo lectura. |
| objectid | ID | ID del objeto del que se heredó la etiqueta. Comportamiento de la propiedad: - solo lectura. |
Preprocesamiento de item
El objeto de preprocesamiento de item tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | integer | El tipo de opción de preprocesamiento. Valores posibles: 1 - Multiplicador personalizado; 2 - Recortar por la derecha; 3 - Recortar por la izquierda; 4 - Recortar; 5 - Expresión regular; 6 - Booleano a decimal; 7 - Octal a decimal; 8 - Hexadecimal a decimal; 9 - Cambio simple; 10 - Cambio por segundo; 11 - XPath XML; 12 - JSONPath; 13 - En rango; 14 - Coincide con la expresión regular; 15 - No coincide con la expresión regular; 16 - Comprobar errores en JSON; 17 - Comprobar errores en XML; 18 - Comprobar errores mediante una expresión regular; 19 - Descartar sin cambios; 20 - Descartar sin cambios con heartbeat; 21 - JavaScript; 22 - Patrón de Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Reemplazar; 26 - Comprobar no compatible; 27 - XML a JSON; 28 - Valor de recorrido SNMP; 29 - Recorrido SNMP a JSON; 30 - Obtener valor mediante SNMP. Comportamiento de la propiedad: - obligatoria |
| params | string | Parámetros adicionales utilizados por la opción de preprocesamiento. Varios parámetros se separan mediante el carácter de nueva línea (\n). Si type se establece en "Comprobar no compatible", los parámetros siguen la sintaxis <scope>[\n<pattern>], donde pattern es una expresión regular y scope es uno de los siguientes:-1 - coincide con cualquier error; \ 0 - comprobar si el mensaje de error coincide con pattern; \ 1 - comprobar si el mensaje de error no coincide con pattern. Comportamiento de la propiedad: - obligatoria si type se establece en "Multiplicador personalizado" (1), "Recortar por la derecha" (2), "Recortar por la izquierda" (3), "Recortar" (4), "Expresión regular" (5), "XPath XML" (11), "JSONPath" (12), "En rango" (13), "Coincide con la expresión regular" (14), "No coincide con la expresión regular" (15), "Comprobar errores en JSON" (16), "Comprobar errores en XML" (17), "Comprobar errores mediante una expresión regular" (18), "Descartar sin cambios con heartbeat" (20), "JavaScript" (21), "Patrón de Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Reemplazar" (25), Comprobar no compatible (26), "Valor de recorrido SNMP" (28), "Recorrido SNMP a JSON" (29) o "Obtener valor mediante SNMP" (30) |
| error_handler | integer | Tipo de acción utilizado en caso de fallo del paso de preprocesamiento. Valores posibles: 0 - El mensaje de error lo establece Zabbix server; 1 - Descartar el valor; 2 - Establecer un valor personalizado; 3 - Establecer un mensaje de error personalizado. Valores posibles si type se establece en "Comprobar no compatible":1 - Descartar el valor; 2 - Establecer un valor personalizado; 3 - Establecer un mensaje de error personalizado. Comportamiento de la propiedad: - obligatoria si type se establece en "Multiplicador personalizado" (1), "Expresión regular" (5), "Booleano a decimal" (6), "Octal a decimal" (7), "Hexadecimal a decimal" (8), "Cambio simple" (9), "Cambio por segundo" (10), "XPath XML" (11), "JSONPath" (12), "En rango" (13), "Coincide con la expresión regular" (14), "No coincide con la expresión regular" (15), "Comprobar errores en JSON" (16), "Comprobar errores en XML" (17), "Comprobar errores mediante una expresión regular" (18), "Patrón de Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Comprobar no compatible" (26), "XML a JSON" (27), "Valor de recorrido SNMP" (28), "Recorrido SNMP a JSON" (29) u "Obtener valor mediante SNMP" (30) |
| error_handler_params | string | Parámetros del gestor de errores. Comportamiento de la propiedad: - obligatoria si error_handler se establece en "Establecer un valor personalizado" o "Establecer un mensaje de error personalizado" |
Los siguientes parámetros y gestores de errores son compatibles con cada tipo de preprocesamiento.
| Tipo de preprocesamiento | Nombre | Parámetro 1 | Parámetro 2 | Parámetro 3 | Gestores de errores compatibles |
|---|---|---|---|---|---|
| 1 | Multiplicador personalizado | número1, 6 | 0, 1, 2, 3 | ||
| 2 | Recortar por la derecha | lista de caracteres2 | |||
| 3 | Recortar por la izquierda | lista de caracteres2 | |||
| 4 | Recortar | lista de caracteres2 | |||
| 5 | Expresión regular | patrón3 | salida2 | 0, 1, 2, 3 | |
| 6 | Booleano a decimal | 0, 1, 2, 3 | |||
| 7 | Octal a decimal | 0, 1, 2, 3 | |||
| 8 | Hexadecimal a decimal | 0, 1, 2, 3 | |||
| 9 | Cambio simple | 0, 1, 2, 3 | |||
| 10 | Cambio por segundo | 0, 1, 2, 3 | |||
| 11 | XPath XML | ruta4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | ruta4 | 0, 1, 2, 3 | ||
| 13 | En rango | mín.1, 6 | máx.1, 6 | 0, 1, 2, 3 | |
| 14 | Coincide con la expresión regular | patrón3 | 0, 1, 2, 3 | ||
| 15 | No coincide con la expresión regular | patrón3 | 0, 1, 2, 3 | ||
| 16 | Comprobar errores en JSON | ruta4 | 0, 1, 2, 3 | ||
| 17 | Comprobar errores en XML | ruta4 | 0, 1, 2, 3 | ||
| 18 | Comprobar errores mediante una expresión regular | patrón3 | salida2 | 0, 1, 2, 3 | |
| 19 | Descartar sin cambios | ||||
| 20 | Descartar sin cambios con heartbeat | segundos5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Patrón de Prometheus | patrón6, 7 | value, label, function |
salida8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus a JSON | patrón6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV a JSON | carácter2 | carácter2 | 0,1 | 0, 1, 2, 3 |
| 25 | Reemplazar | cadena de búsqueda2 | reemplazo2 | ||
| 26 | Comprobar no compatible | ámbito1 | patrón3, 6 | 1, 2, 3 | |
| 27 | XML a JSON | 0, 1, 2, 3 | |||
| 28 | Valor de recorrido SNMP | OID2 | Formato: 0 - Sin cambios 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 | |
| 29 | Recorrido SNMP a JSON10 | Nombre del campo2 | Prefijo OID2 | Formato: 0 - Sin cambios 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 |
| 30 | Obtener valor mediante SNMP | Formato: 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 | ||
1 número de coma flotante (los enteros se convierten implícitamente en valores de coma flotante)
2 cadena
3 expresión regular
4 JSONPath o XPath XML
5 entero positivo (compatible con sufijos de tiempo, por ejemplo, 30s, 1m, 2h, 1d)
6 macro de usuario
7 patrón de Prometheus que sigue la sintaxis: <metric name>{<label name>="<label value>", ...} == <value>.
Cada componente del patrón de Prometheus (métrica, nombre de etiqueta, valor de etiqueta y valor de métrica) puede ser una macro de usuario.
8 salida de Prometheus que sigue la sintaxis: <label name> (puede ser una macro de usuario) si label está seleccionado como segundo parámetro.
9 Una de las funciones de agregación: sum, min, max, avg, count si function está seleccionado como segundo parámetro.
10 Admite varios registros de "Nombre del campo,Prefijo OID,Formato" delimitados por un carácter de nueva línea.