Table of Contents
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.
| 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. |
|
| Grupos de hosts | 2 | groupids.0 | ID do Grupo de hosts. Nota: Para configurar múltiplos grupos de hosts, crie um objeto de campo de widget de dashboard para cada grupo de hosts com um número incrementado no nome da propriedade. Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Grupos de hosts (Widget) | 1 | groupids._reference | Em vez do ID do Grupo de hosts:ABCDE._hostgroupids - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como a fonte de dados para grupos de hosts.Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Hosts | 3 | hostids.0 | ID do Host. Nota: Para configurar múltiplos hosts, crie um objeto de campo de widget de dashboard para cada host com um número incrementado no nome da propriedade. Para múltiplos hosts, o parâmetro Grupos de hosts deve não estar configurado ou estar configurado com pelo menos um grupo de hosts ao qual os hosts configurados pertençam. Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Em vez do ID do Host:DASHBOARD.hostids - defina o seletor de host do dashboard como a fonte de dados para hosts;ABCDE._hostids - defina um widget compatível (com seu parâmetro Referência definido como "ABCDE") como a fonte de dados para hosts.Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Tags de host | ||||
| Tipo de avaliação | 0 | evaltype_host | 0 - (padrão) E/Ou; 2 - Ou. Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Nome da tag | 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 se estiver configurando Tags de host Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Operador | 0 | host_tags.0.operator | 0 - Contém; 1 - Igual a; 2 - Não contém; 3 - Diferente de; 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 se estiver configurando Tags de host Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Valor da tag | 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 se estiver configurando Tags de host Este parâmetro não é suportado se o widget estiver sendo configurado em um dashboard de template. |
|
| Padrões de item | 1 | items.0 | Nome ou padrão do Item. Nota: Para configurar múltiplos padrões de item, crie um objeto de campo de widget de dashboard para cada padrão de item com um número incrementado no nome da propriedade. Comportamento do parâmetro: - obrigatório |
|
| Tags de item | ||||
| Tipo de avaliação | 0 | evaltype_item | 0 - (padrão) E/Ou; 2 - Ou. |
|
| Nome da tag | 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 se estiver configurando Tags de item |
|
| Operador | 0 | item_tags.0.operator | 0 - Contém; 1 - Igual a; 2 - Não contém; 3 - Diferente de; 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 se estiver configurando Tags de item |
|
| Valor da tag | 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 se estiver configurando Tags de item |
|
| Exibir hosts em manutenção | 0 | maintenance | 0 - (padrão) Desabilitado; 1 - Habilitado. |
|
| Exibir | 0 | show.0 | 1 - Rótulo primário; 2 - Rótulo secundário. 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. |
|
| Referência | 1 | reference | Qualquer valor de string com 5 caracteres (por exemplo, ABCDE ou JBPNL). Este valor deve ser único 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 limiar em uma lista, ordenada em ordem crescente. No entanto, se os limiares forem configurados em uma ordem diferente, os valores serão ordenados 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").
| Parâmetro | tipo | nome | valor |
|---|---|---|---|
| Rótulo primário | |||
| Tipo | 0 | primary_label_type | 0 - (padrão) Texto; 1 - Valor. |
| Texto | 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 Tipo estiver definido como "Texto" |
| Casas decimais | 0 | primary_label_decimal_places | Os valores possíveis variam de 0-6. Padrão: 2. Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" |
| Tamanho (tipo) | 0 | primary_label_size_type | 0 - (padrão) Automático; 1 - Personalizado. |
| Tamanho | 0 | primary_label_size | Os valores possíveis variam de 1-100. Padrão: 20. Comportamento do parâmetro: - suportado se Tamanho (tipo) estiver definido como "Personalizado" |
| Negrito | 0 | primary_label_bold | 0 - (padrão) Desabilitado; 1 - Habilitado. |
| Cor | 1 | primary_label_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: baseado no theme do objeto Settings e do objeto User:1F2C33 para "blue-theme" ou "hc-light";EEEEEE para "dark-theme" ou "hc-dark". |
| Unidades (checkbox) | 0 | primary_label_units_show | 0 - Desabilitado; 1 - (padrão) Habilitado. Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" |
| Unidades (valor) | 1 | primary_label_units | Qualquer valor de string."" (vazio)Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" e Unidades (checkbox) estiver definido como "Habilitado" |
| Posição | 0 | primary_label_units_pos | 0 - Antes do valor; 1 - (padrão) Após o valor. Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" e Unidades (checkbox) estiver definido como "Habilitado" Este parâmetro é ignorado se definido como uma das seguintes unidades relacionadas ao tempo: unixtime, uptime, s. |
| Rótulo secundário | |||
| Tipo | 0 | secondary_label_type | 0 - Texto; 1 - (padrão) Valor. |
| Texto | 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 Tipo estiver definido como "Texto" |
| Casas decimais | 0 | secondary_label_decimal_places | Os valores possíveis variam de 0-6. Padrão: 2. Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" |
| Tamanho (tipo) | 0 | secondary_label_size_type | 0 - (padrão) Automático; 1 - Personalizado. |
| Tamanho | 0 | secondary_label_size | Os valores possíveis variam de 1-100. Padrão: 30. Comportamento do parâmetro: - suportado se Tamanho (tipo) estiver definido como "Personalizado" |
| Negrito | 0 | secondary_label_bold | 0 - Desabilitado; 1 - (padrão) Habilitado. |
| Cor | 1 | secondary_label_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: baseado no theme do objeto Settings e do objeto User:1F2C33 para "blue-theme" ou "hc-light";EEEEEE para "dark-theme" ou "hc-dark". |
| Unidades (checkbox) | 0 | secondary_label_units_show | 0 - Desabilitado; 1 - (padrão) Habilitado. Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" |
| Unidades (valor) | 1 | secondary_label_units | Qualquer valor de string."" (vazio)Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" e Unidades (checkbox) estiver definido como "Habilitado" |
| Posição | 0 | secondary_label_position | 0 - Antes do valor; 1 - (padrão) Após o valor. Comportamento do parâmetro: - suportado se Tipo estiver definido como "Valor" e Unidades (checkbox) estiver definido como "Habilitado" Este parâmetro é ignorado se definido como uma das seguintes unidades relacionadas ao tempo: unixtime, uptime, s. |
| Cor de fundo | |||
| Cor de fundo | 1 | bg_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: baseado no theme do objeto Settings e do objeto User:D9E7ED para "blue-theme";3D5059 para "dark-theme";AAD7E9 para "hc-light";335463 para "hc-dark". |
| Limiares | |||
| Interpolação de cor | 0 | interpolation | 0 - Desabilitado; 1 - (padrão) Habilitado. |
| Cor | 1 | thresholds.0.color | Código de cor hexadecimal (por exemplo, FF0000). |
| Limiar | 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: