Nesta página
11 Honeycomb
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 Honeycomb 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 Honeycomb, consulte o comportamento dos parâmetros descrito nas tabelas abaixo.
Parâmetros
Os seguintes parâmetros são suportados para o widget Honeycomb.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 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. |
|
| Host groups | 2 | groupids.0 | ID do Host group. Nota: Para configurar vários host groups, crie um objeto de campo do widget do dashboard para cada host group com um número incrementado no nome da propriedade. Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Host groups (Widget) | 1 | groupids._reference | Em vez do ID do Host group:ABCDE._hostgroupids - defina um widget compatível (com seu parâmetro Reference definido como "ABCDE") como a fonte de dados para host groups.Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Hosts | 3 | hostids.0 | ID do Host. Nota: Para configurar vários hosts, crie um objeto de campo do widget do dashboard para cada host com um número incrementado no nome da propriedade. Para vários hosts, o parâmetro Host groups deve não estar configurado ou deve estar configurado com pelo menos um host group ao qual os hosts configurados pertençam. Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Em vez do ID do Host:DASHBOARD.hostids - defina o seletor Host como a fonte de dados para hosts;ABCDE._hostids - defina um widget compatível (com seu parâmetro Reference definido como "ABCDE") como a fonte de dados para hosts.Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Host tags | ||||
| Evaluation type | 0 | evaltype_host | 0 - (padrão) And/Or; 2 - Or. Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Tag name | 1 | host_tags.0.tag | Qualquer valor de string. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Host tags Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Operator | 0 | host_tags.0.operator | 0 - Contém; 1 - Igual a; 2 - Não contém; 3 - Não é igual a; 4 - Existe; 5 - Não existe. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Host tags Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Tag value | 1 | host_tags.0.value | Qualquer valor de string. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Host tags Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Item patterns | 1 | items.0 | Nome ou padrão do Item. Nota: Para configurar vários padrões de item, crie um objeto de campo do widget do dashboard para cada padrão de item com um número incrementado no nome da propriedade. Comportamento do parâmetro: - obrigatório |
|
| Item tags | ||||
| Evaluation type | 0 | evaltype_item | 0 - (padrão) And/Or; 2 - Or. |
|
| Tag name | 1 | item_tags.0.tag | Qualquer valor de string. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Item tags |
|
| Operator | 0 | item_tags.0.operator | 0 - Contém; 1 - Igual a; 2 - Não contém; 3 - Não é igual a; 4 - Existe; 5 - Não existe. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Item tags |
|
| Tag value | 1 | item_tags.0.value | Qualquer valor de string. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Item tags |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (padrão) Desativado; 1 - Ativado. |
|
| Show | 0 | show.0 | 1 - Rótulo primário; 2 - Rótulo secundário. Nota: Para configurar vários valores, crie um objeto de campo do widget do dashboard para cada valor com um número incrementado no nome da propriedade. Padrão: 1, 2. |
|
| Reference | 1 | reference | Qualquer valor de string com 5 caracteres (por exemplo, ABCDE ou JBPNL). Esse valor deve ser exclusivo dentro do dashboard ao qual o widget pertence.Comportamento do parâmetro: - obrigatório |
|
Configuração avançada
Os seguintes parâmetros de configuração avançada são suportados para o widget Honeycomb.
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 |
|---|---|---|---|
| Primary label | |||
| Type | 0 | primary_label_type | 0 - (padrão) Texto; 1 - Valor. |
| Text | 1 | primary_label | Qualquer valor de string, incluindo macros. Macros suportadas: {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros de usuário. Padrão: {HOST.NAME} Comportamento do parâmetro: - suportado se Type estiver definido como "Text" |
| Decimal places | 0 | primary_label_decimal_places | Os valores possíveis variam de 0 a 6. Padrão: 2. Comportamento do parâmetro: - suportado se Type estiver definido como "Value" |
| Size (type) | 0 | primary_label_size_type | 0 - (padrão) Automático; 1 - Personalizado. |
| Size | 0 | primary_label_size | Os valores possíveis variam de 1 a 100. Padrão: 20. Comportamento do parâmetro: - suportado se Size (type) estiver definido como "Custom" |
| Bold | 0 | primary_label_bold | 0 - (padrão) Desativado; 1 - Ativado. |
| Color | 1 | primary_label_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: com base no theme do Settings object e do User object:1F2C33 para "blue-theme" ou "hc-light";EEEEEE para "dark-theme" ou "hc-dark". |
| Units (checkbox) | 0 | primary_label_units_show | 0 - Desativado; 1 - (padrão) Ativado. Comportamento do parâmetro: - suportado se Type estiver definido como "Value" |
| Units (value) | 1 | primary_label_units | Qualquer valor de string."" (vazio)Comportamento do parâmetro: - suportado se Type estiver definido como "Value" e Units (checkbox) estiver definido como "Enabled" |
| Position | 0 | primary_label_units_pos | 0 - Antes do valor; 1 - (padrão) Depois do valor. Comportamento do parâmetro: - suportado se Type estiver definido como "Value" e Units (checkbox) estiver definido como "Enabled" Este parâmetro é ignorado se definido como uma das seguintes unidades relacionadas a tempo: unixtime, uptime, s. |
| Secondary label | |||
| Type | 0 | secondary_label_type | 0 - Texto; 1 - (padrão) Valor. |
| Text | 1 | secondary_label | Qualquer valor de string, incluindo macros. Macros suportadas: {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros de usuário. Padrão: {{ITEM.LASTVALUE}.fmtnum(2)} Comportamento do parâmetro: - suportado se Type estiver definido como "Text" |
| Decimal places | 0 | secondary_label_decimal_places | Os valores possíveis variam de 0 a 6. Padrão: 2. Comportamento do parâmetro: - suportado se Type estiver definido como "Value" |
| Size (type) | 0 | secondary_label_size_type | 0 - (padrão) Automático; 1 - Personalizado. |
| Size | 0 | secondary_label_size | Os valores possíveis variam de 1 a 100. Padrão: 30. Comportamento do parâmetro: - suportado se Size (type) estiver definido como "Custom" |
| Bold | 0 | secondary_label_bold | 0 - Desativado; 1 - (padrão) Ativado. |
| Color | 1 | secondary_label_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: com base no theme do Settings object e do User object:1F2C33 para "blue-theme" ou "hc-light";EEEEEE para "dark-theme" ou "hc-dark". |
| Units (checkbox) | 0 | secondary_label_units_show | 0 - Desativado; 1 - (padrão) Ativado. Comportamento do parâmetro: - suportado se Type estiver definido como "Value" |
| Units (value) | 1 | secondary_label_units | Qualquer valor de string."" (vazio)Comportamento do parâmetro: - suportado se Type estiver definido como "Value" e Units (checkbox) estiver definido como "Enabled" |
| Position | 0 | secondary_label_position | 0 - Antes do valor; 1 - (padrão) Depois do valor. Comportamento do parâmetro: - suportado se Type estiver definido como "Value" e Units (checkbox) estiver definido como "Enabled" Este parâmetro é ignorado se definido como uma das seguintes unidades relacionadas a tempo: unixtime, uptime, s. |
| Background color | |||
| Background color | 1 | bg_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: com base no theme do Settings object e do User object:D9E7ED para "blue-theme";3D5059 para "dark-theme";AAD7E9 para "hc-light";335463 para "hc-dark". |
| Thresholds | |||
| Color interpolation | 0 | interpolation | 0 - Desativado; 1 - (padrão) Ativado. |
| 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. |
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 Honeycomb.
Para obter mais informações sobre como configurar um painel, consulte dashboard.create.
Configurando um widget Honeycomb
Configure um widget Honeycomb que exibe a utilização dos processos do Zabbix server. Além disso, altere o rótulo primário das células do honeycomb e ajuste visualmente o widget com limites.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "honeycomb",
"name": "Honeycomb",
"x": "0",
"y": "0",
"width": "24",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "items.0",
"value": "Zabbix server: Utilization*"
},
{
"type": 1,
"name": "primary_label",
"value": "{ITEM.NAME}"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "70"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "90"
},
{
"type": 1,
"name": "reference",
"value": "KSTMQ"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}