28 Principales items
Descripción
Estos parámetros y los posibles valores de propiedad para los respectivos objetos de campo del widget del dashboard permiten configurar
el widget Top items 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 widgets integrados y crear widgets personalizados, pero también introduce el riesgo de crear o actualizar widgets de forma incorrecta.
Para garantizar la correcta creación o actualización del widget Top items, consulte el comportamiento de los parámetros descrito en las tablas siguientes.
Parámetros
Los siguientes parámetros son compatibles con el widget Top items.
| 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. |
|
| Host groups | 2 | groupids.0 | ID de Host group. Nota: Para configurar varios host groups, cree un objeto de campo del widget del dashboard para cada host group con un número incrementado en el nombre de la propiedad. Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Host groups (Widget) | 1 | groupids._reference | En lugar del ID de Host group:ABCDE._hostgroupids - establezca un widget compatible (con su parámetro Reference establecido en "ABCDE") como fuente de datos para host groups.Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Hosts | 3 | hostids.0 | ID de Host. Nota: Para configurar varios hosts, cree un objeto de campo del widget del dashboard para cada host con un número incrementado en el nombre de la propiedad. Para varios hosts, el parámetro Host groups no debe estar configurado en absoluto o debe configurarse con al menos un host group al que pertenezcan los hosts configurados. Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | En lugar del ID de Host:DASHBOARD.hostids - establezca el selector Host como fuente de datos para hosts;ABCDE._hostids - establezca un widget compatible (con su parámetro Reference establecido en "ABCDE") como fuente de datos para hosts.Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Host tags | ||||
| Evaluation type | 0 | host_tags_evaltype | 0 - (predeterminado) And/Or; 2 - Or. Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Tag name | 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 tag en la lista de evaluación de tags. Comportamiento del parámetro: - obligatorio si se configuran Host tags Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Operator | 0 | host_tags.0.operator | 0 - Contiene; 1 - Igual a; 2 - No contiene; 3 - No es igual a; 4 - Existe; 5 - No existe. Nota: El número en el nombre de la propiedad hace referencia al orden de la tag en la lista de evaluación de tags. Comportamiento del parámetro: - obligatorio si se configuran Host tags Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Tag value | 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 tag en la lista de evaluación de tags. Comportamiento del parámetro: - obligatorio si se configuran Host tags Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Layout | 0 | layout | 0 - (predeterminado) Horizontal; 1 - Vertical. |
|
| Show problems | 0 | show_problems | 0 - Todos; 1 - (predeterminado) Sin suprimir; 2 - Ninguno. |
|
| Items (see below) | ||||
Configuración avanzada
Los siguientes parámetros de configuración avanzada son compatibles para el widget Principales métricas.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Orden de equipos | ||||
| Ordenar por | 0 | host_ordering_order_by | 0 - (por defecto) Nombre del equipo; 3 - Valor de la métrica. |
|
| Patrones de métricas | 1 | host_ordering_item.0 | Nombre o patrón de la métrica (por ejemplo, "*: Número de *valores procesados por segundo"). Nota: Para configurar múltiples patrones de métricas, cree un objeto de campo de widget de panel para cada patrón de métrica 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 las métricas configuradas en la plantilla. Comportamiento del parámetro: - obligatorio si Ordenar por está establecido en "Valor de la métrica" |
|
| 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-100. Por defecto: 10. |
|
| Orden de métricas | ||||
| Ordenar por | 0 | item_ordering_order_by | 1 - Equipo; 2 - Nombre de la métrica; 3 - (por defecto) Valor de la métrica. |
|
| Patrones de equipos | 1 | item_ordering_host.0 | Nombre o patrón del equipo. Nota: Para configurar múltiples 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-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 específica, mientras que el segundo número, si está presente, representa la entidad configurada (por ejemplo, patrón de item, etiqueta).
| Parameter | type | name | value | |
|---|---|---|---|---|
| Patrones de item | 1 | columns.0.items.0 | Nombre o patrón de item (por ejemplo, "*: Number of processed *values per second"). Nota: Para configurar varios patrones de item, cree un objeto de campo de widget de dashboard para cada patrón de item con un segundo número incrementado en el nombre de la propiedad. Al configurar el widget en un template dashboard, solo deben establecerse los patrones de los items configurados en el template. Comportamiento del parámetro: - required |
|
| Etiquetas de item | ||||
| Tipo de evaluación | 0 | columns.0.item_tags_evaltype | 0 - (default) 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: - required si se configuran Etiquetas de item |
|
| Operador | 0 | columns.0.item_tags.0.operator | 0 - Contiene; 1 - Igual a; 2 - No contiene; 3 - No es igual a; 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: - required 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: - required 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 - (default) Numérico; 2 - Texto. |
|
| Mostrar | 0 | columns.0.display | 1 - (default) Tal cual; 2 - Barra; 3 - Indicadores; 6 - Sparkline. |
|
| Mín | 1 | columns.0.min | Cualquier valor numérico. Se admiten sufijos (por ejemplo, "1d", "2w", "4K", "8G"). Comportamiento del parámetro: - supported si Mostrar valor como está establecido en "Numérico" y Mostrar está establecido en "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: - supported si Mostrar valor como está establecido en "Numérico" y Mostrar está establecido en "Barra" o "Indicadores" |
|
| Sparkline | ||||
| Ancho | 0 | columns.0.sparkline.width | Los valores posibles van de 0 a 10. Predeterminado: 1. Comportamiento del parámetro: - supported si Mostrar está establecido en "Sparkline" |
|
| Relleno | 0 | columns.0.sparkline.fill | Los valores posibles van de 0 a 10. Predeterminado: 3. Comportamiento del parámetro: - supported si Mostrar está establecido en "Sparkline" |
|
| Color | 1 | columns.0.sparkline.color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: 42A5F5.Comportamiento del parámetro: - supported si Mostrar está establecido en "Sparkline" |
|
| 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.Predeterminado: DASHBOARD._timeperiodAlternativamente, puede establecer el periodo de tiempo solo en los parámetros From y To. Comportamiento del parámetro: - supported si Mostrar está establecido en "Sparkline" |
|
| From | 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: - supported si Mostrar está establecido en "Sparkline" - required si columns.0.sparkline.time_period.to está establecido |
|
| To | 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: - supported si Mostrar está establecido en "Sparkline" - required si columns.0.sparkline.time_period.from está establecido |
|
| Datos históricos | 0 | columns.0.sparkline.history | 0 - (default) Automático; 1 - Historial; 2 - Tendencias. Comportamiento del parámetro: - supported si Mostrar está establecido en "Sparkline" |
|
| Umbrales | ||||
| Color | 1 | columns.0.thresholds.0.color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - supported si Mostrar valor como está establecido en "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: - supported si Mostrar valor como está establecido en "Numérico" |
|
| Resaltados | ||||
| Resaltado | 1 | columns.0.highlights.0.color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - supported si Mostrar valor como está establecido en "Texto" |
|
| Umbral | 1 | columns.0.highlights.0.pattern | Cualquier expresión regular. Comportamiento del parámetro: - supported si Mostrar valor como está establecido en "Texto" |
|
| Decimales | 0 | columns.0.decimal_places | Los valores posibles van de 0 a 10. Predeterminado: 2. |
|
| Configuración avanzada | ||||
| Función de agregación | 0 | columns.0.aggregate_function | Si Mostrar valor como está establecido en "Numérico": 0 - (default) no usado; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. Si Mostrar valor como está establecido en "Texto": 0 - (default) no usado; 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.Predeterminado: DASHBOARD._timeperiodAlternativamente, puede establecer el periodo de tiempo solo en los parámetros From y To. Comportamiento del parámetro: - supported si Función de agregación está establecido en "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 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: - supported si Periodo de tiempo no está establecido y Función de agregación está establecido en "min", "max", "avg", "count", "sum", "first", "last" - required si columns.0.time_period.to está establecido |
|
| To | 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: - supported si Periodo de tiempo no está establecido y Función de agregación está establecido en "min", "max", "avg", "count", "sum", "first", "last" - required si columns.0.time_period.from está establecido |
|
| Datos históricos | 0 | columns.0.history | 0 - (default) Automático; 1 - Historial; 2 - Tendencias. Comportamiento del parámetro: - supported si Mostrar valor como está establecido en "Numérico" |
|
Ejemplos
Los siguientes ejemplos tienen como objetivo describir únicamente la configuración de los objetos de campo del widget de panel para el widget Principales métricas.
Para obtener más información sobre la configuración de un panel, consulte dashboard.create.
Configuración de un widget Principales métricas
Configure un widget Principales métricas que muestre datos para el equipo "10084" y solo para las métricas para las cuales la etiqueta con el nombre "component" contiene 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": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"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:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}