9 Gráfico
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 Gráfico 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 Gráfico, consulte o comportamento dos parâmetros descritos nas tabelas abaixo.
Parâmetros
Os seguintes parâmetros são suportados para o widget Gráfico.
| 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. |
| Referência | 1 | reference | Qualquer valor de string consistindo de 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 |
Conjunto de dados
Os parâmetros a seguir são suportados para configurar um Conjunto de dados.
O primeiro número no nome da propriedade (por exemplo, ds.0.hosts.0, ds.0.items.0) representa o conjunto de dados específico, enquanto o segundo número, se presente, representa o host ou item configurado.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Tipo de conjunto de dados | 0 | ds.0.dataset_type | 0 - Lista de itens; 1 - (padrão) Padrões de item. |
|
| Itens | 4 | ds.0.itemids.0 | ID do Item. Ao configurar o widget em um template dashboard, somente os itens configurados no template devem ser definidos. Observação: para configurar vários itens, crie um objeto de campo do widget do dashboard para cada item com um número incrementado no nome da propriedade. Comportamento do parâmetro: - obrigatório se Tipo de conjunto de dados estiver definido como "Lista de itens" e Itens (Widget) não estiver definido |
|
| Itens (Widget) | 1 | ds.0.itemids.0._reference | Em vez do ID do Item:ABCDE._itemid - defina um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados dos itens.Observação: para configurar vários widgets, crie um objeto de campo do widget do dashboard para cada widget com um número incrementado no nome da propriedade. Este parâmetro é suportado desde o Zabbix 7.0.1. Comportamento do parâmetro: - obrigatório se Tipo de conjunto de dados estiver definido como "Lista de itens" e Itens não estiver definido |
|
| Cor | 1 | ds.0.color.0 | Código de cor hexadecimal (por exemplo, FF0000).Comportamento do parâmetro: - obrigatório se Tipo de conjunto de dados estiver definido como "Lista de itens" |
|
| Padrões de host | 1 | ds.0.hosts.0 | Nome ou padrão de Host (por exemplo, "Zabbix*"). Comportamento do parâmetro: - obrigatório se Tipo de conjunto de dados estiver definido como "Padrões de item" Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Padrões de item | 1 | ds.0.items.0 | Nome ou padrão de Item (por exemplo, "*: Number of processed *values per second"). 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 se Tipo de conjunto de dados estiver definido como "Padrões de item" |
|
| Cor | 1 | ds.0.color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: FF465C.Comportamento do parâmetro: - suportado se Tipo de conjunto de dados estiver definido como "Padrões de item" |
|
| Desenho | 0 | ds.0.type | 0 - (padrão) Linha; 1 - Pontos; 2 - Escada; 3 - Barra. |
|
| Empilhado | 0 | ds.0.stacked | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - suportado se Desenho estiver definido como "Linha", "Escada" ou "Barra" |
|
| Largura | 0 | ds.0.width | Os valores possíveis variam de 1 a 10. Padrão: 1. Comportamento do parâmetro: - suportado se Desenho estiver definido como "Linha" ou "Escada" |
|
| Tamanho do ponto | 0 | ds.0.pointsize | Os valores possíveis variam de 1 a 10. Padrão: 3. Comportamento do parâmetro: - suportado se Desenho estiver definido como "Pontos" |
|
| Transparência | 0 | ds.0.transparency | Os valores possíveis variam de 1 a 10. Padrão: 5. |
|
| Preenchimento | 0 | ds.0.fill | Os valores possíveis variam de 1 a 10. Padrão: 3. Comportamento do parâmetro: - suportado se Desenho estiver definido como "Linha" ou "Escada" |
|
| Dados ausentes | 0 | ds.0.missingdatafunc | 0 - (padrão) Nenhum; 1 - Conectado; 2 - Tratar como 0; 3 - Último conhecido. Comportamento do parâmetro: - suportado se Desenho estiver definido como "Linha" ou "Escada" |
|
| Eixo Y | 0 | ds.0.axisy | 0 - (padrão) Esquerda; 1 - Direita. |
|
| Deslocamento de tempo | 1 | ds.0.timeshift | String de tempo válida (por exemplo, 3600, 1h, etc.).Você pode usar sufixos de tempo. Valores negativos também são permitidos. Padrão: "" (vazio). |
|
| Função de agregação | 0 | ds.0.aggregate_function | 0 - (padrão) não usado; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Intervalo de agregação | 1 | ds.0.aggregate_interval | String de tempo válida (por exemplo, 3600, 1h, etc.).Você pode usar sufixos de tempo. Padrão: 1h. |
|
| Agregação | 0 | ds.0.aggregate_grouping | 0 - (padrão) Cada item; 1 - Conjunto de dados. Comportamento do parâmetro: - suportado se Função de agregação estiver definida como "min", "max", "avg", "count", "sum", "first" ou "last" |
|
| Aproximação | 0 | ds.0.approximation | 1 - min; 2 - (padrão) avg; 4 - max; 7 - all. |
|
| Rótulo do conjunto de dados | 1 | ds.0.data_set_label | Qualquer valor de string. Padrão: "" (vazio). |
|
Opções de exibição
Os seguintes parâmetros são suportados para configurar Opções de exibição.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Seleção de dados históricos | 0 | source | 0 - (padrão) Automático; 1 - Histórico; 2 - Tendências. |
|
| Triggers simples | 0 | simple_triggers | 0 - (padrão) Desativado; 1 - Ativado. |
|
| Tempo de trabalho | 0 | working_time | 0 - (padrão) Desativado; 1 - Ativado. |
|
| Linha de percentil (esquerda) | ||||
| Status | 0 | percentile_left | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - suportado se Y-axis (na configuração de Data set) estiver definido como "Left" |
|
| Valor | 0 | percentile_left_value | Os valores possíveis variam de 1 a 100. Comportamento do parâmetro: - suportado se Y-axis (na configuração de Data set) estiver definido como "Left" |
|
| Linha de percentil (direita) | ||||
| Status | 0 | percentile_right | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - suportado se Y-axis (na configuração de Data set) estiver definido como "Right" |
|
| Valor | 0 | percentile_right_value | Os valores possíveis variam de 1 a 100. Comportamento do parâmetro: - suportado se Y-axis (na configuração de Data set) estiver definido como "Right" |
|
Período de tempo
Os seguintes parâmetros são suportados para configurar Período de tempo.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Período de tempo | 1 | time_period._reference | DASHBOARD._timeperiod - define o seletor Período de tempo como a fonte de dados;ABCDE._timeperiod - define um widget compatível (com seu parâmetro Reference definido como "ABCDE") como a fonte de dados.Padrão: DASHBOARD._timeperiodComo alternativa, você pode definir o período de tempo apenas nos parâmetros From e To. |
|
| From | 1 | 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: - supported se Período de tempo não estiver definido - required se time_period.to estiver definido |
|
| To | 1 | 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: - supported se Período de tempo não estiver definido - required se time_period.from estiver definido |
|
Eixos
Os seguintes parâmetros são suportados para configurar Axes.
| Parameter | type | name | value |
|---|---|---|---|
| Left Y | 0 | lefty | 0 - Desativado; 1 - (padrão) Ativado. Parameter behavior: - supported se Y-axis (na configuração de Data set) estiver definido como "Left" |
| Right Y | 0 | righty | 0 - (padrão) Desativado; 1 - Ativado. Parameter behavior: - supported se Y-axis (na configuração de Data set) estiver definido como "Right" |
| Min | 1 | lefty_min | Qualquer valor numérico. Padrão: "" (vazio). |
| righty_min | |||
| Max | 1 | lefty_max | Qualquer valor numérico. Padrão: "" (vazio). |
| righty_max | |||
| Units (type) | 0 | lefty_units | 0 - (padrão) Automático; 1 - Estático. |
| righty_units | |||
| Units (value) | 1 | lefty_static_units | Qualquer valor de string. Padrão: "" (vazio). |
| righty_static_units | |||
| X-Axis | 0 | xaxis | 0 - Desativado; 1 - (padrão) Ativado. |
Legenda
Os seguintes parâmetros são suportados para configurar Legend.
| Parameter | type | name | value |
|---|---|---|---|
| Mostrar legenda | 0 | legend | 0 - Desativado; 1 - (padrão) Ativado. Comportamento do parâmetro: - supported se Mostrar legenda estiver definido como "Ativado" |
| Exibir mín./méd./máx. | 0 | legend_statistic | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - supported se Mostrar legenda estiver definido como "Ativado" |
| Mostrar função de agregação | 0 | legend_aggregation | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - supported se Mostrar legenda estiver definido como "Ativado" |
| Linhas | 0 | legend_lines_mode | 0 - (padrão) Fixo; 1 - Variável. Comportamento do parâmetro: - supported se Mostrar legenda estiver definido como "Ativado" |
| Número de linhas/ Número máximo de linhas |
0 | legend_lines | Os valores possíveis variam de 1 a 10. Padrão: 1. Comportamento do parâmetro: - supported se Mostrar legenda estiver definido como "Ativado" |
| Número de colunas | 0 | legend_columns | Os valores possíveis variam de 1 a 4. Padrão: 4. Comportamento do parâmetro: - supported se Mostrar legenda estiver definido como "Ativado", e Exibir mín./méd./máx. estiver definido como "Desativado" |
Problemas
Os seguintes parâmetros são suportados para configurar Problemas.
| Parâmetro | tipo | nome | valor | |
|---|---|---|---|---|
| Mostrar problemas | 0 | show_problems | 0 - (padrão) Desabilitado; 1 - Habilitado. |
|
| Apenas itens selecionados | 0 | graph_item_problems | 0 - Desabilitado; 1 - (padrão) Habilitado. |
|
| Hosts com problemas | 1 | problemhosts.0 | Nome do host. Nota: O número no nome da propriedade faz referência ao host configurado. 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. Este parâmetro não é suportado se estiver configurando o widget em um dashboard de template. |
|
| Severidade | 0 | severities.0 | 0 - Não classificado; 1 - Informação; 2 - Aviso; 3 - Médio; 4 - Alto; 5 - Desastre. Padrão: vazio (todos habilitados). 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. |
|
| Problema | 1 | problem_name | Nome do evento do problema (não diferencia maiúsculas de minúsculas, nome completo ou parte dele). | |
| Tags do problema | ||||
| Tipo de avaliação | 0 | evaltype | 0 - (padrão) E/Ou; 2 - Ou. |
|
| Nome da tag | 1 | 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 do problema |
|
| Operador | 0 | 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 do problema |
|
| Valor da tag | 1 | 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 do problema |
|
Overrides
Os seguintes parâmetros são suportados para configurar Overrides.
O primeiro número no nome da propriedade (por exemplo, or.0.hosts.0, or.0.items.0) representa o conjunto de dados específico, enquanto o segundo número, se presente, representa o host ou item configurado.
| Parameter | type | name | value |
|---|---|---|---|
| Host patterns | 1 | or.0.hosts.0 | Nome ou padrão do host (por exemplo, Zabbix*).Este parâmetro não é suportado ao configurar o widget em um template dashboard. Comportamento do parâmetro: - obrigatório ao configurar Overrides |
| Item patterns | 1 | or.0.items.0 | Nome ou padrão do item (por exemplo, *: Number of processed *values per second).Ao configurar o widget em um template dashboard, apenas os padrões para itens configurados no template devem ser definidos. Comportamento do parâmetro: - obrigatório ao configurar Overrides |
| Base color | 1 | or.0.color | Código de cor hexadecimal (por exemplo, FF0000). |
| Width | 0 | or.0.width | Os valores possíveis variam de 1 a 10. |
| Draw | 0 | or.0.type | 0 - Linha; 1 - Pontos; 2 - Escada; 3 - Barra. |
| Transparency | 0 | or.0.transparency | Os valores possíveis variam de 1 a 10. |
| Fill | 0 | or.0.fill | Os valores possíveis variam de 1 a 10. |
| Point size | 0 | or.0.pointsize | Os valores possíveis variam de 1 a 10. |
| Missing data | 0 | or.0.missingdatafunc | 0 - Nenhum; 1 - Conectado; 2 - Tratar como 0; 3 - Último conhecido. |
| Y-axis | 0 | or.0.axisy | 0 - Esquerda; 1 - Direita. |
| Time shift | 1 | or.0.timeshift | String de tempo válida (por exemplo, 3600, 1h, etc.).Você pode usar sufixos de tempo. Valores negativos são permitidos. |
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 Gráfico.
Para mais informações sobre a configuração de um dashboard, consulte dashboard.create.
Configurando um widget Graph
Configure um widget Graph da seguinte forma:
- 2 conjuntos de dados para um total de 9 items em 1 host.
- O primeiro conjunto de dados é do tipo "Item list" e consiste em 3 items que são representados por linhas com cores diferentes, mas com a mesma largura, transparência e preenchimento.
- O segundo conjunto de dados é do tipo "Item patterns", consiste em 6 items, possui uma agregação configurada e é representado por uma linha com cor, largura, transparência e preenchimento personalizados.
- O segundo conjunto de dados também possui um rótulo de conjunto de dados personalizado.
- Os dados no gráfico são exibidos para um período de tempo das últimas 3 horas.
- Os problemas no gráfico são exibidos apenas para os items configurados.
- O gráfico possui dois eixos Y, dos quais o eixo Y direito exibe valores apenas para o segundo conjunto de dados.
- A legenda do gráfico exibe os items configurados em 4 linhas, bem como os valores mínimo, máximo e médio dos conjuntos de dados.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "svggraph",
"name": "Graph",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.width",
"value": 3
},
{
"type": 0,
"name": "ds.0.transparency",
"value": 3
},
{
"type": 0,
"name": "ds.0.fill",
"value": 1
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.transparency",
"value": 0
},
{
"type": 0,
"name": "ds.1.fill",
"value": 0
},
{
"type": 0,
"name": "ds.1.axisy",
"value": 1
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.aggregate_interval",
"value": "1m"
},
{
"type": 0,
"name": "ds.1.aggregate_grouping",
"value": 1
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_statistic",
"value": 1
},
{
"type": 0,
"name": "legend_lines",
"value": 4
},
{
"type": 0,
"name": "show_problems",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "YZABC"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Resposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}