Documentation
Table of Contents
9 Gráfico
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 Gráfico 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 Gráfico, consulte el comportamiento de los parámetros descritos en las tablas a continuación.
Parámetros
Los siguientes parámetros son compatibles con el widget Graph.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Intervalo de actualización | 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. |
| Referencia | 1 | reference | Cualquier valor de cadena que consta de 5 caracteres (por ejemplo, ABCDE o JBPNL). Este valor debe ser único dentro del tablero al que pertenece el widget.Comportamiento del parámetro: - requerido |
Conjunto de datos
Se admiten los siguientes parámetros para configurar un Conjunto de datos.
El primer número en el nombre de la propiedad (por ejemplo, ds.0.hosts.0, ds.0.items.0) representa el conjunto de datos en particular, mientras que el segundo número, si está presente, representa el host o el item configurado.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Tipo de conjunto de datos | 0 | ds.0.dataset_type | 0 - Lista de items; 1 - (por defecto) Patrones de items. |
|
| Items | 4 | ds.0.itemids.0 | ID del item. Al configurar el widget en un dashboard de template, sólo deben establecerse los items configurados en el template. Nota: Para configurar varios items, cree un objeto de campo de widget de dashboard para cada item con un número incrementado en el nombre de la propiedad. Comportamiento del parámetro: - obligatorio si Tipo de conjunto de datos está establecido en "Lista de items" y Items (Widget) no está establecido |
|
| Items (Widget) | 1 | ds.0.itemids.0._reference | En lugar del ID del item:ABCDE._itemid - establezca un widget compatible (con su parámetro Referencia establecido en "ABCDE") como fuente de datos para los items.Nota: Para configurar varios widgets, cree un objeto de campo de widget de dashboard para cada widget con un número incrementado en el nombre de la propiedad. Este parámetro es compatible desde Zabbix 7.0.1. Comportamiento del parámetro: - obligatorio si Tipo de conjunto de datos está establecido en "Lista de items" y Items no está establecido |
|
| Color | 1 | ds.0.color.0 | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - obligatorio si Tipo de conjunto de datos está establecido en "Lista de items" |
|
| Patrones de host | 1 | ds.0.hosts.0 | Nombre o patrón del host (por ejemplo, "Zabbix*"). Comportamiento del parámetro: - obligatorio si Tipo de conjunto de datos está establecido en "Patrones de items" Este parámetro no es compatible si se configura el widget en un dashboard de template. |
|
| Patrones de items | 1 | ds.0.items.0 | Nombre o patrón del item (por ejemplo, "*: Número de valores procesados por segundo"). Al configurar el widget en un dashboard de template, sólo deben establecerse los patrones para los items configurados en el template. Comportamiento del parámetro: - obligatorio si Tipo de conjunto de datos está establecido en "Patrones de items" |
|
| Color | 1 | ds.0.color | Código de color hexadecimal (por ejemplo, FF0000).Por defecto: FF465C.Comportamiento del parámetro: - compatible si Tipo de conjunto de datos está establecido en "Patrones de items" |
|
| Dibujar | 0 | ds.0.type | 0 - (por defecto) Línea; 1 - Puntos; 2 - Escalera; 3 - Barra. |
|
| Apilado | 0 | ds.0.stacked | 0 - (por defecto) Deshabilitado; 1 - Habilitado. Comportamiento del parámetro: - compatible si Dibujar está establecido en "Línea", "Escalera" o "Barra" |
|
| Ancho | 0 | ds.0.width | Los valores posibles van de 1 a 10. Por defecto: 1. Comportamiento del parámetro: - compatible si Dibujar está establecido en "Línea" o "Escalera" |
|
| Tamaño del punto | 0 | ds.0.pointsize | Los valores posibles van de 1 a 10. Por defecto: 3. Comportamiento del parámetro: - compatible si Dibujar está establecido en "Puntos" |
|
| Transparencia | 0 | ds.0.transparency | Los valores posibles van de 1 a 10. Por defecto: 5. |
|
| Relleno | 0 | ds.0.fill | Los valores posibles van de 1 a 10. Por defecto: 3. Comportamiento del parámetro: - compatible si Dibujar está establecido en "Línea" o "Escalera" |
|
| Datos faltantes | 0 | ds.0.missingdatafunc | 0 - (por defecto) Ninguno; 1 - Conectado; 2 - Tratar como 0; 3 - Último conocido. Comportamiento del parámetro: - compatible si Dibujar está establecido en "Línea" o "Escalera" |
|
| Eje Y | 0 | ds.0.axisy | 0 - (por defecto) Izquierda; 1 - Derecha. |
|
| Desplazamiento de tiempo | 1 | ds.0.timeshift | Cadena de tiempo válida (por ejemplo, 3600, 1h, etc.).Puede utilizar sufijos de tiempo. También se permiten valores negativos. Por defecto: "" (vacío). |
|
| Función de agregación | 0 | ds.0.aggregate_function | 0 - (por defecto) no usado; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Intervalo de agregación | 1 | ds.0.aggregate_interval | Cadena de tiempo válida (por ejemplo, 3600, 1h, etc.).Puede utilizar sufijos de tiempo. Por defecto: 1h. |
|
| Agrupar | 0 | ds.0.aggregate_grouping | 0 - (por defecto) Cada item; 1 - Conjunto de datos. Comportamiento del parámetro: - compatible si Función de agregación está establecido en "min", "max", "avg", "count", "sum", "first" o "last" |
|
| Aproximación | 0 | ds.0.approximation | 1 - min; 2 - (por defecto) avg; 4 - max; 7 - all. |
|
| Etiqueta del conjunto de datos | 1 | ds.0.data_set_label | Cualquier valor de cadena. Por defecto: "" (vacío). |
|
Opciones de pantalla
Los siguientes parámetros son compatibles para configurar Opciones de visualización.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Selección de datos del historial | 0 | source | 0 - (predeterminado) Automático; 1 - Historial; 2 - Tendencias. |
|
| Disparadores simples | 0 | simple_triggers | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
|
| Tiempo de trabajo | 0 | working_time | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
|
| Línea percentil (izquierda) | ||||
| Estado | 0 | percentile_left | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Comportamiento de parámetros: - compatible si el eje Y (en la configuración de conjunto de datos) está configurado en "Izquierda" |
|
| Valor | 0 | percentile_left_value | Los valores posibles oscilan entre 1 y 100. Comportamiento del parámetro: - compatible si Eje Y (en la configuración Conjunto de datos) está establecido en "Izquierda" |
|
| Línea percentil (derecha) | ||||
| Estado | 0 | percentile_right | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Comportamiento de parámetros: - compatible si el eje Y (en la configuración de conjunto de datos) está configurado en "Derecha" |
|
| Valor | 0 | percentile_right_value | Los valores posibles oscilan entre 1 y 100. Comportamiento del parámetro: - compatible si Eje Y (en la configuración Conjunto de datos) está establecido en "Derecha" |
|
Periodo de tiempo
Se admiten los siguientes parámetros para configurar el Periodo de tiempo.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Periodo de tiempo | 1 | 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 Referencia configurado como "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 | 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: - admitido si Periodo de tiempo no está configurado - obligatorio si se establece time_period.to |
|
| 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: - admitido si Periodo de tiempo no está configurado - obligatorio si se establece time_period.from |
|
Ejes
Los siguientes parámetros son compatibles para configurar Ejes.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Izquierda Y | 0 | lefty | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. Comportamiento de parámetros:< br>- compatible si el eje Y (en la configuración de conjunto de datos) está configurado en "Izquierda" |
| Derecha Y | 0 | righty | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Comportamiento del parámetro:< br>- compatible si el eje Y (en la configuración de conjunto de datos) está configurado en "Derecha" |
| Min | 1 | lefty_min | Cualquier valor numérico. Predeterminado: "" (vacío). |
| righty_min | |||
| Max | 1 | lefty_max | Cualquier valor numérico. Predeterminado: "" (vacío). |
| righty_max | |||
| Unidades (tipo) | 0 | lefty_units | 0 - (predeterminado) Automático; 1 - Estático. |
| righty_units | |||
| Unidades (valor) | 1 | lefty_static_units | Cualquier valor de cadena. Predeterminado: "" (vacío). |
| righty_static_units | |||
| Eje X | 0 | xaxis | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. |
Leyenda
Los siguientes parámetros son compatibles para configurar Legend.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Mostrar leyenda | 0 | legend | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. Comportamiento del parámetro:< br>- compatible si Mostrar leyenda está configurado en "Activado" |
| Mostrar min/avg/max | 0 | legend_statistic | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Comportamiento de parámetros: - compatible si Mostrar leyenda está configurado en "Habilitado" |
| Mostrar función de agregación | 0 | legend_aggregation | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Comportamiento de parámetros: - compatible si Mostrar leyenda está configurado en "Activado" |
| Filas | 0 | legend_lines_mode | 0 - (predeterminado) Fijo; 1 - Variable. Comportamiento del parámetro:<br >- compatible si Mostrar leyenda está configurado en "Activado" |
| Número de filas/ Número máximo de filas |
0 | legend_lines | Los valores posibles oscilan entre 1 y 10. Predeterminado: 1. Comportamiento del parámetro: - compatible si Mostrar leyenda está configurado en "Habilitado" |
| Número de columnas | 0 | legend_columns | Los valores posibles oscilan entre 1 y 4. Predeterminado: 4. Comportamiento de parámetros: - compatible si Mostrar leyenda está configurado en "Activado" y Mostrar min/avg/max está configurado en "Desactivado" |
Problemas
Los siguientes parámetros son compatibles para configurar Problemas.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Mostrar problemas | 0 | show_problems | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
|
| Solo métricas seleccionadas | 0 | graph_item_problems | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. |
|
| Equipos problemáticos | 1 | problemhosts.0 | Host nombre. Nota: El número en el nombre de la propiedad hace referencia al equipo configurado. Para configurar varios equipos, cree un objeto de campo de widget de tablero para cada equipo con un número incrementado en el nombre de la propiedad. Este parámetro no se admite si se configura el widget en una plantilla de tablero. |
|
| Gravedad | 0 | severities.0 | 0 - No clasificado; 1 - Información; 2 - Advertencia; 3 - Promedio; 4 - Alto; 5 - Desastre. Valor predeterminado: vacío (todo habilitado). Nota: para configurar varios valores, cree un objeto de campo del widget del tablero para cada valor con un número incrementado en el nombre de la propiedad. |
|
| Problema | 1 | problem_name | Problema nombre del evento (no distingue entre mayúsculas y minúsculas, nombre completo o parte del mismo). | |
| Etiquetas de problema | ||||
| Tipo de evaluación | 0 | evaltype | 0 - (predeterminado) Y/O; 2 - O. |
|
| Nombre de etiqueta | 1 | tags.0.tag | Cualquier valor de cadena. Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas. Comportamiento de parámetros: - obligatorio si se configuran Etiquetas de problema |
|
| Operador | 0 | tags.0.operator | 0 - Contiene; 1 - Es igual; 2 - No contiene; 3 - No es igual; 4 - Existe ; 5 - No existe. Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Etiquetas de problema |
|
| Valor de etiqueta | 1 | tags.0.value | Cualquier valor de cadena. Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas. Comportamiento de parámetros: - obligatorio si se configuran Etiquetas de problema |
|
Anulaciones
Los siguientes parámetros son compatibles para configurar Anulaciones.
El primer número en el nombre de la propiedad (por ejemplo, or.0.hosts.0, or.0.items.0) representa el conjunto de datos en particular, mientras que el segundo número, si está presente, representa el host o item configurado.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Patrones de host | 1 | or.0.hosts.0 | Nombre o patrón de host (por ejemplo, Zabbix*).Este parámetro no es compatible si se configura el widget en un dashboard de template. Comportamiento del parámetro: - obligatorio si se configuran Anulaciones |
| Patrones de item | 1 | or.0.items.0 | Nombre o patrón de item (por ejemplo, *: Number of processed *values per second).Al configurar el widget en un dashboard de template, solo se deben establecer los patrones para los items configurados en el template. Comportamiento del parámetro: - obligatorio si se configuran Anulaciones |
| Color base | 1 | or.0.color | Código de color hexadecimal (por ejemplo, FF0000). |
| Ancho | 0 | or.0.width | Los valores posibles van de 1 a 10. |
| Dibujo | 0 | or.0.type | 0 - Línea; 1 - Puntos; 2 - Escalera; 3 - Barra. |
| Transparencia | 0 | or.0.transparency | Los valores posibles van de 1 a 10. |
| Relleno | 0 | or.0.fill | Los valores posibles van de 1 a 10. |
| Tamaño del punto | 0 | or.0.pointsize | Los valores posibles van de 1 a 10. |
| Datos faltantes | 0 | or.0.missingdatafunc | 0 - Ninguno; 1 - Conectado; 2 - Tratar como 0; 3 - Último conocido. |
| Eje Y | 0 | or.0.axisy | 0 - Izquierda; 1 - Derecha. |
| Desplazamiento de tiempo | 1 | or.0.timeshift | Cadena de tiempo válida (por ejemplo, 3600, 1h, etc.).Puede usar sufijos de tiempo. Se permiten valores negativos. |
Ejemplos
Los siguientes ejemplos pretenden describir únicamente la configuración de los objetos de campo del widget del dashboard para el widget Graph. Para obtener más información sobre la configuración de un dashboard, consulte dashboard.create.
Configuración de un widget Graph
Configure un widget Graph de la siguiente manera:
- 2 conjuntos de datos para un total de 9 items en 1 host.
- El primer conjunto de datos es de tipo "Lista de items" y consta de 3 items que se representan mediante líneas de diferente color, pero con el mismo ancho, transparencia y relleno.
- El segundo conjunto de datos es de tipo "Patrones de items", consta de 6 items, tiene una agregación configurada y se representa mediante una línea con un color, ancho, transparencia y relleno personalizados.
- El segundo conjunto de datos también tiene una etiqueta de conjunto de datos personalizada.
- Los datos en el gráfico se muestran para un período de tiempo de las últimas 3 horas.
- Los problemas en el gráfico se muestran solo para los items configurados.
- El gráfico tiene dos ejes Y, de los cuales el eje Y derecho muestra valores solo para el segundo conjunto de datos.
- La leyenda del gráfico muestra los items configurados en 4 filas, así como los valores mínimo, máximo y promedio de los conjuntos de datos.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "svggraph",
"name": "Graph",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.width",
"value": 3
},
{
"type": 0,
"name": "ds.0.transparency",
"value": 3
},
{
"type": 0,
"name": "ds.0.fill",
"value": 1
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.transparency",
"value": 0
},
{
"type": 0,
"name": "ds.1.fill",
"value": 0
},
{
"type": 0,
"name": "ds.1.axisy",
"value": 1
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.aggregate_interval",
"value": "1m"
},
{
"type": 0,
"name": "ds.1.aggregate_grouping",
"value": 1
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_statistic",
"value": 1
},
{
"type": 0,
"name": "legend_lines",
"value": 4
},
{
"type": 0,
"name": "show_problems",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "YZABC"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Respuesta:
Ver también
-Campo de widget de dashboard -dashboard.create -dashboard.update