8 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 compatíveis com a configuração de 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.

Parâmetro type name value
Tipo de conjunto de dados 0 ds.0.dataset_type 0 - Lista de itens;
1 - Padrões de itens (padrão).
Itens 4 ds.0.itemids.0 ID do item.

Ao configurar o widget em um dashboard de template, somente os itens configurados no template devem ser definidos.

Observação: para configurar vários itens, crie um objeto de campo de widget do dashboard para cada item, usando 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 Referência definido como "ABCDE") como a fonte de dados dos itens.

Observação: para configurar vários widgets, crie um objeto de campo de widget do dashboard para cada widget, usando 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 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 itens"

Este parâmetro não é compatível ao configurar o widget em um dashboard de template.
Padrões de item 1 ds.0.items.0 Nome ou padrão de item (por exemplo, "*: Número de *valores processados por segundo").

Ao configurar o widget em um dashboard de template, 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 itens"
Cor 1 ds.0.color Código de cor hexadecimal (por exemplo, FF0000).

Comportamento do parâmetro:
- compatível se Tipo de conjunto de dados estiver definido como "Padrões de itens" e Paleta de cores não estiver definida
Paleta de cores 0 ds.0.color_palette Índice da paleta de cores.

Os valores possíveis variam de 0 a 11.

Padrão: 0.

Comportamento do parâmetro:
- compatível se Tipo de conjunto de dados estiver definido como "Padrões de itens" e Cor não estiver definida
Desenho 0 ds.0.type 0 - Linha (padrão);
1 - Pontos;
2 - Escada;
3 - Barra.
Empilhado 0 ds.0.stacked 0 - Desabilitado (padrão);
1 - Habilitado.

Comportamento do parâmetro:
- compatível 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:
- compatível 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:
- compatível 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:
- compatível se Desenho estiver definido como "Linha" ou "Escada"
Dados ausentes 0 ds.0.missingdatafunc 0 - Nenhum (padrão);
1 - Conectado;
2 - Tratar como 0;
3 - Último conhecido.

Comportamento do parâmetro:
- compatível se Desenho estiver definido como "Linha" ou "Escada"
Substituir host 1 ds.0.override_hostid._reference ABCDE._hostid - defina um widget compatível (com o parâmetro "Referência" definido como "ABCDE") como a fonte de dados dos hosts;
DASHBOARD._hostid - defina o seletor de host do dashboard como a fonte de dados dos hosts.

Este parâmetro não é compatível ao configurar o widget em um dashboard de template.
Eixo Y 0 ds.0.axisy 0 - Esquerdo (padrão);
1 - Direito.
Inverter valores 0 ds.0.invert_values 0 - Desabilitado (padrão);
1 - Habilitado.
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 - não utilizada (padrão);
1 - mín;
2 - máx;
3 - média;
4 - contagem;
5 - soma;
6 - primeiro;
7 - último.
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.
Agregar 0 ds.0.aggregate_grouping 0 - Cada item (padrão);
1 - Conjunto de dados.

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"
Aproximação 0 ds.0.approximation 1 - mín;
2 - média (padrão);
4 - máx;
7 - todos.
Rótulo do conjunto de dados 1 ds.0.data_set_label Qualquer valor de string.

Padrão: "" (vazio).
Tags de item
Tipo de avaliação 0 ds.0.item_tags_evaltype 0 - E/OU (padrão);
2 - OU.
Nome da tag 1 ds.0.item_tags.0.tag Qualquer valor de string.

Observação: 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 ao configurar Tags de item
Operador 0 ds.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 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 ds.0.item_tags.0.value Qualquer valor de string.

Observação: 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 ao configurar Tags de item

Opções de exibição

Os seguintes parâmetros são compatíveis com a configuração de Opções de exibição.

Parâmetro 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) Desabilitado;
1 - Habilitado.
Período de trabalho 0 working_time 0 - (padrão) Desabilitado;
1 - Habilitado.
Nomes dos hosts nos rótulos 0 show_hostnames 0 - (padrão) Automático;
1 - Mostrar;
2 - Ocultar.

Este parâmetro não é compatível ao configurar o widget em um dashboard de template.
Linha de percentil (esquerda)
Status 0 percentile_left 0 - (padrão) Desabilitado;
1 - Habilitado.

Comportamento do parâmetro:
- compatível se Eixo Y (na configuração de Conjunto de dados) estiver definido como "Esquerda"
Valor 0 percentile_left_value Os valores possíveis variam de 1 a 100.

Comportamento do parâmetro:
- compatível se Eixo Y (na configuração de Conjunto de dados) estiver definido como "Esquerda"
Linha de percentil (direita)
Status 0 percentile_right 0 - (padrão) Desabilitado;
1 - Habilitado.

Comportamento do parâmetro:
- compatível se Eixo Y (na configuração de Conjunto de dados) estiver definido como "Direita"
Valor 0 percentile_right_value Os valores possíveis variam de 1 a 100.

Comportamento do parâmetro:
- compatível se Eixo Y (na configuração de Conjunto de dados) estiver definido como "Direita"

Período de tempo

Os seguintes parâmetros são suportados para configurar o Período de tempo.

Parâmetro tipo nome valor
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._timeperiod

Alternativamente, 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 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
- obrigatório se time_period.to estiver definido
Até 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:
- suportado se Período de tempo não estiver definido
- obrigatório se time_period.from estiver definido

Eixos

Os seguintes parâmetros são suportados para configurar Eixos.

Parâmetro tipo nome valor
Y Esquerdo 0 lefty 0 - Desabilitado;
1 - (padrão) Habilitado.

Comportamento do parâmetro:
- suportado se o Eixo Y (na configuração do Conjunto de dados) estiver definido como "Esquerdo"
Y Direito 0 righty 0 - (padrão) Desabilitado;
1 - Habilitado.

Comportamento do parâmetro:
- suportado se o Eixo Y (na configuração do Conjunto de dados) estiver definido como "Direito"
Escala 0 lefty_scale 0 - (padrão) Linear;
1 - Logarítmica.
righty_scale
Mín 1 lefty_min Qualquer valor numérico.

Padrão: "" (vazio).
righty_min
Máx 1 lefty_max Qualquer valor numérico.

Padrão: "" (vazio).
righty_max
Unidades (tipo) 0 lefty_units 0 - (padrão) Automático;
1 - Estático.
righty_units
Unidades (valor) 1 lefty_static_units Qualquer valor de string.

Padrão: "" (vazio).
righty_static_units
Eixo X 0 xaxis 0 - Desabilitado;
1 - (padrão) Habilitado.

Legenda

Os seguintes parâmetros são compatíveis com a configuração de Legenda.

Parâmetro tipo nome valor
Mostrar legenda 0 legend 0 - Desabilitado;
1 - (padrão) Habilitado.
Exibir mínimo/média/máximo 0 legend_statistic 0 - (padrão) Desabilitado;
1 - Habilitado.

Comportamento do parâmetro:
- compatível se Mostrar legenda estiver definido como "Habilitado"
Mostrar função de agregação 0 legend_aggregation 0 - (padrão) Desabilitado;
1 - Habilitado.

Comportamento do parâmetro:
- compatível se Mostrar legenda estiver definido como "Habilitado"
Linhas 0 legend_lines_mode 0 - (padrão) Fixo;
1 - Variável.

Comportamento do parâmetro:
- compatível se Mostrar legenda estiver definido como "Habilitado"
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:
- compatível se Mostrar legenda estiver definido como "Habilitado"
Número de colunas 0 legend_columns Os valores possíveis variam de 1 a 4.

Padrão: 4.

Comportamento do parâmetro:
- compatível se Mostrar legenda estiver definido como "Habilitado" e Exibir mínimo/média/máximo estiver definido como "Desabilitado"

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

Substituições

Os seguintes parâmetros são compatíveis com a configuração de Substituições.

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.

Parâmetro tipo nome valor
Padrões de host 1 or.0.hosts.0 Nome ou padrão de host (por exemplo, Zabbix*).

Este parâmetro não é compatível ao configurar o widget em um dashboard de template.

Comportamento do parâmetro:
- obrigatório ao configurar Substituições
Padrões de item 1 or.0.items.0 Nome ou padrão de item (por exemplo, *: Number of processed *values per second).
Ao configurar o widget em um dashboard de template, somente os padrões dos itens configurados no template devem ser definidos.

Comportamento do parâmetro:
- obrigatório ao configurar Substituições
Cor base 1 or.0.color Código de cor hexadecimal (por exemplo, FF0000).
Largura 0 or.0.width Os valores possíveis variam de 1 a 10.
Desenho 0 or.0.type 0 - Linha;
1 - Pontos;
2 - Escada;
3 - Barra.
Transparência 0 or.0.transparency Os valores possíveis variam de 1 a 10.
Preenchimento 0 or.0.fill Os valores possíveis variam de 1 a 10.
Tamanho do ponto 0 or.0.pointsize Os valores possíveis variam de 1 a 10.
Dados ausentes 0 or.0.missingdatafunc 0 - Nenhum;
1 - Conectado;
2 - Tratar como 0;
3 - Último conhecido.
Eixo Y 0 or.0.axisy 0 - Esquerdo;
1 - Direito.
Inverter valores 0 or.0.invert_values 0 - (padrão) Desabilitado;
1 - Habilitado.
Deslocamento de tempo 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.

Request:

{
    "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
}

Veja também