Nesta página
29 Principais items
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 Top items 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 Top items, consulte o comportamento dos parâmetros descrito nas tabelas abaixo.
Parâmetros
Os seguintes parâmetros são suportados para o widget Top items.
| Parâmetro | type | name | value | |
|---|---|---|---|---|
| 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 estiver configurando o widget 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 estiver configurando o widget 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 estiver configurando o widget 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 estiver configurando o widget em um dashboard de template. |
|
| Tags de host | ||||
| Tipo de avaliação | 0 | host_tags_evaltype | 0 - (padrão) E/Ou; 2 - Ou. Este parâmetro não é suportado se estiver configurando o widget 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 estiver configurando o widget em um dashboard de template. |
|
| Operador | 0 | host_tags.0.operator | 0 - Contém; 1 - Igual; 2 - Não contém; 3 - Diferente; 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 estiver configurando o widget 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 estiver configurando o widget em um dashboard de template. |
|
| Layout | 0 | layout | 0 - (padrão) Horizontal; 1 - Vertical. |
|
| Mostrar problemas | 0 | show_problems | 0 - Todos; 1 - (padrão) Não suprimidos; 2 - Nenhum. |
|
| Items (veja abaixo) | ||||
Configuração avançada
Os seguintes parâmetros de configuração avançada são compatíveis com o widget Top items.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Ordenação de hosts | ||||
| Ordenar por | 0 | host_ordering_order_by | 0 - (padrão) Nome do host; 3 - Valor do item. |
|
| Padrões de item | 1 | host_ordering_item.0 | Nome ou padrão do item (por exemplo, "*: Número de *valores processados por segundo"). Observação: para configurar vários padrões de item, crie um objeto de campo do widget do dashboard para cada padrão de item, usando um número incrementado no nome da propriedade. Ao configurar o widget em um dashboard de template, defina somente os padrões dos itens configurados no template. Comportamento do parâmetro: - obrigatório se Ordenar por estiver definido como "Valor do item" |
|
| Ordem | 0 | host_ordering_order | 2 - (padrão) Top N; 3 - Bottom N. |
|
| Limite | 0 | host_ordering_limit | Os valores possíveis variam de 1 a 100. Padrão: 10. |
|
| Ordenação de itens | ||||
| Ordenar por | 0 | item_ordering_order_by | 1 - Host; 2 - Nome do item; 3 - (padrão) Valor do item. |
|
| Padrões de host | 1 | item_ordering_host.0 | Nome ou padrão do host. Observação: para configurar vários padrões de host, crie um objeto de campo do widget do dashboard para cada padrão de host, usando um número incrementado no nome da propriedade. Comportamento do parâmetro: - obrigatório se Ordenar por estiver definido como "Host" |
|
| Ordem | 0 | item_ordering_order | 2 - (padrão) Top N; 3 - Bottom N. |
|
| Limite | 0 | item_ordering_limit | Os valores possíveis variam de 1 a 100. Padrão: 10. |
|
Colunas
O primeiro número no nome da propriedade (por exemplo, columns.0.items.0, columns.0.item_tags_evaltype) representa a coluna específica, enquanto o segundo número, se presente, representa a entidade configurada (por exemplo, padrão de item, tag).
| Parâmetro | tipo | nome | valor | |
|---|---|---|---|---|
| Padrões de item | 1 | columns.0.items.0 | Nome ou padrão de item (por exemplo, "*: Número de valores processados por segundo"). Observação: para configurar vários padrões de item, crie um objeto de campo de widget do dashboard para cada padrão de item, incrementando o segundo número no nome da propriedade. Ao configurar o widget em um dashboard de template, defina somente os padrões dos itens configurados no template. Comportamento do parâmetro: - obrigatório |
|
| Tags de item | ||||
| Tipo de avaliação | 0 | columns.0.item_tags_evaltype | 0 - (padrão) E/OU; 2 - OU. |
|
| Nome da tag | 1 | columns.0.item_tags.0.tag | Qualquer valor de string. Observação: o segundo 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 Tags de item estiver sendo configurado |
|
| Operador | 0 | columns.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. Observação: o segundo 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 Tags de item estiver sendo configurado |
|
| Valor da tag | 1 | columns.0.item_tags.0.value | Qualquer valor de string. Observação: o segundo 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 Tags de item estiver sendo configurado |
|
| Cor base | 1 | columns.0.base_color | Código de cor hexadecimal (por exemplo, FF0000). |
|
| Exibir valor como | 0 | columns.0.display_value_as | 1 - (padrão) Numérico; 2 - Texto. |
|
| Exibição | 0 | columns.0.display | 1 - (padrão) Como está; 2 - Barra; 3 - Indicadores; 6 - Sparkline. |
|
| Mín. | 1 | columns.0.min | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são compatíveis. Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Numérico" e Exibição estiver definida como "Barra" ou "Indicadores" |
|
| Máx. | 1 | columns.0.max | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são compatíveis. Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Numérico" e Exibição estiver definida como "Barra" ou "Indicadores" |
|
| Sparkline | ||||
| Largura | 0 | columns.0.sparkline.width | Os valores possíveis variam de 0 a 10. Padrão: 1. Comportamento do parâmetro: - compatível se Exibição estiver definida como "Sparkline" |
|
| Preenchimento | 0 | columns.0.sparkline.fill | Os valores possíveis variam de 0 a 10. Padrão: 3. Comportamento do parâmetro: - compatível se Exibição estiver definida como "Sparkline" |
|
| Cor | 1 | columns.0.sparkline.color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: 42A5F5.Comportamento do parâmetro: - compatível se Exibição estiver definida como "Sparkline" |
|
| Período | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - define o seletor de período do dashboard como fonte de dados;ABCDE._timeperiod - define um widget compatível (com o parâmetro reference igual a ABCDE) como fonte de dados.Padrão: DASHBOARD._timeperiodComo alternativa, você pode definir o período somente nos parâmetros De e Até. Comportamento do parâmetro: - compatível se Exibição estiver definida como "Sparkline" |
|
| De | 1 | columns.0.sparkline.time_period.from | String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou na sintaxe de tempo relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - compatível se Exibição estiver definida como "Sparkline" - obrigatório se columns.0.sparkline.time_period.to estiver definido |
|
| Até | 1 | columns.0.sparkline.time_period.to | String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou na sintaxe de tempo relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - compatível se Exibição estiver definida como "Sparkline" - obrigatório se columns.0.sparkline.time_period.from estiver definido |
|
| Dados históricos | 0 | columns.0.sparkline.history | 0 - (padrão) Automático; 1 - Histórico; 2 - Tendências. Comportamento do parâmetro: - compatível se Exibição estiver definida como "Sparkline" |
|
| Limiares | ||||
| Cor | 1 | columns.0.thresholds.0.color | Código de cor hexadecimal (por exemplo, FF0000).Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Numérico" |
|
| Limiar | 1 | columns.0.thresholds.0.threshold | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são compatíveis. Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Numérico" |
|
| Destaques | ||||
| Destaque | 1 | columns.0.highlights.0.color | Código de cor hexadecimal (por exemplo, FF0000).Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Texto" |
|
| Limiar | 1 | columns.0.highlights.0.pattern | Qualquer expressão regular. Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Texto" |
|
| Casas decimais | 0 | columns.0.decimal_places | Os valores possíveis variam de 0 a 10. Padrão: 2. |
|
| Configuração avançada | ||||
| Função de agregação | 0 | columns.0.aggregate_function | Se Exibir valor como estiver definido como "Numérico": 0 - (padrão) não utilizada; 1 - mín.; 2 - máx.; 3 - média; 4 - contagem; 5 - soma; 6 - primeiro; 7 - último. Se Exibir valor como estiver definido como "Texto": 0 - (padrão) não utilizada; 4 - contagem; 6 - primeiro; 7 - último. |
|
| Período | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - define o seletor de período do dashboard como fonte de dados;ABCDE._timeperiod - define um widget compatível (com o parâmetro reference igual a ABCDE) como fonte de dados.Padrão: DASHBOARD._timeperiodComo alternativa, você pode definir o período somente nos parâmetros De e Até. Comportamento do parâmetro: - compatível se Função de agregação estiver definida como "mín.", "máx.", "média", "contagem", "soma", "primeiro" ou "último" |
|
| De | 1 | columns.0.time_period.from | String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou na sintaxe de tempo relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - compatível se Período não estiver definido e Função de agregação estiver definida como "mín.", "máx.", "média", "contagem", "soma", "primeiro" ou "último" - obrigatório se columns.0.time_period.to estiver definido |
|
| Até | 1 | columns.0.time_period.to | String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou na sintaxe de tempo relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - compatível se Período não estiver definido e Função de agregação estiver definida como "mín.", "máx.", "média", "contagem", "soma", "primeiro" ou "último" - obrigatório se columns.0.time_period.from estiver definido |
|
| Dados históricos | 0 | columns.0.history | 0 - (padrão) Automático; 1 - Histórico; 2 - Tendências. Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Numérico" |
|
| Agregação | 0 | columns.0.aggregate_columns | 0 - (padrão) Cada item 1 - Combinado. Comportamento do parâmetro: - compatível se Exibir valor como estiver definido como "Numérico" e Exibição estiver definida como "Como está", "Barra" ou "Indicadores". |
|
| Função de agregação combinada | 0 | columns.0.column_aggregate_function | 1 - mín.; 2 - máx.; 3 - média; 4 - contagem; 5 - soma (padrão). Comportamento do parâmetro: - obrigatório ao configurar Agregação. |
|
| Nome da coluna combinada | 1 | columns.0.combined_column_name | Qualquer valor de string. Comportamento do parâmetro: - obrigatório ao configurar Agregação. |
|
Exemplos
Os exemplos a seguir têm como objetivo apenas descrever a configuração dos objetos de campo do widget de dashboard para o widget Top items.
Para mais informações sobre como configurar um dashboard, consulte dashboard.create.
Configurando um widget Top items
Configure um widget Top items que exiba dados para o host "10084" e apenas para os items para os quais a tag com o nome "component" contenha o valor "cpu". Além disso, exiba os dados com os hosts localizados no topo e use uma barra de medidor colorida para a representação da célula.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}