Estos parámetros y los posibles valores de propiedad para los respectivos objetos de campo de widget de panel permiten configurar el widget Historial de métrica 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 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 a continuación.
Los siguientes parámetros son compatibles con el widget Historial de métricas.
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. |
Disposición | 0 | layout | 0 - (por defecto) Horizontal; 1 - Vertical. |
Columnas (ver abajo) | |||
Mostrar líneas | 0 | show_lines | Los valores posibles van de 1 a 100. Por defecto: 25. |
Sobrescribir equipo | 1 | override_hostid._reference | ABCDE._hostid - establecer un widget compatible (con su parámetro Referencia configurado en "ABCDE ") como fuente de datos para los equipos;DASHBOARD._hostid - establecer el selector de Equipo del dashboard como fuente de datos para los equipos.Este parámetro no es compatible si se configura el widget en un dashboard de plantilla. |
Configuración avanzada (ver abajo) | |||
Referencia | 1 | reference | Cualquier valor de cadena que consista en 5 caracteres (por ejemplo, ABCDE o JBPNL ). Este valor debe ser único dentro del dashboard al que pertenece el widget.Comportamiento del parámetro: - obligatorio |
Las columnas tienen parámetros comunes y parámetros adicionales dependiendo de la configuración del parámetro Métrica.
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 se configura 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 la métrica. Al configurar el widget en un panel de plantilla, solo deben establecerse las métricas configuradas en la plantilla. Comportamiento del parámetro: - obligatorio |
Color base | 1 | columns.0.base_color | Código de color hexadecimal (por ejemplo, FF0000 ).Por defecto: "" (vacío). |
Se admiten los siguientes parámetros de columna si la Métrica configurada es una métrica de tipo numérico.
Parámetro | tipo | nombre | valor | |
---|---|---|---|---|
Mostrar | 0 | columns.0.display | 1 - (por defecto) Como está; 2 - Barra; 3 - Indicadores. |
|
Mín | 1 | columns.0.min | Cualquier valor numérico. Comportamiento del parámetro: - admitido si Mostrar está configurado como "Barra" o "Indicadores" |
|
Máx | 1 | columns.0.max | Cualquier valor numérico. Comportamiento del parámetro: - admitido si Mostrar está configurado como "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 históricos | 0 | columns.0.history | 0 - (por defecto) Automático; 1 - Historial; 2 - Tendencias. |
Se admiten los siguientes parámetros de columna si la Métrica configurada es de tipo carácter, texto o log.
Parámetro | tipo | nombre | valor | |
---|---|---|---|---|
Resaltados | ||||
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. | |
Visualización | 0 | columns.0.display | 1 - (por defecto) Tal cual; 4 - HTML; 5 - Línea única. |
|
Línea única | 0 | columns.0.max_length | Los valores posibles van de 1-500. Por defecto: 100. Comportamiento del parámetro: - admitido si Visualización está configurado como "Línea única" |
|
Usar fuente monoespaciada | 0 | columns.0.monospace_font | 0 - (por defecto) Usar fuente por defecto; 1 - Usar fuente monoespaciada. |
|
Mostrar hora local | 0 | columns.0.local_time | 0 - (por defecto) Mostrar marca de tiempo; 1 - Mostrar hora local. Comportamiento del parámetro: - admitido si Métrica está configurada como tipo log, y Mostrar marca de tiempo está configurado como "Habilitado" |
Se admiten los siguientes parámetros de columna si la Métrica configurada es de tipo binario.
Parámetro | tipo | nombre | valor |
---|---|---|---|
Mostrar miniatura | 1 | columns.0.show_thumbnail | 0 - (por defecto) Deshabilitado; 1 - Habilitado. |
Los siguientes parámetros de configuración avanzada son compatibles con el widget Historial de métricas.
Parámetro | tipo | nombre | valor | |
---|---|---|---|---|
Nuevos valores | 0 | sortorder | 0 - (por defecto) Arriba; 1 - Abajo. |
|
Mostrar marca de tiempo | 0 | show_timestamp | 0 - (por defecto) Deshabilitado; 1 - Habilitado. |
|
Mostrar encabezado de columna | 0 | show_column_header | 0 - Apagado; 1 - Horizontal; 2 - (por defecto) Vertical. |
|
Periodo de tiempo | 1 | time_period._reference | DASHBOARD._timeperiod - establecer el selector de Periodo de tiempo como fuente de datos;ABCDE._timeperiod - establecer un widget compatible (con su parámetro Referencia configurado en "ABCDE ") como fuente de datos.Por defecto: DASHBOARD._timeperiod Alternativamente, puede establecer el periodo de tiempo solo en los parámetros Desde y Hasta. |
|
Desde | 1 | 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: - soportado si Periodo de tiempo no está establecido |
|
Hasta | 1 | 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: - soportado si Periodo de tiempo no está establecido |
Los siguientes ejemplos tienen como objetivo describir únicamente la configuración de los objetos de campo del widget de panel para el widget Histórico de métricas. Para obtener más información sobre la configuración de un panel, consulte dashboard.create
.
Configure un widget Historial de métricas que muestre los últimos datos de dos métricas numéricas "42269" y "42270". Además, configure las columnas de métricas para que se muestren verticalmente, con los nombres de las columnas mostrados horizontalmente; limite la visualización a 15 líneas de datos e incluya una columna de marca de tiempo por separado.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "Mi panel",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemhistory",
"name": "Historial de métricas",
"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": "Utilización de CPU"
},
{
"type": "4",
"name": "columns.0.itemid",
"value": "42269"
},
{
"type": "1",
"name": "columns.1.name",
"value": "Utilización de memoria"
},
{
"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: