16 Histórico de item
Descrição
Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget de dashboard permitem configurar o widget Histórico do item 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 Histórico do item, consulte o comportamento dos parâmetros descritos nas tabelas abaixo.
Parâmetros
Os seguintes parâmetros são suportados para o widget Histórico do item.
| 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. |
| Layout | 0 | layout | 0 - (padrão) Horizontal; 1 - Vertical. |
| Colunas (veja abaixo) | |||
| Exibir linhas | 0 | show_lines | Os valores possíveis variam de 1 a 100. Padrão: 25. |
| Substituir host | 1 | override_hostid._reference | ABCDE._hostid - define um widget compatível (com seu parâmetro Referência definido como "ABCDE") como fonte de dados para hosts;DASHBOARD._hostid - define o seletor de host do dashboard como fonte de dados para hosts.Este parâmetro não é suportado ao configurar o widget em um dashboard de template. |
| Configuração avançada (veja abaixo) | |||
| Referência | 1 | reference | Qualquer valor de string composto por 5 caracteres (por exemplo, ABCDE ou JBPNL). Este valor deve ser exclusivo dentro do dashboard ao qual o widget pertence.Comportamento do parâmetro: - obrigatório |
Colunas
As colunas possuem parâmetros comuns e parâmetros adicionais dependendo da configuração do parâmetro Item.
Para todos os parâmetros relacionados às colunas, o número no nome da propriedade (por exemplo, columns.0.name) faz referência a uma coluna para a qual o parâmetro está configurado.
Os seguintes parâmetros são suportados para todas as colunas.
| Parâmetro | tipo | nome | valor |
|---|---|---|---|
| Nome | 1 | columns.0.name | Qualquer valor de string. Comportamento do parâmetro: - obrigatório |
| Item | 4 | columns.0.itemid | ID do item. Ao configurar o widget em um dashboard de template, apenas itens configurados no template devem ser definidos. Comportamento do parâmetro: - obrigatório |
| Cor base | 1 | columns.0.base_color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: "" (vazio). |
Os seguintes parâmetros de coluna são suportados se o Item configurado for um item do tipo numérico.
| Parâmetro | type | name | value | |
|---|---|---|---|---|
| Exibição | 0 | columns.0.display | 1 - (padrão) Como está; 2 - Barra; 3 - Indicadores. |
|
| Mín | 1 | columns.0.min | Qualquer valor numérico. Comportamento do parâmetro: - suportado se Exibição estiver definido como "Barra" ou "Indicadores" |
|
| Máx | 1 | columns.0.max | Qualquer valor numérico. Comportamento do parâmetro: - suportado se Exibição estiver definido como "Barra" ou "Indicadores" |
|
| Limiares | ||||
| Cor | 1 | columns.0.thresholds.0.color | Código de cor hexadecimal (por exemplo, FF0000). |
|
| Limiar | 1 | columns.0.thresholds.0.threshold | Qualquer valor numérico. Sufixos (por exemplo, "1d", "2w", "4K", "8G") são suportados. | |
| Dados históricos | 0 | columns.0.history | 0 - (padrão) Automático; 1 - Histórico; 2 - Tendências. |
|
Os seguintes parâmetros de coluna são suportados se o Item configurado for um item do tipo caractere, texto ou log.
| Parâmetro | type | name | value | |
|---|---|---|---|---|
| Destaques | ||||
| Destaque | 1 | columns.0.highlights.0.color | Código de cor hexadecimal (por exemplo, FF0000). |
|
| Limite | 1 | columns.0.highlights.0.pattern | Qualquer expressão regular. | |
| Exibição | 0 | columns.0.display | 1 - (padrão) Como está; 4 - HTML; 5 - Linha única. |
|
| Linha única | 0 | columns.0.max_length | Os valores possíveis variam de 1-500. Padrão: 100. Comportamento do parâmetro: - suportado se Exibição estiver definida como "Linha única" |
|
| Usar fonte monoespaçada | 0 | columns.0.monospace_font | 0 - (padrão) Usar fonte padrão; 1 - Usar fonte monoespaçada. |
|
| Exibir hora local | 0 | columns.0.local_time | 0 - (padrão) Exibir timestamp; 1 - Exibir hora local. Comportamento do parâmetro: - suportado se Item estiver definido como item do tipo log e Exibir timestamp estiver definido como "Habilitado" |
|
Os seguintes parâmetros de coluna são suportados se o Item configurado for um item do tipo binário.
| Parâmetro | tipo | nome | valor |
|---|---|---|---|
| Mostrar miniatura | 1 | columns.0.show_thumbnail | 0 - (padrão) Desabilitado; 1 - Habilitado. |
Configuração avançada
Os seguintes parâmetros de configuração avançada são suportados para o widget Histórico de item.
| Parâmetro | tipo | nome | valor | |
|---|---|---|---|---|
| Novos valores | 0 | sortorder | 0 - (padrão) Topo; 1 - Fundo. |
|
| Mostrar carimbo de data/hora | 0 | show_timestamp | 0 - (padrão) Desabilitado; 1 - Habilitado. |
|
| Mostrar cabeçalho da coluna | 0 | show_column_header | 0 - Desligado; 1 - Horizontal; 2 - (padrão) Vertical. |
|
| Período de tempo | 1 | time_period._reference | DASHBOARD._timeperiod - define o seletor de período de tempo do dashboard como fonte de dados;ABCDE._timeperiod - define um widget compatível (com seu parâmetro Referência definido como "ABCDE") como fonte de dados.Padrão: DASHBOARD._timeperiodAlternativamente, você pode definir o período de tempo apenas nos parâmetros De e Até. |
|
| De | 1 | time_period.from | String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou sintaxe de tempo relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Período de tempo não estiver definido - obrigatório se time_period.to estiver definido |
|
| Até | 1 | time_period.to | String de tempo válida no formato absoluto (YYYY-MM-DD hh:mm:ss) ou sintaxe de tempo relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Período de tempo não estiver definido - obrigatório se time_period.from estiver definido |
|
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 Histórico do item.
Para mais informações sobre a configuração de um dashboard, consulte dashboard.create.
Configurando um widget Histórico de item
Configure um widget Histórico de item que exibe os dados mais recentes para dois itens numéricos "42269" e "42270". Além disso, configure as colunas dos itens para serem exibidas verticalmente, com os nomes das colunas exibidos horizontalmente; limite a exibição a 15 linhas de dados e inclua uma coluna separada para o timestamp.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemhistory",
"name": "Item history",
"x": "0",
"y": "0",
"width": "18",
"height": "6",
"view_mode": "0",
"fields": [
{
"type": "0",
"name": "layout",
"value": "1"
},
{
"type": "1",
"name": "columns.0.name",
"value": "CPU utilization"
},
{
"type": "4",
"name": "columns.0.itemid",
"value": "42269"
},
{
"type": "1",
"name": "columns.1.name",
"value": "Memory utilization"
},
{
"type": "4",
"name": "columns.1.itemid",
"value": "42270"
},
{
"type": "0",
"name": "show_lines",
"value": "15"
},
{
"type": "0",
"name": "show_timestamp",
"value": "1"
},
{
"type": "0",
"name": "show_column_header",
"value": "1"
},
{
"type": "1",
"name": "reference",
"value": "KIVKD"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}