15 Tarjeta de métrica

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 Tarjeta 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 Tarjeta de métrica, consulte el comportamiento de los parámetros descrito en las tablas a continuación.

Parámetros

Los siguientes parámetros son compatibles con el widget Item card.

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.
Item 4 itemid.0 ID de Item.

Comportamiento del parámetro:
- obligatorio si Item (Widget) no está configurado
Item (Widget) 1 itemid._reference En lugar del ID de Item:
ABCDE._itemid - configure un widget compatible (con su parámetro Reference establecido en "ABCDE") como fuente de datos para item.

Comportamiento del parámetro:
- obligatorio si Item no está configurado
Show 0 sections.0 0 - Descripción;
1 - Texto de error;
2 - Métricas;
3 - Datos más recientes;
4 - Tipo de información;
5 - Triggers;
6 - Interfaz del host;
7 - Tipo;
8 - Inventario del host;
9 - Etiquetas.

Nota: El número en el nombre de la propiedad hace referencia al orden de la sección en la lista de secciones. Para configurar varias secciones, cree un objeto de campo del widget del dashboard para cada sección con un número incrementado en el nombre de la propiedad.
Override host 1 override_hostid._reference ABCDE._hostid - configure un widget compatible (con su parámetro Reference establecido en "ABCDE") como fuente de datos para hosts;
DASHBOARD._hostid - configure el selector Host del dashboard como fuente de datos para hosts.

Predeterminado: "" (vacío)

Este parámetro no es compatible si se configura el widget en un template dashboard.

Sparkline

Los siguientes parámetros son compatibles si Show está establecido en "Latest data".

Parameter type name value
Width 0 sparkline.width Los valores posibles van de 0 a 10.

Predeterminado: 1.
Fill 0 sparkline.fill Los valores posibles van de 0 a 10.

Predeterminado: 3.
Color 1 sparkline.color Código de color hexadecimal (por ejemplo, FF0000).

Predeterminado: 42A5F5.
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - establece el selector Time period como fuente de datos;
ABCDE._timeperiod - establece un widget compatible (con su parámetro reference igual a ABCDE) como fuente de datos.

Predeterminado: "" (vacío)

Como alternativa, puede establecer el período de tiempo solo en los parámetros From y To.
From 1 sparkline.time_period.from Cadena de tiempo válida en sintaxis de tiempo absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).

Predeterminado: now-1h.

Comportamiento del parámetro:
- supported si Time period no está establecido
- required si sparkline.time_period.to está establecido
To 1 sparkline.time_period.to Cadena de tiempo válida en sintaxis de tiempo absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).

Predeterminado: now.

Comportamiento del parámetro:
- supported si Time period no está establecido
- required si time_period.from está establecido
History data 0 sparkline.history 0 - (predeterminado) Auto;
1 - History;
2 - Trends.

Ejemplos

Los siguientes ejemplos tienen como objetivo describir únicamente la configuración de los objetos de campo del widget de panel para el widget Tarjeta de métrica. Para obtener más información sobre la configuración de un panel, consulte dashboard.create.

Configuración de un widget Tarjeta de métrica

Configure un widget Tarjeta de métrica que muestre estas secciones: "Descripción", "Últimos datos", "Disparadores" y "Etiquetas".

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "Mi panel",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemcard",
                        "name": "Tarjeta de métrica",
                        "x": 0,
                        "y": 0,
                        "width": 14,
                        "height": 7,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 42257
                            },
                            {
                                "type": 0,
                                "name": "sections.0",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "sections.1",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "sections.2",
                                "value": 5
                            },
                            {
                                "type": 0,
                                "name": "sections.3",
                                "value": 9
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Respuesta:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Véase también