1 Funciones de macro

Descripción general

Las funciones de macro ofrecen la capacidad de personalizar los valores de las macros (por ejemplo, acortar o extraer subcadenas específicas), lo que facilita su manejo.

La sintaxis de una función de macro es:

{macro.func(params)}

donde

• macro: la macro a personalizar;
• func: la función a aplicar (ver funciones soportadas);
• params: una lista de parámetros de función separados por comas, que deben estar entre comillas dobles si:
  • comienzan con un espacio o comillas dobles;
  • contienen paréntesis de cierre o una coma.

Por ejemplo:

{{TIME}.fmttime(format,time_shift)}
       {{ITEM.VALUE}.regsub(pattern, output)}
       {{$USERMACRO}.regsub(pattern, output)}
       {{#LLDMACRO}.regsub(pattern, output)}

Las funciones de macro son compatibles con

• Macros integradas
• Macros de usuario
• Macros de descubrimiento de bajo nivel
• Macros de expresión

Las funciones de macro pueden utilizarse en todas las ubicaciones que admitan las macros listadas. Esto se aplica a menos que se indique explícitamente que solo se espera una macro (por ejemplo, al configurar macros de host o filtros de reglas de descubrimiento de bajo nivel).

Se admite una sola función por macro; no se admite el uso de varias funciones de macro en cadena.

Funciones compatibles

Las funciones se enumeran sin información adicional. Haga clic en la función para ver los detalles completos.

Detalles de la función

Los parámetros opcionales de la función se indican mediante < >.

btoa

Codificación de un valor de macro en codificación Base64. La codificación Base64 es un método para representar datos binarios como texto, útil para almacenar y transmitir de forma segura contenido binario a través de protocolos basados en texto.

Ejemplo:

{{ITEM.VALUE}.btoa()} - codificará en Base64 un valor como "zabbix" en "emFiYml4"

fmtnum(dígitos)

Formato de número para controlar la cantidad de dígitos impresos después del punto decimal.

Parámetros:

• dígitos: el número de dígitos después del punto decimal. Rango válido: 0-20. No se producirán ceros finales.

Ejemplos:

{{ITEM.VALUE}.fmtnum(2)} - devolverá "24.35" a partir de un valor recibido de "24.3483523"
       {{ITEM.VALUE}.fmtnum(0)} - devolverá "24" a partir de un valor recibido de "24.3483523"

fmttime(formato,<desplazamiento_tiempo>)

Formateo de tiempo.
Tenga en cuenta que esta función puede utilizarse con macros que resuelven a un valor en uno de los siguientes formatos de tiempo:

• hh:mm:ss
• yyyy-mm-ddThh:mm:ss[tz] (estándar ISO8601)
• Marca de tiempo UNIX

Parámetros:

• formato - cadena de formato obligatoria, compatible con el formateo de la función strftime;
• desplazamiento_tiempo (opcional) - el desplazamiento de tiempo aplicado antes del formateo; debe comenzar con -<N><unidad_tiempo> o +<N><unidad_tiempo>, donde:
  • N - el número de unidades de tiempo a sumar o restar;
  • unidad_tiempo - h (hora), d (día), w (semana), M (mes) o y (año).

Comentarios:

• El parámetro desplazamiento_tiempo admite operaciones de tiempo en varios pasos y puede incluir /<unidad_tiempo> para desplazar al inicio de la unidad de tiempo (/d - medianoche, /w - primer día de la semana (lunes), /M - primer día del mes, etc.). Ejemplos: -1w - exactamente 7 días atrás; -1w/w - lunes de la semana anterior; -1w/w+1d - martes de la semana anterior.
• Las operaciones de tiempo se calculan de izquierda a derecha sin prioridades. Por ejemplo, -1M/d+1h/w se analizará como ((-1M/d)+1h)/w.

Ejemplos:

{{TIME}.fmttime(%B)} - devolverá "octubre" a partir de un valor recibido de "1633098961"
       {{TIME}.fmttime(%d %B,-1M/M)} - devolverá "1 septiembre" a partir de un valor recibido de "1633098961"

htmldecode

Decodifica un valor de macro desde la codificación HTML.

Se admiten los siguientes caracteres:

Ejemplo:

{{ITEM.VALUE}.htmldecode()} - decodificará un valor HTML como "<" en "<"

htmlencode

Codifica un valor de macro en codificación HTML.

Se admiten los siguientes caracteres:

Ejemplo:

{{ITEM.VALUE}.htmlencode()} - codificará en HTML un carácter como "<" en "<"

iregsub(patrón,salida)

Extracción de subcadenas mediante coincidencia de expresión regular (sin distinguir mayúsculas/minúsculas).

Parámetros:

• patrón: la expresión regular a buscar;
• salida: las opciones de salida. Se admiten los marcadores de posición \1 - \9 para capturar grupos. \0 devuelve el texto coincidente.

Comentarios:

• Si no hay coincidencia para la expresión regular, la función devuelve una cadena vacía.
• Si el patrón de la función es una expresión regular incorrecta, entonces la macro se evalúa como 'UNKNOWN' (excepto para macros de bajo nivel de descubrimiento, en cuyo caso la función será ignorada y la macro permanecerá sin resolver).
• Las referencias a grupos de captura inexistentes en la cadena de reemplazo se sustituyen por una cadena vacía.

Ejemplo:

{{ITEM.VALUE}.iregsub("fail|error|fault|problem","ERROR")} - se resolverá como "ERROR" si se reciben las subcadenas "fail", "error", "fault" o "problem" (sin distinguir mayúsculas/minúsculas); devolverá una cadena vacía si no hay coincidencia

minúsculas

Transformación de todos los caracteres del valor de la macro a minúsculas. Funciona con conjuntos de caracteres de un solo byte (como ASCII) y no admite UTF-8.

Ejemplo:

{{ITEM.VALUE}.lowercase()} - transformará un valor como "Zabbix SERVER" en "zabbix server" (minúsculas)

regrepl(patrón,reemplazo,<patrón2>,<reemplazo2>,...)

Reemplazo de carácter/subcadena en el valor de la macro.

Parámetros:

• patrón: la expresión regular a buscar;
• reemplazo: la cadena de reemplazo. Se admiten los marcadores de posición \1 - \9 en las cadenas de reemplazo para capturar grupos.

Comentarios:

• Los patrones y reemplazos se procesan secuencialmente, aplicándose cada par subsiguiente de acuerdo con el resultado del reemplazo anterior;
• Las referencias a grupos de captura inexistentes en la cadena de reemplazo se sustituyen por una cadena vacía.

Ejemplos:

{{ITEM.VALUE}.regrepl("oldParam", "newParam")} - reemplazará "oldParam" por "newParam"
       {{ITEM.VALUE}.regrepl("([^a-z])","\\\1")} - todos los caracteres que no sean letras se escaparán con una barra invertida
       {$THRESHOLD:"{{#FSNAME}.regrepl(\"\\$\",\"\")}"} - eliminará una barra invertida al final (por ejemplo, para reemplazar "C:\" por "C:")
       {{ITEM.VALUE}.regrepl("_v1\.0", "_v2.0", "\(final\)", "")} - reemplazará varias partes en el valor del elemento

regsub(patrón,salida)

Extracción de subcadenas mediante una coincidencia de expresión regular (sensible a mayúsculas y minúsculas).

Parámetros:

• patrón: la expresión regular a coincidir;
• salida: las opciones de salida. Se admiten los marcadores de posición \1 - \9 para capturar grupos. \0 devuelve el texto coincidente.

Comentarios:

• Si no hay coincidencia para la expresión regular, la función devuelve una cadena vacía.
• Si el patrón de la función es una expresión regular incorrecta, entonces la macro se evalúa como 'UNKNOWN' (excepto para macros de bajo nivel, en cuyo caso la función será ignorada y la macro permanecerá sin resolver).
• Las referencias a grupos de captura inexistentes en la cadena de reemplazo se reemplazan por una cadena vacía.

Ejemplos:

{{ITEM.VALUE}.regsub("^([0-9]+)", ID de problema: \1)} - se resolverá como "ID de problema: 123" si se recibe un valor como "123 Línea de registro"
       {{ITEM.VALUE}.regsub("fail|error|fault|problem","ERROR")} - se resolverá como "ERROR" si se reciben las subcadenas "fail", "error", "fault" o "problem" (sensible a mayúsculas y minúsculas); devolverá una cadena vacía si no hay coincidencia

Vea más ejemplos.

tr(caracteres,reemplazo)

Transliteración de los caracteres del valor de la macro.

• caracteres: el conjunto de caracteres a reemplazar;
• reemplazo: el conjunto de caracteres de reemplazo correspondientes posicionalmente.

Ejemplos:

{{ITEM.VALUE}.tr(abc, xyz)} - reemplazará todas las apariciones de "a" por "x", "b" por "y", "c" por "z"
       {{ITEM.VALUE}.tr(abc, xyzq)} - reemplazará todas las apariciones de "a" por "x", "b" por "y", "c" por "z" ("q" se ignora)
       {{ITEM.VALUE}.tr(abcde, xyz)} - reemplazará todas las apariciones de "a" por "x", "b" por "y", "c" por "z", "d" por "z", "e" por "z" (es decir, xyzzz)
       {{ITEM.VALUE}.tr("\\\'", "\/\"")} - reemplazará todas las apariciones de barra invertida por barra, comillas simples por comillas dobles
       {{ITEM.VALUE}.tr(A-Z,a-z)} - convertirá todas las letras a minúsculas
       {{ITEM.VALUE}.tr(0-9a-z,*)} - reemplazará todos los números y letras minúsculas por "*"
       {{ITEM.VALUE}.tr(0-9,ab)} - reemplazará todas las apariciones de 0 por "a", y todas las apariciones de 1, 2, 3, 4, 5, 6, 7, 8 y 9 por "b"
       {{ITEM.VALUE}.tr(0-9abcA-L,*)} - reemplazará todos los números, los caracteres "abc" y el rango A-L por "*"
       {{ITEM.VALUE}.tr("\n","*")} - reemplazará las apariciones de fin de línea por *
       {{ITEM.VALUE}.tr("e", "\n")} - reemplazará todas las "e" por fin de línea

Para incluir caracteres literales:

barra invertida - debe escaparse como \\
       comilla simple - debe escaparse como \'
       comilla doble - debe escaparse como \"

Secuencias de escape soportadas con barra invertida:

\\\\ => \\ - doble barra invertida a una sola barra invertida
       \\a  => \a - alerta
       \\b  => \b - retroceso
       \\f  => \f - salto de formulario
       \\n  => \n - nueva línea
       \\r  => \r - retorno
       \\t  => \t - tabulación horizontal
       \\v  => \v - tabulación vertical

mayúsculas

Transformación de todos los caracteres del valor de la macro a mayúsculas. Funciona con conjuntos de caracteres de un solo byte (como ASCII) y no admite UTF-8.

Ejemplo:

{{ITEM.VALUE}.uppercase()} - transformará un valor como "Zabbix Server" en "ZABBIX SERVER" (mayúsculas)

urldecode

Decodifica un valor de macro desde la codificación de URL.

Ejemplo:

{{ITEM.VALUE}.urldecode()} - decodificará un valor como "%2F" en "/"

urlencode

Codifica el valor de una macro en codificación URL.

Ejemplo:

{{ITEM.VALUE}.urlencode()} - codificará un carácter como "/" en "%2F"

Ejemplos adicionales

La siguiente tabla muestra más ejemplos de uso de funciones de macro.

Ver valores completos de los ítems

Los valores largos de las macros resueltas {ITEM.VALUE} y {ITEM.LASTVALUE} para ítems de texto/log se truncan a 20 caracteres en algunas ubicaciones del frontend. Para ver los valores completos de estas macros puede usar funciones de macro, por ejemplo:

{{ITEM.VALUE}.regsub("(.*)", \1)}
       {{ITEM.LASTVALUE}.regsub("(.*)", \1)}

Consulte también: detalles de las macros {ITEM.VALUE} y {ITEM.LASTVALUE} macro details.