Nesta página
28 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 integrados 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.
| 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 o 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 o 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 | host_tags_evaltype | 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 referencia a 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 referencia a 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 referencia a 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. |
|
| Layout | 0 | layout | 0 - (padrão) Horizontal; 1 - Vertical. |
|
| Show problems | 0 | show_problems | 0 - Todos; 1 - (padrão) Não suprimidos; 2 - Nenhum. |
|
| Items (see below) | ||||
Configuração avançada
Os seguintes parâmetros de configuração avançada são suportados para o widget Top items.
| Parâmetro | tipo | nome | valor | |
|---|---|---|---|---|
| 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"). 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. Ao configurar o widget em um dashboard de template, apenas os padrões para itens configurados no template devem ser definidos. 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-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. Nota: Para configurar múltiplos padrões de host, crie um objeto de campo de widget de dashboard para cada padrão de host com 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-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).
| Parameter | type | name | value | |
|---|---|---|---|---|
| Padrões de item | 1 | columns.0.items.0 | Nome ou padrão do Item (por exemplo, "*: Number of processed *values per second"). 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 com um segundo número incrementado no nome da propriedade. Ao configurar o widget em um template dashboard, somente os padrões dos itens configurados no template devem ser definidos. Comportamento do parâmetro: - obrigatório |
|
| Tags de item | ||||
| Tipo de avaliação | 0 | columns.0.item_tags_evaltype | 0 - (padrão) And/Or; 2 - Or. |
|
| 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 ao configurar Tags de item |
|
| Operador | 0 | columns.0.item_tags.0.operator | 0 - Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. 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 ao configurar Tags de item |
|
| 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 ao configurar Tags de item |
|
| 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 suportados. Comportamento do parâmetro: - suportado 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 suportados. Comportamento do parâmetro: - suportado 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: - suportado 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: - suportado 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: - suportado se Exibição estiver definida como "Sparkline" |
|
| Período de tempo | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - define o seletor de Período de tempo como a fonte de dados;ABCDE._timeperiod - define um widget compatível (com o parâmetro reference igual a ABCDE) como a fonte de dados.Padrão: DASHBOARD._timeperiodComo alternativa, você pode definir o período de tempo apenas nos parâmetros De e Até. Comportamento do parâmetro: - suportado se Exibição estiver definida como "Sparkline" |
|
| De | 1 | columns.0.sparkline.time_period.from | String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado 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 em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado 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) Auto; 1 - Histórico; 2 - Tendências. Comportamento do parâmetro: - suportado 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: - suportado se Exibir valor como estiver definido como "Numérico" |
|
| Limite | 1 | columns.0.thresholds.0.threshold | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são suportados. Comportamento do parâmetro: - suportado 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: - suportado se Exibir valor como estiver definido como "Texto" |
|
| Limite | 1 | columns.0.highlights.0.pattern | Qualquer expressão regular. Comportamento do parâmetro: - suportado 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 usado; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. Se Exibir valor como estiver definido como "Texto": 0 - (padrão) não usado; 4 - count; 6 - first; 7 - last. |
|
| Período de tempo | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - define o seletor de Período de tempo como a fonte de dados;ABCDE._timeperiod - define um widget compatível (com o parâmetro reference igual a ABCDE) como a fonte de dados.Padrão: DASHBOARD._timeperiodComo alternativa, você pode definir o período de tempo apenas nos parâmetros De e Até. Comportamento do parâmetro: - suportado se a Função de agregação estiver definida como "min", "max", "avg", "count", "sum", "first", "last" |
|
| De | 1 | columns.0.time_period.from | String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Período de tempo não estiver definido e a Função de agregação estiver definida como "min", "max", "avg", "count", "sum", "first", "last" - obrigatório se columns.0.time_period.to estiver definido |
|
| Até | 1 | columns.0.time_period.to | String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Período de tempo não estiver definido e a Função de agregação estiver definida como "min", "max", "avg", "count", "sum", "first", "last" - obrigatório se columns.0.time_period.from estiver definido |
|
| Dados históricos | 0 | columns.0.history | 0 - (padrão) Auto; 1 - Histórico; 2 - Tendências. Comportamento do parâmetro: - suportado se Exibir valor como estiver definido como "Numérico" |
|
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
}