Documentation
Table of Contents
26 Equipos principales
Descripción
Estos parámetros y los posibles valores de las propiedades para los respectivos objetos de campo del widget del panel permiten configurar el widget Top Hosts 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 Equipos principales, consulte el comportamiento de los parámetros que se describen en las tablas siguientes.
Parámetros
Los siguientes parámetros son compatibles con el widget Equipos principales.
| 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. |
|
| Grupos de hosts | 2 | groupids | ID de grupo de equipos. Nota: Para configurar varios grupos de equipos, cree un objeto de campo de widget de tablero para cada grupo de equipos. |
|
| Equipos | 3 | hostids | ID de equipo. Nota: Para configurar varios equipos, cree un objeto de campo de widget de tablero para cada equipos . Para varios equipos, el parámetro Grupos de equipos no debe estar configurado en absoluto o configurarse con al menos un grupo de equipos al que pertenecen los equipos configurados. |
|
| Etiquetas de equipos (el número en el nombre de la propiedad (por ejemplo, etiquetas.tag.0) hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas) | ||||
| Tipo de evaluación | 0 | evaltype | 0 - (predeterminado) Y/O; 2 - O. |
|
| Nombre de etiqueta | 1 | tags.tag.0 | Cualquier valor de cadena. Comportamiento del parámetro: - obligatorio si configura Etiquetas |
|
| Operador | 0 | tags.operator.0 | 0 - Contiene; 1 - Es igual; 2 - No contiene; 3 - No es igual; 4 - Existe ; 5 - No existe. Comportamiento de parámetros: - obligatorio si se configuran Etiquetas |
|
| Valor de etiqueta | 1 | tags.value.0 | Cualquier valor de cadena. Comportamiento del parámetro: - obligatorio si configura Etiquetas |
|
| Columnas (ver más abajo) | ||||
| Orden | 0 | order | 2 - (predeterminado) N superior; 3 - N inferior. |
|
| Columna de orden | 0 | column | Valor numérico de la columna de las columnas configuradas. | |
| Recuento de equipos | 0 | count | Los valores válidos oscilan entre 1 y 100. Predeterminado: 10. |
|
Columnas
Las columnas tienen parámetros comunes y parámetros adicionales dependiendo de la configuración del parámetro Data.
Para todos los parámetros relacionados con columnas, el número en el nombre de la propiedad (por ejemplo, columns.0.name) hace referencia a una columna para la cual el parámetro está configurado.
Los siguientes parámetros son compatibles con todas las columnas.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Nombre | 1 | columns.0.name | Cualquier valor de cadena. Comportamiento del parámetro: - obligatorio |
| Datos | 0 | columns.0.data | 1 - Valor de la métrica; 2 - Nombre del equipo; 3 - Texto. Comportamiento del parámetro: - obligatorio |
| Color base | 1 | columns.0.base_color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - obligatorio |
Valor de la métrica
Los siguientes parámetros son compatibles si Datos se establece en "Valor de la métrica".
El primer número en el nombre de la propiedad Umbrales (por ejemplo, columnsthresholds.0.color.0) hace referencia a la columna para la cual se configuran los umbrales. mientras que el segundo número hace referencia al lugar 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, "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1. threshold": "5").
|Parámetro|<|tipo|nombre|valor| |-|--------|--|--------|-------------------------- -----| |Métrica|<|1 |columns.0.item|Nombre válido de métrica.
Al configurar el widget en un tablero de plantilla, solo deben asignarse métricas configuradas en la plantilla.| |Pantalla|<|0|columns.0.display|1 - (predeterminado) Tal cual;
2 - Barra;
3 - Indicadores.| |Min|<|1|columns.0.min|Cualquier valor numérico.
Comportamiento del parámetro:
- compatible si Pantalla está configurada en "Barra" o "Indicadores"| |Max|<|1|columns.0.max|Cualquier valor numérico.
Comportamiento del parámetro:
- compatible si Pantalla está configurada en "Barra" o "Indicadores"| |Lugares decimales|<|0|columns.0.decimal_places|Los valores posibles oscilan entre 0 y 10.
Predeterminado: 2.| |Umbrales|<|<|<|<| |<|Color|1|columnsthresholds.0.color.0|Código de color hexadecimal (por ejemplo, FF0000).
Predeterminado: "" (vacío).| |^|Umbral|1|columnsthresholds.0.threshold.0|Cualquier valor de cadena.| |Función de agregación|<|0|columns.0.aggregate_function|0 - (predeterminado) no utilizado;
1 - min;
2 - max;
3 - avg;
4 - contar;
5 - suma;
6 - primero;
7 - último.| |Período de tiempo|<|1|columns.0.time_period._reference|DASHBOARD._timeperiod - establezca 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.
< br>Predeterminado: DASHBOARD._timeperiod
Alternativamente, puede establecer el período de tiempo solo en los parámetros Desde y Hasta.
Comportamiento de parámetros:
- compatible si la Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last" | |<|Desde|1|columns.0.time_period.from|Cadena de tiempo válida en sintaxis de tiempo absoluta (AAAA-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).
Comportamiento de parámetros:
- 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"| |^|Hasta|1|columns.0.time_period.to|Cadena de tiempo válida en sintaxis de tiempo absoluta (AAAA-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).
Comportamiento de parámetros:
- compatible si Período de tiempo no está establecido y Función de agregación está configurada en "min", "max", "avg", "count", "sum", "first", "last"| |Datos del historial|<|0|columns.0.history|0 - (predeterminado) Automático;
1 - Historial;
2 - Tendencias.| |Referencia|<|1|referencia|Cualquier valor de cadena que consta de 5 caracteres (por ejemplo, ABCDE o JBPNL). Este valor debe ser único dentro del panel al que pertenece el widget.
Comportamiento del parámetro:
- requerido|
Texto
Los siguientes parámetros son compatibles si Datos está configurado en "Texto".
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Texto | 1 | columns.0.text | Cualquier valor de cadena, incluidas las macros. Macros admitidas: {HOST.*}, {INVENTORY.*}. [Comportamiento de los parámetros] (/manual/api/reference_commentary#parameter-behavior): - obligatorio si Datos está configurado en "Texto" |
Ejemplos
Los siguientes ejemplos pretenden describir únicamente la configuración de los objetos de campo del widget del tablero para el widget Equipos principales. Para obtener más información sobre cómo configurar un tablero, consulte dashboard.create.
Configuración de un widget Host principales
Configure un widget Equipos principales que muestre los equipos principales por utilización de CPU en el grupo de equipos "4". Además, configure las siguientes columnas personalizadas: "Nombre de equipo", "Utilización de CPU en %", "1m avg", "5m avg ", "15m avg", "Procesos".
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "columns.0.name",
"value": "Host"
},
{
"type": 0,
"name": "columns.0.data",
"value": 2
},
{
"type": 1,
"name": "columns.0.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.1.name",
"value": "CPU utilization in %"
},
{
"type": 0,
"name": "columns.1.data",
"value": 1
},
{
"type": 1,
"name": "columns.1.base_color",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.1.item",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.1.display",
"value": 3
},
{
"type": 1,
"name": "columns.1.min",
"value": "0"
},
{
"type": 1,
"name": "columns.1.max",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.1.color.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.1.color.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.1.color.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.2",
"value": "90"
},
{
"type": 1,
"name": "columns.2.name",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.2.data",
"value": 1
},
{
"type": 1,
"name": "columns.2.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.2.item",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.3.name",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.3.data",
"value": 1
},
{
"type": 1,
"name": "columns.3.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.3.item",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.4.name",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.4.data",
"value": 1
},
{
"type": 1,
"name": "columns.4.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.4.item",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.5.name",
"value": "Processes"
},
{
"type": 0,
"name": "columns.5.data",
"value": 1
},
{
"type": 1,
"name": "columns.5.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.5.item",
"value": "Number of processes"
},
{
"type": 0,
"name": "columns.5.decimal_places",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Respuesta: