Templates

Visão geral

Templates são exportados com muitos objetos relacionados e relações entre objetos.

A exportação de template contém:

• Grupos de template vinculados
• Grupos de host vinculados (se usados na configuração de host prototype)
• Dados do template
• Vinculação a outros templates
• Vinculação a grupos de template
• items vinculados diretamente
• triggers vinculados diretamente
• gráficos vinculados diretamente
• dashboards vinculados diretamente
• regras de descoberta vinculadas diretamente com todos os prototypes
• cenários web vinculados diretamente
• mapas de valor

Exportando

Para exportar templates, faça o seguinte:

1. Acesse Data collection > Templates.
2. Marque as caixas de seleção dos templates a serem exportados.
3. Clique em Export abaixo da lista.

Dependendo do formato selecionado, os templates são exportados para um arquivo local com um nome padrão:

• zabbix_export_templates.yaml - na exportação YAML (opção padrão para exportação);
• zabbix_export_templates.xml - na exportação XML;
• zabbix_export_templates.json - na exportação JSON.

Importando

Para importar templates, faça o seguinte:

1. Vá para Coleta de dados > Templates.
2. Clique em Importar no canto superior direito.
3. Selecione o arquivo de importação.
4. Clique em Importar no canto inferior direito do formulário de configuração.

Se você marcar a caixa de seleção Opções avançadas, uma lista detalhada de todos os elementos importáveis será exibida - marque ou desmarque cada regra de importação conforme necessário.

Se você clicar na caixa de seleção na linha Todos, todos os elementos abaixo dela serão marcados/desmarcados.

Regras de importação:

Na próxima tela, você poderá visualizar o conteúdo de um template sendo importado. Se for um novo template, todos os elementos serão listados em verde. Se estiver atualizando um template existente, os novos elementos do template serão destacados em verde; os elementos removidos do template serão destacados em vermelho; os elementos que não foram alterados serão listados em um fundo cinza.

O menu à esquerda pode ser usado para navegar pela lista de alterações. A seção Atualizado destaca todas as alterações feitas nos elementos existentes do template. A seção Adicionado lista os novos elementos do template. Os elementos em cada seção são agrupados por tipo de elemento; clique na seta cinza para expandir ou recolher o grupo de elementos.

Revise as alterações do template e, em seguida, clique em Importar para executar a importação do template. Uma mensagem de sucesso ou falha da importação será exibida no frontend.

Formato de exportação

Quando um template é exportado, o Zabbix gera um formato estruturado em YAML, JSON ou XML. A exportação inclui elementos do template, como metadados do template, items, macros, triggers, dashboards e outros.

Cada elemento tem uma finalidade específica e pode conter elementos aninhados.

As seções a seguir descrevem cada elemento no formato de exportação. Os exemplos usam o template Linux by Zabbix agent.

Uma reticência (...) indica elementos omitidos por brevidade. A observação (see table below) é usada quando o elemento é explicado com mais detalhes em seções posteriores.

Metadados do template

zabbix_export:
  version: '8.0'
  template_groups:
    - uuid: 846977d1dfed4968bc5f8bdb363285bc
      name: 'Templates/Operating systems'
  templates: (see table below)
  triggers: (see table below)
  graphs: (see table below)

Templates

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      template: 'Linux by Zabbix agent'
      name: 'Linux by Zabbix agent'
      description: |
        Este é um template oficial do Linux. Requer Zabbix agent 8.0 ou mais recente. (...)
      wizard_ready: 'YES'
      readme: |
        ## Visão geral

        Este é um template oficial do Linux. Requer Zabbix agent 8.0 ou mais recente. (...)
      vendor:
        name: Zabbix
        version: 8.0-2
      groups:
        - name: 'Templates/Sistemas operacionais'
      items: (veja a tabela abaixo)
      discovery_rules: (veja a tabela abaixo)
      tags:
        - tag: class
          value: os
        - tag: target
          value: linux
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          value: 3m
          description: 'Tempo limite após o qual o agent é considerado indisponível. Funciona apenas para agents acessíveis a partir do server/proxy do Zabbix (modo passivo).'
          config: (veja a tabela abaixo)
        - macro: '{$CPU.UTIL.CRIT}'
          value: '90'
          description: 'Limite crítico de utilização da CPU expresso em %.'
          config: (veja a tabela abaixo)
        (...)
      dashboards: (veja a tabela abaixo)
      valuemaps: (veja a tabela abaixo)
    (...)

Itens do template

zabbix_export:
  (...)
  templates:
    (...)
      items:
        - uuid: f94f9f4699e94c369e6c98b2a2f485ce
          name: 'Zabbix agent ping'
          key: agent.ping
          description: 'O agent sempre retorna "1" para este item. Pode ser usado em combinação com `nodata()` para a verificação de disponibilidade.'
          valuemap:
            name: 'Zabbix agent ping status'
          tags:
            - tag: component
              value: system
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          name: 'Número de pacotes instalados'
          key: system.sw.packages.get
          delay: 1h
          preprocessing: (veja a tabela abaixo)
          tags:
            - tag: component
              value: os
          triggers: (veja a tabela abaixo)
        - uuid: 403cebed115441369e94d35d070ca7b8
          name: 'Utilização de memória'
          type: DEPENDENT
          key: vm.memory.utilization
          value_type: FLOAT
          units: '%'
          description: 'A porcentagem de memória usada é calculada como `100-pavailable`.'
          preprocessing: (veja a tabela abaixo)
          master_item:
            key: 'vm.memory.size[pavailable]'
          tags:
            - tag: component
              value: memory
          triggers: (veja a tabela abaixo)
        (...)

Etapas de pré-processamento do valor do item do template

zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          preprocessing:
            - type: JSONPATH
              parameters:
                - $.length()
            - type: DISCARD_UNCHANGED_HEARTBEAT
              parameters:
                - 12h
          (...)

Triggers de item de template

zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          triggers:
            - uuid: b950c306394f4b3c902060a8273cbcde
              expression: 'change(/Linux by Zabbix agent/system.sw.packages.get)<>0'
              name: 'Linux: Number of installed packages has been changed'
              priority: WARNING
              manual_close: 'YES'
              tags:
                - tag: scope
                  value: notice
        (...)
        - uuid: 403cebed115441369e94d35d070ca7b8
          (...)
          triggers:
            - uuid: cfd395b1cde74ef18a5e5f840bd5142a
              expression: 'min(/Linux by Zabbix agent/vm.memory.utilization,5m)>{$MEMORY.UTIL.MAX}'
              name: 'Linux: High memory utilization'
              event_name: 'Linux: High memory utilization (>{$MEMORY.UTIL.MAX}% for 5m)'
              priority: AVERAGE
              description: 'The system is running out of free memory.'
              dependencies:
                - name: 'Linux: Lack of available memory'
                  expression: 'max(/Linux by Zabbix agent/vm.memory.size[available],5m)<{$MEMORY.AVAILABLE.MIN} and last(/Linux by Zabbix agent/vm.memory.size[total])>0'
              tags:
                - tag: scope
                  value: capacity
                - tag: scope
                  value: performance
        (...)

Regras de descoberta de baixo nível de template

zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          name: 'Network interface discovery'
          key: net.if.discovery
          delay: 1h
          filter: (see table below)
          description: 'A descoberta de interfaces de rede.'
          item_prototypes: (see table below)
          trigger_prototypes: (see table below)
          graph_prototypes: (see table below)
        (...)

Filtros da regra de descoberta de baixo nível do template

zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.MATCHES}'
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
          (...)
        - uuid: 2bbdc79f082d4c618e01bec625e9c90a
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.MATCHES}'
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
              - macro: '{#DEVTYPE}'
                value: disk
          (...)

Operações de override da regra de descoberta de baixo nível do template

Cenários web do template

Etapas do cenário web do template

Configuração de macro de template

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      (...)
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          (...)
          config:
            type: TEXT
            priority: '1'
            label: 'Segundos desde a última vez que o agent foi visto'
            description: 'Tempo limite após o qual o agent é considerado indisponível.'
        - macro: '{$CPU.UTIL.CRIT}'
          (...)
          config:
            type: TEXT
            priority: '2'
            section_name: Thresholds
            label: 'Limite de utilização de CPU expresso'
            description: 'Limite crítico de utilização de CPU expresso em %. No intervalo de 0 a 100, inclusive.'
            regex: '^-?([0-9]+|(([0-9]+)\.([0-9]+)))$'
        (...)
        - macro: '{$IFCONTROL}'
          (...)
          config:
            type: CHECKBOX
            priority: '19'
            label: 'Controle de interfaces'
            description: 'Dispara um trigger quando o status operacional da interface muda para "Link down".'
            options:
              - checked: '1'
                unchecked: '0'
        (...)

Dashboards de template

zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              widgets: (veja a tabela abaixo)
        (...)

Widgets do dashboard do template

zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              widgets:
                - type: graphprototype
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '3'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})]: Gráfico de utilização de espaço (relativo ao total)'
                    - type: STRING
                      name: reference
                      value: AAAEB
                - type: graphprototype
                  'y': '5'
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '1'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})]: Gráfico de uso de espaço, em %, (relativo ao máximo disponível)'
                    - type: STRING
                      name: reference
                      value: AAAEC
        (...)

Mapas de valores do template

zabbix_export:
  (...)
  templates:
    (...)
      valuemaps:
        - uuid: 8c048c6cca8248f2860c208e8db0f59e
          name: ifOperStatus
          mappings:
            - value: '0'
              newvalue: unknown
            - value: '1'
              newvalue: notpresent
            - value: '2'
              newvalue: down
            - value: '3'
              newvalue: lowerlayerdown
            - value: '4'
              newvalue: testing
            - value: '5'
              newvalue: dormant
            - value: '6'
              newvalue: up
        (...)

Notas de rodapé

¹ Valores inteiros da API entre parênteses, por exemplo, ENABLED (0), são mencionados apenas para referência. Para mais informações, consulte a página do objeto da API vinculada na entrada da tabela ou no final de cada seção.