Nesta página
6 Gauge
Descrição
Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget do dashboard permitem configurar o widget Gauge nos métodos dashboard.create e dashboard.update.
As propriedades fields do widget não são validadas durante a criação ou atualização de um dashboard.
Isso permite que os usuários modifiquem widgets internos e criem widgets personalizados, mas também introduz o risco de criar ou atualizar widgets incorretamente.
Para garantir a criação ou atualização bem-sucedida do widget Gauge, consulte o comportamento dos parâmetros descritos nas tabelas abaixo.
Parâmetros
Os seguintes parâmetros são suportados para o widget Gauge.
| Parâmetro | tipo | nome | valor | |
|---|---|---|---|---|
| Intervalo de atualização | 0 | rf_rate | 0 - Sem atualização; 10 - 10 segundos; 30 - 30 segundos; 60 - (padrão) 1 minuto; 120 - 2 minutos; 600 - 10 minutos; 900 - 15 minutos. |
|
| Item | 4 | itemid.0 | ID do Item. Comportamento do parâmetro: - obrigatório se Item (Widget) não estiver definido |
|
| Item (Widget) | 1 | itemid._reference | Em vez do ID do Item:ABCDE._itemid - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como fonte de dados para os items.Comportamento do parâmetro: - obrigatório se Item não estiver definido |
|
| Mín | 1 | min | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são suportados. Padrão: "0". |
|
| Máx | 1 | max | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são suportados. Padrão: "100". |
|
| Arco de valor | 1 | value_arc_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio). |
|
| Fundo do arco | 1 | empty_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio). |
|
| Fundo | 1 | bg_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio). |
|
| Exibir | 0 | show.0 | 1 - Descrição; 2 - Valor; 3 - Ponteiro; 4 - Escala; 5 - Arco de valor. Nota: Para configurar múltiplos valores, crie um objeto de campo de widget de dashboard para cada valor com um número incrementado no nome da propriedade. Padrão: 1, 2, 4, 5. Os valores "Ponteiro" e "Escala" não são suportados se ambos: - nenhum objeto de campo de widget de dashboard para Exibir com o valor "Arco de valor" estiver definido; - o parâmetro de configuração avançada Exibir arco estiver definido como "Desabilitado". Os parâmetros de configuração avançada para opções de Exibir não são suportados se nenhum objeto de campo de widget de dashboard com os respectivos valores estiver definido. |
|
| Substituir host | 1 | override_hostid._reference | ABCDE._hostid - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como fonte de dados para hosts;DASHBOARD._hostid - defina o seletor de host do dashboard como fonte de dados para hosts.Este parâmetro não é suportado se estiver configurando o widget em um dashboard de template. |
|
Configuração avançada
Os seguintes parâmetros de configuração avançada são suportados para o widget Gauge.
O número no nome da propriedade Thresholds (por exemplo, thresholds.0.color) faz referência à posição do threshold em uma lista, classificada em ordem crescente.
No entanto, se os thresholds forem configurados em uma ordem diferente, os valores serão classificados em ordem crescente após a atualização da configuração do widget no frontend do Zabbix
(por exemplo, "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5").
| Parameter | type | name | value |
|---|---|---|---|
| Angle | 0 | angle | Valores possíveis: 180 (padrão) ou 270. |
| Description | |||
| Description | 1 | description | Qualquer valor de string, incluindo macros. Macros suportadas: {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros de usuário.Padrão: {ITEM.NAME}. |
| Size | 0 | desc_size | Intervalo de valores possíveis: 1-100. Padrão: 15. |
| Vertical position | 0 | desc_v_pos | 0 - Topo; 1 - (padrão) Inferior. |
| Bold | 0 | desc_bold | 0 - (padrão) Desativado; 1 - Ativado. |
| Color | 1 | desc_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio). |
| Value | |||
| Decimal places | 0 | decimal_places | Intervalo de valores possíveis: 1-10. Padrão: 2. |
| Size | 0 | value_size | Intervalo de valores possíveis: 1-100. Padrão: 25. |
| Bold | 0 | value_bold | 0 - (padrão) Desativado; 1 - Ativado. |
| Color | 1 | value_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio). |
| Units | |||
| Units (checkbox) | 0 | units_show | 0 - Desativado; 1 - (padrão) Ativado. |
| Units (value) | 1 | units | Qualquer valor de string. Comportamento do parâmetro: - supported se Units (checkbox) estiver definido como "Enabled" |
| Size | 0 | units_size | Intervalo de valores possíveis: 1-100. Padrão: 25. Comportamento do parâmetro: - supported se Units (checkbox) estiver definido como "Enabled" |
| Bold | 0 | units_bold | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - supported se Units (checkbox) estiver definido como "Enabled" |
| Position | 0 | units_pos | 0 - Antes do valor; 1 - Acima do valor; 2 - (padrão) Depois do valor; 3 - Abaixo do valor. Comportamento do parâmetro: - supported se Units (checkbox) estiver definido como "Enabled" Este parâmetro é ignorado se definido como uma das seguintes unidades relacionadas a tempo: unixtime, uptime, s. |
| Color | 1 | units_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio). |
| Value arc | |||
| Arc size | 0 | value_arc_size | Intervalo de valores possíveis: 1-100. Padrão: 20. |
| Needle | |||
| Color | 1 | needle_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio).Comportamento do parâmetro: - supported se um objeto de campo do widget do dashboard para Show com o valor "Value arc" estiver definido, ou Show arc estiver definido como "Enabled" |
| Scale | |||
| Show units | 0 | scale_show_units | 0 - Desativado; 1 - (padrão) Ativado. Comportamento do parâmetro: - supported se Units (checkbox) estiver definido como "Enabled" e se um objeto de campo do widget do dashboard para Show com o valor "Value arc" estiver definido, ou Show arc estiver definido como "Enabled" |
| Size | 0 | scale_size | Intervalo de valores possíveis: 1-100. Padrão: 15. Comportamento do parâmetro: - supported se um objeto de campo do widget do dashboard para Show com o valor "Value arc" estiver definido, ou Show arc estiver definido como "Enabled" |
| Decimal places | 0 | scale_decimal_places | Intervalo de valores possíveis: 1-10. Padrão: 0. Comportamento do parâmetro: - supported se um objeto de campo do widget do dashboard para Show com o valor "Value arc" estiver definido, ou Show arc estiver definido como "Enabled" |
| Thresholds | |||
| Color | 1 | thresholds.0.color | Código de cor hexadecimal (por exemplo, FF0000). |
| Threshold | 1 | thresholds.0.threshold | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são suportados. |
| Show labels | 0 | th_show_labels | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - supported se Thresholds estiverem definidos e se um objeto de campo do widget do dashboard para Show com o valor "Value arc" estiver definido ou Show arc estiver definido como "Enabled" |
| Show arc | 0 | th_show_arc | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - supported se Thresholds estiverem definidos |
| Arc size | 0 | th_arc_size | Intervalo de valores possíveis: 1-100. Padrão: 5. Comportamento do parâmetro: - supported se Show arc estiver definido como "Enabled" |
Exemplos
Os exemplos a seguir têm como objetivo apenas descrever a configuração dos objetos de campo do widget do painel para o widget Gauge.
Para obter mais informações sobre como configurar um painel, consulte dashboard.create.
Configurando um widget Gauge
Configure um widget Gauge que exibe o valor do item para o item "44474" (Interface enp0s3: Bits enviados). Além disso, ajuste visualmente o widget com várias opções avançadas, incluindo limites.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "gauge",
"name": "Gauge",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 44474
},
{
"type": 1,
"name": "min",
"value": "100000"
},
{
"type": 1,
"name": "max",
"value": "1000000"
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 0,
"name": "show.4",
"value": 4
},
{
"type": 0,
"name": "show.5",
"value": 5
},
{
"type": 0,
"name": "angle",
"value": 270
},
{
"type": 0,
"name": "desc_size",
"value": 10
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 0,
"name": "decimal_places",
"value": 0
},
{
"type": 0,
"name": "value_bold",
"value": 1
},
{
"type": 0,
"name": "units_size",
"value": 15
},
{
"type": 0,
"name": "units_pos",
"value": 3
},
{
"type": 1,
"name": "needle_color",
"value": "3C3C3C"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "700000"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "500000"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "100000"
},
{
"type": 0,
"name": "th_show_labels",
"value": 1
},
{
"type": 0,
"name": "th_show_arc",
"value": 1
},
{
"type": 0,
"name": "th_arc_size",
"value": 15
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}