Documentation
Table of Contents
28 Métricas principales
Descripción
Estos parámetros y los posibles valores de las propiedades para los respectivos objetos de campo del widget de panel permiten configurar el widget Elementos principales 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 panel. Esto permite a los usuarios modificar widgets integrados y crear widgets personalizados, pero también introduce el riesgo de crear o actualizar widgets de forma incorrecta. Para garantizar la creación o actualización exitosa del widget Elementos principales, consulte el comportamiento de los parámetros que se describe en las tablas a continuación.
Parámetros
Se admiten los siguientes parámetros para el widget Elementos principales.
| 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. |
|
| Grupos de equipos | 2 | groupids.0 | ID de Grupo de equipos. Nota: Para configurar varios grupos de equipos, cree un objeto de campo de widget de panel para cada grupo de equipos con un número incrementado en el nombre de la propiedad. Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Grupos de equipos (Widget) | 1 | groupids._reference | En lugar del ID de Grupo de equipos:ABCDE._hostgroupids - establezca un widget compatible (con su parámetro Referencia configurado en "ABCDE") como fuente de datos para los grupos de equipos.Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Equipos | 3 | hostids.0 | ID de Equipo. Nota: Para configurar varios equipos, cree un objeto de campo de widget de panel para cada equipo con un número incrementado en el nombre de la propiedad. Para varios equipos, el parámetro Grupos de equipos debe no estar configurado en absoluto o configurado con al menos un grupo de equipos al que pertenezcan los equipos configurados. Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Equipos (Widget/Panel) | 1 | hostids._reference | En lugar del ID de Equipo:DASHBOARD.hostids - establezca el selector de Equipo como fuente de datos para los equipos;ABCDE._hostids - establezca un widget compatible (con su parámetro Referencia configurado en "ABCDE") como fuente de datos para los equipos.Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Etiquetas de equipo | ||||
| Tipo de evaluación | 0 | host_tags_evaltype | 0 - (por defecto) Y/O; 2 - O. Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Nombre de etiqueta | 1 | host_tags.0.tag | Cualquier valor de cadena. Nota: El número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Etiquetas de equipo Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Operador | 0 | host_tags.0.operator | 0 - Contiene; 1 - Igual a; 2 - No contiene; 3 - No igual a; 4 - Existe; 5 - No existe. Nota: El número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Etiquetas de equipo Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Valor de etiqueta | 1 | host_tags.0.value | Cualquier valor de cadena. Nota: El número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Etiquetas de equipo Este parámetro no es compatible si se configura el widget en un panel de plantilla. |
|
| Disposición | 0 | layout | 0 - (por defecto) Horizontal; 1 - Vertical. |
|
| Mostrar problemas | 0 | show_problems | 0 - Todos; 1 - (por defecto) No suprimidos; 2 - Ninguno. |
|
| Elementos (ver abajo) | ||||
Configuración avanzada
Los siguientes parámetros de configuración avanzada son compatibles con el widget Elementos principales.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Ordenación de equipos | ||||
| Ordenar por | 0 | host_ordering_order_by | 0 - (por defecto) Nombre del equipo; 3 - Valor del elemento. |
|
| Patrones de elementos | 1 | host_ordering_item.0 | Nombre o patrón del Elemento (por ejemplo, "*: Número de valores procesados por segundo"). Nota: Para configurar varios patrones de elementos, cree un objeto de campo de widget de panel para cada patrón de elemento con un número incrementado en el nombre de la propiedad. 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 Ordenar por está establecido en "Valor del elemento" |
|
| Orden | 0 | host_ordering_order | 2 - (por defecto) Top N; 3 - Bottom N. |
|
| Límite | 0 | host_ordering_limit | Los valores posibles van de 1 a 100. Por defecto: 10. |
|
| Ordenación de elementos | ||||
| Ordenar por | 0 | item_ordering_order_by | 1 - Equipo; 2 - Nombre del elemento; 3 - (por defecto) Valor del elemento. |
|
| Patrones de equipos | 1 | item_ordering_host.0 | Nombre o patrón del Equipo. Nota: Para configurar varios patrones de equipos, cree un objeto de campo de widget de panel para cada patrón de equipo con un número incrementado en el nombre de la propiedad. Comportamiento del parámetro: - obligatorio si Ordenar por está establecido en "Equipo" |
|
| Orden | 0 | item_ordering_order | 2 - (por defecto) Top N; 3 - Bottom N. |
|
| Límite | 0 | item_ordering_limit | Los valores posibles van de 1 a 100. Por defecto: 10. |
|
Columnas
El primer número en el nombre de la propiedad (por ejemplo, columns.0.items.0, columns.0.item_tags_evaltype) representa la columna en particular, mientras que el segundo número, si está presente, representa la entidad configurada (por ejemplo, patrón de item, etiqueta).
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Patrones de item | 1 | columns.0.items.0 | Nombre o patrón del item (por ejemplo, "*: Número de valores procesados por segundo"). Nota: Para configurar varios patrones de item, cree un objeto de campo de widget de dashboard para cada patrón de item con un número secundario incrementado en el nombre de la propiedad. Al configurar el widget en un dashboard de template, solo deben establecerse los patrones para los items configurados en el template. Comportamiento del parámetro: - obligatorio |
|
| Etiquetas de item | ||||
| Tipo de evaluación | 0 | columns.0.item_tags_evaltype | 0 - (por defecto) Y/O; 2 - O. |
|
| Nombre de etiqueta | 1 | columns.0.item_tags.0.tag | Cualquier valor de cadena. Nota: El segundo número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Etiquetas de item |
|
| Operador | 0 | columns.0.item_tags.0.operator | 0 - Contiene; 1 - Igual; 2 - No contiene; 3 - No igual; 4 - Existe; 5 - No existe. Nota: El segundo número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Etiquetas de item |
|
| Valor de etiqueta | 1 | columns.0.item_tags.0.value | Cualquier valor de cadena. Nota: El segundo número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Etiquetas de item |
|
| Color base | 1 | columns.0.base_color | Código de color hexadecimal (por ejemplo, FF0000). |
|
| Mostrar valor como | 0 | columns.0.display_value_as | 1 - (por defecto) Numérico; 2 - Texto. |
|
| Mostrar | 0 | columns.0.display | 1 - (por defecto) Tal cual; 2 - Barra; 3 - Indicadores; 6 - Minigráfica. |
|
| Mín | 1 | columns.0.min | Cualquier valor numérico. Se admiten sufijos (por ejemplo, "1d", "2w", "4K", "8G"). Comportamiento del parámetro: - admitido si Mostrar valor como está configurado como "Numérico" y Mostrar está configurado como "Barra" o "Indicadores" |
|
| Máx | 1 | columns.0.max | Cualquier valor numérico. Se admiten sufijos (por ejemplo, "1d", "2w", "4K", "8G"). Comportamiento del parámetro: - admitido si Mostrar valor como está configurado como "Numérico" y Mostrar está configurado como "Barra" o "Indicadores" |
|
| Minigráfica | ||||
| Ancho | 0 | columns.0.sparkline.width | Los valores posibles van de 0 a 10. Por defecto: 1. Comportamiento del parámetro: - admitido si Mostrar está configurado como "Minigráfica" |
|
| Relleno | 0 | columns.0.sparkline.fill | Los valores posibles van de 0 a 10. Por defecto: 3. Comportamiento del parámetro: - admitido si Mostrar está configurado como "Minigráfica" |
|
| Color | 1 | columns.0.sparkline.color | Código de color hexadecimal (por ejemplo, FF0000).Por defecto: 42A5F5.Comportamiento del parámetro: - admitido si Mostrar está configurado como "Minigráfica" |
|
| Periodo de tiempo | 1 | columns.0.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. Comportamiento del parámetro: - admitido si Mostrar está configurado como "Minigráfica" |
|
| Desde | 1 | columns.0.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.).Comportamiento del parámetro: - admitido si Mostrar está configurado como "Minigráfica" - obligatorio si se establece columns.0.sparkline.time_period.to |
|
| Hasta | 1 | columns.0.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.).Comportamiento del parámetro: - admitido si Mostrar está configurado como "Minigráfica" - obligatorio si se establece columns.0.sparkline.time_period.from |
|
| Datos históricos | 0 | columns.0.sparkline.history | 0 - (por defecto) Auto; 1 - Historial; 2 - Tendencias. Comportamiento del parámetro: - admitido si Mostrar está configurado como "Minigráfica" |
|
| Umbrales | ||||
| Color | 1 | columns.0.thresholds.0.color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - admitido si Mostrar valor como está configurado como "Numérico" |
|
| Umbral | 1 | columns.0.thresholds.0.threshold | Cualquier valor numérico. Se admiten sufijos (por ejemplo, "1d", "2w", "4K", "8G"). Comportamiento del parámetro: - admitido si Mostrar valor como está configurado como "Numérico" |
|
| Resaltados | ||||
| Resaltado | 1 | columns.0.highlights.0.color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - admitido si Mostrar valor como está configurado como "Texto" |
|
| Umbral | 1 | columns.0.highlights.0.pattern | Cualquier expresión regular. Comportamiento del parámetro: - admitido si Mostrar valor como está configurado como "Texto" |
|
| Decimales | 0 | columns.0.decimal_places | Los valores posibles van de 0 a 10. Por defecto: 2. |
|
| Configuración avanzada | ||||
| Función de agregación | 0 | columns.0.aggregate_function | Si Mostrar valor como está configurado como "Numérico": 0 - (por defecto) no se usa; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. Si Mostrar valor como está configurado como "Texto": 0 - (por defecto) no se usa; 4 - count; 6 - first; 7 - last. |
|
| Periodo de tiempo | 1 | columns.0.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. Comportamiento del parámetro: - admitido si Función de agregación está configurada como "min", "max", "avg", "count", "sum", "first", "last" |
|
| Desde | 1 | columns.0.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 y Función de agregación está configurada como "min", "max", "avg", "count", "sum", "first", "last" - obligatorio si se establece columns.0.time_period.to |
|
| Hasta | 1 | columns.0.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 y Función de agregación está configurada como "min", "max", "avg", "count", "sum", "first", "last" - obligatorio si se establece columns.0.time_period.from |
|
| Datos históricos | 0 | columns.0.history | 0 - (por defecto) Auto; 1 - Historial; 2 - Tendencias. Comportamiento del parámetro: - admitido si Mostrar valor como está configurado como "Numérico" |
|
Ejemplos
Los siguientes ejemplos describen únicamente la configuración de los objetos de campo del widget del tablero para el widget Métricas principales. Para obtener más información sobre la configuración de un tablero, consulte dashboard.create.
Configuración de un widget de Elementos principales
Configure un widget de Elementos principales que muestre datos para el equipo "10084" y solo para los elementos cuyo valor de la etiqueta con el nombre "component" contenga el valor "cpu". Además, muestre los datos con los equipos ubicados en la parte superior y utilice una barra de indicador de color para la representación de la celda.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "Mi panel",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Elementos principales",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Respuesta: