Documentation
Table of Contents
18 Valor de métrica
Descripción
Estos parámetros y los posibles valores de propiedad para los respectivos objetos de campo del widget del tablero permiten configurar el widget Valor de la métrica en los métodos dashboard.create y dashboard.update.
Las propiedades de los "campos" del widget no se validan durante la creación o actualización de un tablero. Esto permite a los usuarios modificar los widgets integrados y crear widgets personalizados, pero también introduce el riesgo de crear o actualizar widgets. incorrectamente. Para garantizar la creación o actualización exitosa del widget Valor de la métrica, consulte el comportamiento de los parámetros que se describen en las tablas siguientes.
Parámetros
Se admiten los siguientes parámetros para el widget Valor del ítem.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Intervalo de actualización | 0 | rf_rate | 0 - Sin actualización; 10 - 10 segundos; 30 - 30 segundos; 60 - (por defecto) 1 minuto; 120 - 2 minutos; 600 - 10 minutos; 900 - 15 minutos. |
|
| Ítem | 4 | itemid.0 | ID del Ítem. Comportamiento del parámetro: - obligatorio si Ítem (Widget) no está establecido |
|
| Ítem (Widget) | 1 | itemid._reference | En lugar del ID del Ítem:ABCDE._itemid - establezca un widget compatible (con su parámetro Referencia configurado en "ABCDE") como fuente de datos para los ítems.Comportamiento del parámetro: - obligatorio si Ítem no está establecido |
|
| Mostrar | 0 | show.0 | 1 - Descripción; 2 - Valor; 3 - Hora; 4 - Indicador de cambio; 5 - Minigráfica. Por defecto: 1, 2, 3, 4. Nota: Para configurar varios valores, cree un objeto de campo de widget de panel para cada valor con un número incrementado en el nombre de la propiedad. |
|
| Anular equipo | 1 | override_hostid._reference | ABCDE._hostid - establezca un widget compatible (con su parámetro Referencia configurado en "ABCDE") como fuente de datos para los equipos;DASHBOARD._hostid - establezca el selector de Equipo del panel como fuente de datos para los equipos.Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
Configuración avanzada
Los siguientes parámetros de configuración avanzada son compatibles con el widget Valor del elemento.
El número en el nombre de la propiedad Umbrales (por ejemplo, thresholds.0.color) hace referencia a la posición del umbral en una lista, ordenada en orden ascendente. Sin embargo, si los umbrales se configuran en un orden diferente, los valores se ordenarán en orden ascendente después de actualizar la configuración del widget en la interfaz de Zabbix (por ejemplo, "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5").
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Color de fondo | 1 | bg_color | Código de color hexadecimal (por ejemplo, FF0000).Por defecto: "" (vacío). |
|
| Umbrales | ||||
| Color | 1 | thresholds.0.color | Código de color hexadecimal (por ejemplo, FF0000). |
|
| Umbral | 1 | thresholds.0.threshold | Cualquier valor de cadena. | |
| Función de agregación | 0 | aggregate_function | 0 - (por defecto) no usado; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Período de tiempo | 1 | time_period._reference | DASHBOARD._timeperiod - establecer el selector de Período de tiempo como fuente de datos;ABCDE._timeperiod - establecer un widget compatible (con su parámetro reference igual a ABCDE) como fuente de datos.Por defecto: DASHBOARD._timeperiodAlternativamente, puede establecer el período de tiempo solo en los parámetros Desde y Hasta. Comportamiento del parámetro: - soportado si la Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last" |
|
| Desde | 1 | time_period.from | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - soportado si Período de tiempo no está establecido y la Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last" |
|
| Hasta | 1 | time_period.to | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - soportado si Período de tiempo no está establecido y la Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last" |
|
| Datos históricos | 0 | history | 0 - (por defecto) Automático; 1 - Historial; 2 - Tendencias. |
|
Descripción
Los siguientes parámetros son compatibles si Configuración avanzada está configurado en "Activado" y Mostrar está configurado en "Descripción".
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Description | 1 | descripción | Cualquier valor de cadena, incluidas las macros. Macros admitidas: {HOST.*}, {ITEM.*}, {INVENTORY.*}, Macros de usuario. < br>Predeterminado: {ITEM.NAME}. |
| Horizontal position | 0 | desc_h_pos | 0 - Izquierda; 1 - (predeterminado) Centro; 2 - Derecha. Dos o más elementos (Descripción, Valor, Hora) no puede compartir la misma posición horizontal y posición vertical. |
| Vertical position | 0 | desc_v_pos | 0 - Arriba; 1 - Medio; 2 - (predeterminado) Abajo. Dos o más elementos (Descripción, Valor, Tiempo) no puede compartir la misma posición horizontal y posición vertical. |
| Size | 0 | desc_size | Los valores válidos oscilan entre 1 y 100. Predeterminado: 15. |
| Bold | 0 | desc_bold | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
| Color | 1 | desc_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: "" (vacío). |
Valor
Los siguientes parámetros de configuración avanzada son compatibles si Mostrar está establecido en "Valor".
|Parámetro|<|tipo|nombre|valor| |-|--------|--|--------|-------------------------- -----| |Lugares decimales|<|<|<|<| |<|Lugares decimales|0|decimal_places|Los valores posibles van del 1 al 10.
Predeterminado: 2.| |^|Tamaño|0|decimal_size|Los valores posibles oscilan entre 1 y 100.
Predeterminado: 35.| |Posición|<|<|<|<| |<|Posición horizontal|0|value_h_pos|0 - Izquierda;
1 - (predeterminado) Centro;
2 - Derecha.
Dos o más elementos (Descripción, Valor, Hora) no pueden compartir la misma Posición horizontal y Posición vertical.| |^|Posición vertical|0|value_v_pos|0 - Arriba;
1 - (predeterminado) Medio;
2 - Abajo.
Dos o más elementos (Descripción, Valor, Hora) no pueden compartir la misma Posición horizontal y Posición vertical.| |^|Tamaño|0|value_size|Los valores posibles oscilan entre 1 y 100.
Predeterminado: 45.| |^|Negrita|0|value_bold|0 - Deshabilitado;
1 - (predeterminado) Habilitado.| |^|Color|1|value_color|Código de color hexadecimal (por ejemplo, FF0000).
Predeterminado: "" (vacío).| |Unidades|<|<|<|<| |<|Unidades (casilla de verificación)|0|units_show|0 - Deshabilitado;
1 - (predeterminado) Habilitado.| |^|Unidades (valor)|1|unidades|Cualquier valor de cadena.| |^|Posición|0|units_pos|0 - Antes del valor;
1 - Por encima del valor;
2 - (predeterminado) Después del valor;
3 - Por debajo del valor.| |^|Tamaño|0|units_size|Los valores posibles oscilan entre 1 y 100.
Predeterminado: 35.| |^|Negrita|0|units_bold|0 - Deshabilitado;
1 - (predeterminado) Habilitado.| |^|Color|1|units_color|Código de color hexadecimal (por ejemplo, FF0000).
Predeterminado: "" (vacío).|
Tiempo
Los siguientes parámetros de configuración avanzada son compatibles si Mostrar está configurado en "Hora".
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Posición horizontal | 0 | time_h_pos | 0 - Izquierda; 1 - (predeterminado) Centro; 2 - Derecha. Dos o más elementos (Descripción, Valor, Hora) no puede compartir la misma posición horizontal y posición vertical. |
| Posición vertical | 0 | time_v_pos | 0 - (predeterminado) Arriba; 1 - Medio; 2 - Abajo. Dos o más elementos (Descripción, Valor, Tiempo) no puede compartir la misma posición horizontal y posición vertical. |
| Tamaño | 0 | time_size | Los valores posibles oscilan entre 1 y 100. Predeterminado: 15. |
| Negrita | 0 | time_bold | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
| Color | 1 | time_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: "" (vacío). |
Cambiar indicador
Los siguientes parámetros de configuración avanzada son compatibles si Mostrar está configurado en "Indicador de cambio".
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Indicador de cambio ↑ color | 1 | up_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: "" (vacío). |
| Cambiar indicador ↓ color | 1 | down_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: "" (vacío). |
| Cambiar indicador ↕ color | 1 | updown_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: "" (vacío). |
Minigráfico
Se admiten los siguientes parámetros de configuración avanzada si Mostrar está establecido en "Minigráfico".
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Ancho | 0 | sparkline.width | Los valores posibles van de 0 a 10. Por defecto: 1. |
|
| Relleno | 0 | sparkline.fill | Los valores posibles van de 0 a 10. Por defecto: 3. |
|
| Color | 1 | sparkline.color | Código de color hexadecimal (por ejemplo, FF0000).Por defecto: 42A5F5. |
|
| Periodo de tiempo | 1 | sparkline.time_period._reference | DASHBOARD._timeperiod - establece el selector de Periodo de tiempo como fuente de datos;ABCDE._timeperiod - establece un widget compatible (con su parámetro reference igual a ABCDE) como fuente de datos.Por defecto: DASHBOARD._timeperiodAlternativamente, puede establecer el periodo de tiempo solo en los parámetros Desde y Hasta. |
|
| Desde | 1 | sparkline.time_period.from | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.). |
|
| Hasta | 1 | sparkline.time_period.to | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.). |
|
| Datos históricos | 0 | sparkline.history | 0 - (por defecto) Automático; 1 - Historial; 2 - Tendencias. |
|
Ejemplos
Los siguientes ejemplos pretenden describir únicamente la configuración de los objetos de campo del widget del tablero para el widget Valor de la métrica. Para obtener más información sobre cómo configurar un tablero, consulte dashboard.create.
Configuración de un widget Valor de métrica
Configure un widget Valor de métrica que muestre el valor de la métrica "42266" (disponibilidad del agente Zabbix). Además, ajuste visualmente el widget con múltiples opciones avanzadas, incluido un color de fondo dinámico que cambia según el estado de disponibilidad del agente Zabbix.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "item",
"name": "Item value",
"x": 0,
"y": 0,
"width": 12,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 42266
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 1,
"name": "description",
"value": "Agent status"
},
{
"type": 0,
"name": "desc_h_pos",
"value": 0
},
{
"type": 0,
"name": "desc_v_pos",
"value": 0
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 1,
"name": "desc_color",
"value": "F06291"
},
{
"type": 0,
"name": "value_h_pos",
"value": 0
},
{
"type": 0,
"name": "value_size",
"value": 25
},
{
"type": 1,
"name": "value_color",
"value": "FFFF00"
},
{
"type": 0,
"name": "units_show",
"value": 0
},
{
"type": 0,
"name": "time_h_pos",
"value": 2
},
{
"type": 0,
"name": "time_v_pos",
"value": 2
},
{
"type": 0,
"name": "time_size",
"value": 10
},
{
"type": 0,
"name": "time_bold",
"value": 1
},
{
"type": 1,
"name": "time_color",
"value": "9FA8DA"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "E1E1E1"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D1C4E9"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "1"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Respuesta: