Documentation
Table of Contents
15 Historial de métrica
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 Historial de métrica 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 Historial de métrica, consulte el comportamiento de los parámetros descrito en las tablas siguientes.
Parámetros
Los siguientes parámetros son compatibles con el widget Historial de métrica.
| 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. |
| Diseño | 0 | layout | 0 - (predeterminado) Horizontal; 1 - Vertical. |
| Columnas (ver abajo) | |||
| Mostrar líneas | 0 | show_lines | Los valores posibles oscilan entre 1 y 100. Predeterminado: 25. |
| Reemplazar equipo | 1 | override_hostid._reference | ABCDE._hostid - establece un widget compatible (con su parámetro Reference establecido en "ABCDE") como fuente de datos para los equipos;DASHBOARD._hostid - establece el tablero selector de equipo como fuente de datos para los equipos.Este parámetro no se admite si se configura el widget en un tablero de una plantilla. |
| Configuración avanzada (ver abajo) | |||
| Referencia | 1 | referencia | 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 |
Columnas
Las columnas tienen parámetros comunes y parámetros adicionales según la configuración del parámetro Item.
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 está configurado el parámetro.
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 |
| Métrica | 4 | columns.0.itemid | ID de métrica. Al configurar el widget en una plantilla de tablero, solo se deben configurar las métricas configuradas en la plantilla. Comportamiento de parámetros: - obligatorio |
| Color base | 1 | columns.0.base_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: "" (vacío). |
Los siguientes parámetros de columna son compatibles si el Item configurado es una métrica de tipo numérico.
|Parámetro|<|tipo|nombre|valor| |-|--------|--|--------|-------------------------- -----| |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"| |Umbrales|<|<|<|<| |<|Color|1|columns.0.thresholds.0.color|Código de color hexadecimal (por ejemplo, FF0000).| |^|Umbral|1|columns.0.thresholds.0.threshold|Cualquier valor numérico. Se admiten Sufijos (por ejemplo, "1d", "2w", "4K", "8G").| |Datos del historial|<|0|columns.0.history|0 - (predeterminado) Automático;
1 - Historial;
2 - Tendencias.|
Los siguientes parámetros de columna son compatibles si la Métrica configurada es una métrica de tipo carácter, texto o registro.
|Parámetro|<|tipo|nombre|valor| |-|--------|--|--------|-------------------------- -----| |Destacados|<|<|<|<| |<|Resaltado|1|columns.0.highlights.0.color|Código de color hexadecimal (por ejemplo, FF0000).| |^|Umbral|1|columns.0.highlights.0.pattern|Cualquier expresión regular.| |Pantalla|<|0|columns.0.display|1 - (predeterminado) Tal cual;
4 - HTML;
5 - Una sola línea.| |<|Una sola línea|0|columns.0.max_length|Los valores posibles oscilan entre 1 y 500.
Predeterminado: 100.
Comportamiento del parámetro:
- compatible si Pantalla está configurada en "Una sola línea"| |Usar fuente monoespaciada|<|0|columns.0.monospace_font|0 - (predeterminado) Usar fuente predeterminada;
1 - Usar fuente monoespaciada.| |Mostrar hora local|<|0|columns.0.local_time|0 - (predeterminado) Mostrar marca de tiempo;
1 - Mostrar hora local.
Comportamiento de parámetros:
- compatible si Item está configurado como métrica de tipo de registro y Mostrar marca de tiempo está configurado como "Habilitado"|
Los siguientes parámetros de columna son compatibles si el Item configurado es una métrica de tipo binario.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Mostrar miniatura | 1 | columns.0.show_thumbnail | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
Configuración avanzada
Los siguientes parámetros de configuración avanzada son compatibles con el widget Historial de métrica.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Nuevos valores | 0 | sortorder | 0 - (predeterminado) Arriba; 1 - Abajo. |
|
| Mostrar marca de tiempo | 0 | show_timestamp | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
|
| Mostrar encabezado de columna | 0 | show_column_header | 0 - Desactivado; 1 - Horizontal; 2 - (predeterminado) Vertical. |
|
| 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 Reference establecido en "ABCDE") como fuente de datos.Valor predeterminado: 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 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 |
|
| Hasta | 1 | 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 |
|
Ejemplos
Los siguientes ejemplos pretenden describir únicamente la configuración de los objetos de campo del widget del tablero para el widget Historial de métrica. Para obtener más información sobre cómo configurar un tablero, consulte dashboard.create.
Configuración de un widget Historial de métrica
Configure un widget Historial de métrica que muestre los datos más recientes para dos métricas numéricas "42269" y "42270". Además, configure las columnas de las métricas para que se muestren verticalmente y los nombres de las columnas se muestren horizontalmente; limite la visualización a 15 líneas de datos e incluya una columna de marca de tiempo separada.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemhistory",
"name": "Item history",
"x": "0",
"y": "0",
"width": "18",
"height": "6",
"view_mode": "0",
"fields": [
{
"type": "0",
"name": "layout",
"value": "1"
},
{
"type": "1",
"name": "columns.0.name",
"value": "CPU utilization"
},
{
"type": "4",
"name": "columns.0.itemid",
"value": "42269"
},
{
"type": "1",
"name": "columns.1.name",
"value": "Memory utilization"
},
{
"type": "4",
"name": "columns.1.itemid",
"value": "42270"
},
{
"type": "0",
"name": "show_lines",
"value": "15"
},
{
"type": "0",
"name": "show_timestamp",
"value": "1"
},
{
"type": "0",
"name": "show_column_header",
"value": "1"
},
{
"type": "1",
"name": "reference",
"value": "KIVKD"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Respuesta: