18 Valor de la métrica

Descripción

Estos parámetros y los posibles valores de propiedad para los respectivos objetos de campo de widget de dashboard permiten configurar el widget Valor de item en los métodos dashboard.create y dashboard.update.

Las propiedades fields del widget no se validan durante la creación o actualización de un dashboard. 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 item, consulte el comportamiento de los parámetros que se describe en las tablas a continuación.

Parámetros

Los siguientes parámetros son compatibles con el widget Item value.

Parameter type name value
Refresh interval 0 rf_rate 0 - Sin actualización;
10 - 10 segundos;
30 - 30 segundos;
60 - (predeterminado) 1 minuto;
120 - 2 minutos;
600 - 10 minutos;
900 - 15 minutos.
Item 4 itemid.0 ID de Item.

Comportamiento del parámetro:
- obligatorio si Item (Widget) no está configurado
Item (Widget) 1 itemid._reference En lugar del ID de Item:
ABCDE._itemid - establece un widget compatible (con su parámetro Reference configurado como "ABCDE") como origen de datos para los items.

Comportamiento del parámetro:
- obligatorio si Item no está configurado
Show 0 show.0 1 - Descripción;
2 - Valor;
3 - Hora;
4 - Indicador de cambio;
5 - Sparkline.

Predeterminado: 1, 2, 3, 4.

Nota: Para configurar varios valores, cree un objeto de campo de widget del dashboard para cada valor con un número incrementado en el nombre de la propiedad.
Override host 1 override_hostid._reference ABCDE._hostid - establece un widget compatible (con su parámetro Reference configurado como "ABCDE") como origen de datos para hosts;
DASHBOARD._hostid - establece el selector Host del dashboard como origen de datos para hosts.

Este parámetro no es compatible si se configura el widget en un template dashboard.

Configuración avanzada

Los siguientes parámetros de configuración avanzada son compatibles con el widget Item value.

El número en el nombre de la propiedad Thresholds (por ejemplo, thresholds.0.color) hace referencia a la posición del threshold en una lista, ordenada de forma ascendente. Sin embargo, si los thresholds se configuran en un orden diferente, los valores se ordenarán de forma ascendente después de actualizar la configuración del widget en el frontend de Zabbix (por ejemplo, "thresholds.0.threshold":"5""thresholds.0.threshold":"1"; "thresholds.1.threshold":"1""thresholds.1.threshold": "5").

Parameter type name value
Color de fondo 1 bg_color Código de color hexadecimal (por ejemplo, FF0000).

Predeterminado: "" (vacío).
Thresholds
Color 1 thresholds.0.color Código de color hexadecimal (por ejemplo, FF0000).
Threshold 1 thresholds.0.threshold Cualquier valor de cadena.
Función de agregación 0 aggregate_function 0 - (predeterminado) 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 - establece el selector de período de tiempo como fuente de datos;
ABCDE._timeperiod - establece un widget compatible (con su parámetro reference igual a ABCDE) como fuente de datos.

Predeterminado: DASHBOARD._timeperiod

Alternativamente, puede establecer el período de tiempo solo en los parámetros From y To.

Comportamiento del parámetro:
- compatible si Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last"
From 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:
- compatible si Período de tiempo no está configurado y Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last"
- obligatorio si time_period.to está configurado
To 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:
- compatible si Período de tiempo no está configurado y Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last"
- obligatorio si time_period.from está configurado
Datos históricos 0 history 0 - (predeterminado) Auto;
1 - History;
2 - Trends.
Descripción

Se admiten los siguientes parámetros de configuración avanzada si Mostrar está establecido en "Descripción".

Parámetro tipo nombre valor
Descripción 1 description Cualquier valor de cadena, incluidas macros.
Macros admitidas: {HOST.*}, {ITEM.*}, {INVENTORY.*}, Macros de usuario.

Por defecto: {ITEM.NAME}.
Posición horizontal 0 desc_h_pos 0 - Izquierda;
1 - (por defecto) 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 desc_v_pos 0 - Arriba;
1 - Medio;
2 - (por defecto) 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 desc_size Los valores posibles van de 1-100.

Por defecto: 15.
Negrita 0 desc_bold 0 - (por defecto) Deshabilitado;
1 - Habilitado.
Color 1 desc_color Código de color hexadecimal (por ejemplo, FF0000).

Por defecto: "" (vacío).
Valor

Se admiten los siguientes parámetros de configuración avanzada si Mostrar está establecido en "Valor".

Parámetro tipo nombre valor
Decimales
Decimales 0 decimal_places Los valores posibles van de 1 a 10.

Por defecto: 2.
Tamaño 0 decimal_size Los valores posibles van de 1 a 100.

Por defecto: 35.
Posición
Posición horizontal 0 value_h_pos 0 - Izquierda;
1 - (por defecto) 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 - (por defecto) 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 van de 1 a 100.

Por defecto: 45.
Negrita 0 value_bold 0 - Deshabilitado;
1 - (por defecto) Habilitado.
Color 1 value_color Código de color hexadecimal (por ejemplo, FF0000).

Por defecto: "" (vacío).
Unidades
Unidades (casilla de verificación) 0 units_show 0 - Deshabilitado;
1 - (por defecto) Habilitado.
Unidades (valor) 1 units Cualquier valor de cadena.
Posición 0 units_pos 0 - Antes del valor;
1 - Encima del valor;
2 - (por defecto) Después del valor;
3 - Debajo del valor.
Tamaño 0 units_size Los valores posibles van de 1 a 100.

Por defecto: 35.
Negrita 0 units_bold 0 - Deshabilitado;
1 - (por defecto) Habilitado.
Color 1 units_color Código de color hexadecimal (por ejemplo, FF0000).

Por defecto: "" (vacío).
Hora

Se admiten los siguientes parámetros de configuración avanzada si Mostrar está establecido en "Hora".

Parámetro tipo nombre valor
Posición horizontal 0 time_h_pos 0 - Izquierda;
1 - (por defecto) 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 time_v_pos 0 - (por defecto) Arriba;
1 - 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 time_size Los valores posibles van de 1-100.

Por defecto: 15.
Negrita 0 time_bold 0 - (por defecto) Deshabilitado;
1 - Habilitado.
Color 1 time_color Código de color hexadecimal (por ejemplo, FF0000).

Por defecto: "" (vacío).
Indicador de cambio

Se admiten los siguientes parámetros de configuración avanzada si Mostrar está establecido en "Indicador de cambio".

Parámetro tipo nombre valor
Color del indicador de cambio ↑ 1 up_color Código de color hexadecimal (por ejemplo, FF0000).

Por defecto: "" (vacío).
Color del indicador de cambio ↓ 1 down_color Código de color hexadecimal (por ejemplo, FF0000).

Por defecto: "" (vacío).
Color del indicador de cambio ↕ 1 updown_color Código de color hexadecimal (por ejemplo, FF0000).

Por defecto: "" (vacío).
Sparkline

Los siguientes parámetros de configuración avanzados son compatibles si Show está establecido en "Sparkline".

Parameter type name value
Width 0 sparkline.width Los valores posibles van de 0 a 10.

Predeterminado: 1.
Fill 0 sparkline.fill Los valores posibles van de 0 a 10.

Predeterminado: 3.
Color 1 sparkline.color Código de color hexadecimal (por ejemplo, FF0000).

Predeterminado: 42A5F5.
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - establece el selector de Time period como fuente de datos;
ABCDE._timeperiod - establece un widget compatible (con su parámetro reference igual a ABCDE) como fuente de datos.

Predeterminado: DASHBOARD._timeperiod

Alternativamente, puede establecer el período de tiempo solo en los parámetros From y To.
From 1 sparkline.time_period.from Cadena de tiempo válida en sintaxis de tiempo absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).

Comportamiento del parámetro:
- required si sparkline.time_period.to está establecido
To 1 sparkline.time_period.to Cadena de tiempo válida en sintaxis de tiempo absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).

Comportamiento del parámetro:
- required si sparkline.time_period.from está establecido
History data 0 sparkline.history 0 - (predeterminado) Auto;
1 - History;
2 - Trends.

Ejemplos

Los siguientes ejemplos tienen como objetivo describir únicamente la configuración de los objetos de campo del widget de panel para el widget Valor de métrica. Para obtener más información sobre la configuración de un panel, 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 para la métrica "42266" (disponibilidad del agente Zabbix). Además, ajuste visualmente el widget con múltiples opciones avanzadas, incluyendo un color de fondo dinámico que cambia según el estado de disponibilidad del agente Zabbix.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "Mi panel",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "item",
                        "name": "Valor de métrica",
                        "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": "Estado del agente"
                            },
                            {
                                "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:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Véase también