Documentation
Table of Contents
21 Gráfico circular
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 Gráfico circular 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 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 circular, consulte el comportamiento de los parámetros descrito en las tablas siguientes.
Parámetros
Los siguientes parámetros son compatibles con el widget Gráfico circular.
| 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. |
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 elemento configurado.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Tipo de conjunto de datos | 0 | ds.0.dataset_type | 0 - Lista de elementos; 1 - (por defecto) Patrones de elementos. |
|
| Elementos | 4 | ds.0.itemids.0 | ID de Elemento. Al configurar el widget en un panel de plantilla, solo deben establecerse los elementos configurados en la plantilla. Nota: Para configurar varios elementos, cree un objeto de campo de widget de panel para cada elemento 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 elementos" y Elementos (Widget) no está establecido |
|
| Elementos (Widget) | 1 | ds.0.itemids.0._reference | En lugar del ID de Elemento:ABCDE._itemid - establezca un widget compatible (con su parámetro Referencia establecido en "ABCDE") como fuente de datos para los elementos.Nota: Para configurar varios widgets, cree un objeto de campo de widget de panel para cada widget 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 elementos" y Elementos no está establecido |
|
| Color | 1 | ds.0.color.0 | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - admitido si Tipo de conjunto de datos está establecido en "Lista de elementos" |
|
| Tipo de elemento | 0 | ds.0.type.0 | 0 - (por defecto) Normal; 1 - Total. El valor "Total" solo se puede establecer para un elemento en todo el gráfico. Comportamiento del parámetro: - admitido si Tipo de conjunto de datos está establecido en "Lista de elementos" |
|
| Patrones de host | 1 | ds.0.hosts.0 | Nombre o patrón de Host (por ejemplo, "Zabbix*"). Comportamiento del parámetro: - obligatorio si Tipo de conjunto de datos está establecido en "Patrones de elementos" Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Patrones de elementos | 1 | ds.0.items.0 | Nombre o patrón de Elemento (por ejemplo, "*: Número de valores procesados por segundo"). Al configurar el widget en un panel de plantilla, solo deben establecerse los patrones para los elementos configurados en la plantilla. Comportamiento del parámetro: - obligatorio si Tipo de conjunto de datos está establecido en "Patrones de elementos" |
|
| Color | 1 | ds.0.color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - admitido si Tipo de conjunto de datos está establecido en "Patrones de elementos" |
|
| Función de agregación | 0 | ds.0.aggregate_function | 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - (por defecto) last. |
|
| Agregación de conjunto de datos | 0 | ds.0.dataset_aggregation | 0 - (por defecto) ninguno; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum. Comportamiento del parámetro: - admitido si Tipo de elemento está establecido en "Total" |
|
| Etiqueta de conjunto de datos | 1 | ds.0.data_set_label | Cualquier valor de cadena. Por defecto: "" (vacío). |
|
Opciones de visualización
Se admiten los siguientes parámetros para configurar las Opciones de visualización.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Selección de datos históricos | 0 | source | 0 - (por defecto) Automático; 1 - Historial; 2 - Tendencias. |
|
| Dibujo | 0 | draw_type | 0 - (por defecto) Tarta; 1 - Rosquilla. |
|
| Ancho | 0 | width | 20 - 20% del radio; 30 - 30% del radio; 40 - 40% del radio; 50 - (por defecto) 50% del radio. Comportamiento del parámetro: - admitido si Dibujo está configurado como "Rosquilla" |
|
| Ancho del trazo | 0 | stroke | Los valores posibles van de 0-10. Por defecto: 0. Comportamiento del parámetro: - admitido si Dibujo está configurado como "Rosquilla" |
|
| Mostrar valor total | 0 | total_show | 0 - (por defecto) Deshabilitado; 1 - Habilitado. Comportamiento del parámetro: - admitido si Dibujo está configurado como "Rosquilla" |
|
| Tamaño | 0 | value_size_type | 0 - (por defecto) Automático; 1 - Personalizado. Comportamiento del parámetro: - admitido si Mostrar valor total está configurado como "Habilitado" |
|
| Tamaño (valor para tamaño personalizado) | 0 | value_size | Los valores posibles van de 1-100. Por defecto: 20. Comportamiento del parámetro: - admitido si Mostrar valor total está configurado como "Habilitado" |
|
| Decimales | 0 | decimal_places | Los valores posibles van de 0-6. Por defecto: 2. Comportamiento del parámetro: - admitido si Mostrar valor total está configurado como "Habilitado" |
|
| Unidades (casilla de verificación) | 0 | units_show | 0 - (por defecto) Deshabilitado; 1 - Habilitado. Comportamiento del parámetro: - admitido si Mostrar valor total está configurado como "Habilitado" |
|
| Unidades (valor) | 1 | units | Cualquier valor de cadena. Comportamiento del parámetro: - admitido si Unidades (casilla de verificación) está configurado como "Habilitado" |
|
| Negrita | 0 | value_bold | 0 - (por defecto) Deshabilitado; 1 - Habilitado. Comportamiento del parámetro: - admitido si Mostrar valor total está configurado como "Habilitado" |
|
| Color | 1 | value_color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - admitido si Mostrar valor total está configurado como "Habilitado" |
|
| Espacio entre sectores | 0 | space | Los valores posibles van de 0-10. Por defecto: 1. |
|
| Unir sectores menores que N% (casilla de verificación) | 0 | merge | 0 - (por defecto) Deshabilitado; 1 - Habilitado. |
|
| Unir sectores menores que N% (valor) | 0 | merge_percent | Los valores posibles van de 1-10. Por defecto: 1. Comportamiento del parámetro: - admitido si Unir sectores menores que N% (casilla de verificación) está configurado como "Habilitado" |
|
| Unir sectores menores que N% (color) | 1 | merge_color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - admitido si Unir sectores menores que N% (casilla de verificación) está configurado como "Habilitado" |
|
Período de tiempo
Se admiten los siguientes parámetros para configurar el Período de tiempo.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| 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 Referencia configurado en "ABCDE") como fuente de datos.Por defecto: DASHBOARD._timeperiodAlternativamente, puede establecer el período de tiempo solo en los parámetros Desde y Hasta. |
|
| Desde | 1 | time_period.from | Cadena de tiempo válida en sintaxis absoluta (AAAA-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - admitido si Período de tiempo no está establecido |
|
| Hasta | 1 | time_period.to | Cadena de tiempo válida en sintaxis absoluta (AAAA-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - admitido si Período de tiempo no está establecido |
|
Leyenda
Los siguientes parámetros son compatibles para configurar Legend.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Mostrar leyenda | 0 | legend | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. |
| Mostrar valor | 0 | legend_value | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Comportamiento de parámetros:< br>- compatible si Mostrar leyenda está configurado en "Activado" |
| 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 valor está configurado en "Desactivado" |
Ejemplos
Los siguientes ejemplos pretenden describir únicamente la configuración de los objetos de campo del widget del tablero para el widget Gráfico circular. Para obtener más información sobre cómo configurar un tablero, consulte dashboard.create.
Configuración de un widget Gráfico circular
Configure un widget Gráfico circular de la siguiente manera:
- 2 conjuntos de datos para un total de 9 métricas en 1 equipo.
- El primer conjunto de datos es del tipo "Lista de métricas" y consta de 3 métricas, todos de tipo "Normal" y representados por un color diferente.
- El segundo conjunto de datos es del tipo "Patrones de métricas", consta de 6 métricas, tiene una agregación configurada para cada métrica y está representado por un color personalizado.
- El segundo conjunto de datos también tiene una etiqueta de conjunto de datos personalizada.
- Los datos del gráfico circular se muestran como un gráfico de anillos con un ancho personalizado y un valor total con unidades en el centro.
- Los datos del gráfico circular se muestran y agregan para un período de tiempo personalizado de las últimas 3 horas.
- La leyenda del gráfico circular muestra las métricas configurados en 4 filas.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "piechart",
"name": "Pie chart",
"x": 0,
"y": 0,
"width": 24,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.0.type.1",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.0.type.2",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.3",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.3",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.type.3",
"value": 0
},
{
"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.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "draw_type",
"value": 1
},
{
"type": 0,
"name": "width",
"value": 30
},
{
"type": 0,
"name": "total_show",
"value": 1
},
{
"type": 0,
"name": "units_show",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 0,
"name": "legend_lines",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Respuesta: