20 Gráfico de pizza

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 de pizza 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 de pizza, consulte o comportamento dos parâmetros descrito nas tabelas abaixo.

Parâmetros

Os seguintes parâmetros são suportados para o widget Gráfico de pizza.

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.

Conjunto de dados

Os seguintes parâmetros 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 itens.
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 para 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"
Tipo de item 0 ds.0.type.0 0 - (padrão) Normal;
1 - Total.

O valor "Total" pode ser definido apenas para um item em todo o gráfico.

Comportamento do parâmetro:
- suportado 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 do 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 é suportado ao configurar o widget em um template dashboard.
Padrões de item 1 ds.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, somente os padrões para 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:
- suportado se Tipo de conjunto de dados estiver definido como "Padrões de itens"
Função de agregação 0 ds.0.aggregate_function 1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - (padrão) last.
Agregação do conjunto de dados 0 ds.0.dataset_aggregation 0 - (padrão) none;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum.

Comportamento do parâmetro:
- suportado se Tipo de item estiver definido como "Total"
Rótulo do conjunto de dados 1 ds.0.data_set_label Qualquer valor de string.

Padrão: "" (vazio).

Exibindo opções

Os seguintes parâmetros são suportados para configurar Exibindo opções.

Parameter type name value
Seleção de dados do histórico 0 source 0 - (padrão) Automático;
1 - Histórico;
2 - Tendências.
Desenho 0 draw_type 0 - (padrão) Pizza;
1 - Rosca.
Largura 0 width 20 - 20% do raio;
30 - 30% do raio;
40 - 40% do raio;
50 - (padrão) 50% do raio.

Parameter behavior:
- supported if Draw is set to "Doughnut"
Largura do traço 0 stroke Valores possíveis variam de 0-10.

Padrão: 0.

Este parâmetro é suportado desde o Zabbix 7.0.1.

Parameter behavior:
- supported if Draw is set to "Doughnut"
Mostrar valor total 0 total_show 0 - (padrão) Desativado;
1 - Ativado.

Parameter behavior:
- supported if Draw is set to "Doughnut"
Tamanho 0 value_size_type 0 - (padrão) Automático;
1 - Personalizado.

Parameter behavior:
- supported if Show total value is set to "Enabled"
Tamanho (valor para tamanho personalizado) 0 value_size Valores possíveis variam de 1-100.

Padrão: 20.

Parameter behavior:
- supported if Show total value is set to "Enabled"
Casas decimais 0 decimal_places Valores possíveis variam de 0-6.

Padrão: 2.

Parameter behavior:
- supported if Show total value is set to "Enabled"
Unidades (caixa de seleção) 0 units_show 0 - (padrão) Desativado;
1 - Ativado.

Parameter behavior:
- supported if Show total value is set to "Enabled"
Unidades (valor) 1 units Qualquer valor de string.

Parameter behavior:
- supported if Units (checkbox) is set to "Enabled"
Negrito 0 value_bold 0 - (padrão) Desativado;
1 - Ativado.

Parameter behavior:
- supported if Show total value is set to "Enabled"
Cor 1 value_color Código de cor hexadecimal (por exemplo, FF0000).

Parameter behavior:
- supported if Show total value is set to "Enabled"
Espaço entre setores 0 space Valores possíveis variam de 0-10.

Padrão: 1.
Mesclar setores menores que N% (caixa de seleção) 0 merge 0 - (padrão) Desativado;
1 - Ativado.
Mesclar setores menores que N% (valor) 0 merge_percent Valores possíveis variam de 1-10.

Padrão: 1.

Parameter behavior:
- supported if Merge sectors smaller than N% (checkbox) is set to "Enabled"
Mesclar setores menores que N% (cor) 1 merge_color Código de cor hexadecimal (por exemplo, FF0000).

Parameter behavior:
- supported if Merge sectors smaller than N% (checkbox) is set to "Enabled"

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 de Período de tempo como a fonte de dados;
ABCDE._timeperiod - define um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados.

Padrão: DASHBOARD._timeperiod

Como 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 Time period 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 Time period não estiver definido
- required se time_period.from estiver definido

Legenda

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

Parâmetro tipo nome valor
Mostrar legenda 0 legend 0 - Desabilitado;
1 - (padrão) Habilitado.
Mostrar valor 0 legend_value 0 - (padrão) Desabilitado;
1 - Habilitado.

Comportamento do parâmetro:
- suportado 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:
- suportado se Mostrar legenda estiver definido como "Habilitado"
Linhas 0 legend_lines_mode 0 - (padrão) Fixo;
1 - Variável.

Comportamento do parâmetro:
- suportado 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-10.

Padrão: 1.

Comportamento do parâmetro:
- suportado se Mostrar legenda estiver definido como "Habilitado"
Número de colunas 0 legend_columns Os valores possíveis variam de 1-4.

Padrão: 4.

Comportamento do parâmetro:
- suportado se Mostrar legenda estiver definido como "Habilitado" e Mostrar valor estiver definido como "Desabilitado"

Exemplos

Os exemplos a seguir têm como objetivo apenas descrever a configuração dos objetos de campo do widget do dashboard para o widget Gráfico de pizza. Para obter mais informações sobre como configurar um dashboard, consulte dashboard.create.

Configurando um widget Pie chart

Configure um widget Pie chart da seguinte forma:

  • 2 conjuntos de dados para um total de 9 items em 1 host.
  • O primeiro conjunto de dados é do tipo "Lista de items" e consiste em 3 items, todos do tipo "Normal" e representados por uma cor diferente.
  • O segundo conjunto de dados é do tipo "Padrões de items", consiste em 6 items, possui uma agregação configurada para cada item e é representado por uma cor personalizada.
  • O segundo conjunto de dados também possui um rótulo de conjunto de dados personalizado.
  • Os dados no gráfico de pizza são exibidos como um gráfico de rosca com uma largura personalizada e valor total com unidades no centro.
  • Os dados no gráfico de pizza são exibidos e agregados para um período de tempo personalizado das últimas 3 horas.
  • A legenda do gráfico de pizza exibe os items configurados em 4 linhas.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "piechart",
                        "name": "Pie chart",
                        "x": 0,
                        "y": 0,
                        "width": 24,
                        "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": 0,
                                "name": "ds.0.type.0",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.1",
                                "value": 23269
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.1",
                                "value": "BF00FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.1",
                              "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.2",
                                "value": 23257
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.2",
                                "value": "0040FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.2",
                              "value": 0
                            },
                            {
                                "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.aggregate_function",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "ds.1.data_set_label",
                                "value": "Number of processed values per second"
                            },
                            {
                                "type": 0,
                                "name": "draw_type",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "width",
                                "value": 30
                            },
                            {
                                "type": 0,
                                "name": "total_show",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "units_show",
                                "value": 1
                            },
                            {
                                "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_lines",
                                "value": 4
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Veja também