3 Scripts

Visão geral

Na seção Alertas → Scripts, scripts globais definidos pelo usuário podem ser configurados e mantidos.

Scripts globais, dependendo do escopo configurado e também das permissões do usuário, estão disponíveis para execução:

• a partir do menu de host em vários locais do frontend (Dashboard, Problemas, Últimos dados, Mapas, etc.)
• a partir do menu de evento
• podem ser executados como uma operação de ação

Os scripts são executados no agent Zabbix, server Zabbix (proxy) ou apenas no server Zabbix. Veja também Execução de comandos.

Tanto no agent Zabbix quanto no proxy Zabbix, scripts remotos estão desabilitados por padrão. Eles podem ser habilitados por:

• Para comandos remotos executados no agent Zabbix:
  • adicionando um parâmetro AllowKey=system.run[<comando>,*] para cada comando permitido na configuração do agent, * representa o modo wait e nowait;
• Para comandos remotos executados no proxy Zabbix:
  • Atenção: Não é necessário habilitar comandos remotos no proxy Zabbix se os comandos remotos forem executados no agent Zabbix que é monitorado pelo proxy Zabbix. Se, no entanto, for necessário executar comandos remotos no proxy Zabbix, defina o parâmetro EnableRemoteCommands como '1' na configuração do proxy.

A execução de scripts globais no server Zabbix pode ser desabilitada definindo EnableGlobalScripts=0 na configuração do server. Para novas instalações, desde o Zabbix 7.0, a execução de scripts globais no server Zabbix está desabilitada por padrão.

Uma lista dos scripts existentes com seus detalhes é exibida.

Dados exibidos:

Para configurar um novo script, clique no botão Criar script no canto superior direito.

Opções de edição em massa

Um botão abaixo da lista oferece uma opção de edição em massa:

• Excluir - exclui os scripts

Para usar esta opção, marque as caixas de seleção antes dos respectivos scripts e clique em Excluir.

Usando o filtro

Você pode usar o filtro para exibir apenas os scripts que lhe interessam. Para melhor desempenho de pesquisa, os dados são pesquisados com macros não resolvidas.

O link Filtro está disponível acima da lista de scripts. Se você clicar nele, um filtro ficará disponível onde você pode filtrar scripts por nome e escopo.

Configurando um script global

Atributos do script:

Configuração avançada

Opções de configuração avançada estão disponíveis em uma seção recolhível Configuração avançada:

Se tanto a entrada manual do usuário quanto uma mensagem de confirmação forem configuradas, elas serão exibidas em janelas popup consecutivas.

Entrada manual do usuário

A entrada manual do usuário permite fornecer um parâmetro personalizado a cada execução do script. Isso elimina a necessidade de criar vários scripts de usuário semelhantes com apenas uma diferença de parâmetro.

Por exemplo, você pode querer fornecer um número inteiro diferente ou um endereço de URL diferente para o script durante a execução.

Para habilitar a entrada manual do usuário:

• use a macro {MANUALINPUT} no script (comandos, script, parâmetro do script) onde necessário; ou no campo URL de scripts de URL;
• na configuração avançada do script, habilite a entrada manual do usuário e configure as opções de entrada.

Com a entrada do usuário habilitada, antes da execução do script, um popup Entrada manual aparecerá para o usuário solicitando o fornecimento de um valor personalizado. O valor fornecido substituirá {MANUALINPUT} no script.

Dependendo da configuração, o usuário será solicitado a inserir um valor de string:

Ou selecionar o valor em uma lista suspensa de opções predefinidas:

A entrada manual do usuário está disponível apenas para scripts cujo escopo seja 'Ação manual de host' ou 'Ação manual de evento'.

Execução do script e resultado

Os scripts executados pelo Zabbix server são executados na ordem descrita na página de execução de comandos.

O resultado do script é exibido em uma janela pop-up que aparece após a execução do script. O valor de retorno do script é uma saída padrão:

• Se o script for finalizado com sucesso (código de saída 0), o valor de retorno é limitado a 16MB (incluindo espaços em branco à direita, que são truncados).
• Se o script for finalizado com erro (código de saída diferente de zero), o valor de retorno é um erro padrão limitado a 2KB.

O Zabbix não armazena a saída estendida do script por padrão. Para preservar todos os detalhes da saída, você pode implementar o registro de logs dentro do próprio script (por exemplo, redirecionando a saída para um arquivo de log local).

Observe que, para scripts executados no Zabbix server ou Zabbix proxy, os limites do banco de dados também se aplicam.

Abaixo está um exemplo de script e a janela de resultado:

uname -v
       /tmp/non_existing_script.sh
       echo "Este script foi iniciado por {USER.USERNAME}"

O resultado do script não exibe o próprio script.

Tempo limite do script

Zabbix agent

Você pode se deparar com uma situação em que ocorre um timeout ao executar um script.

Veja abaixo um exemplo de script rodando no Zabbix agent e a janela de resultado:

sleep 5
       df -h

A mensagem de erro, neste caso, é a seguinte:

Timeout while executing a shell script.

Para evitar tais situações, é aconselhável otimizar o próprio script (no exemplo acima, "5") em vez de ajustar o parâmetro Timeout na configuração do Zabbix agent e na configuração do Zabbix server. No entanto, para o Zabbix agent em modo ativo, o parâmetro Timeout na configuração do Zabbix server deve ser pelo menos alguns segundos maior que o parâmetro RefreshActiveChecks na configuração do Zabbix agent. Isso garante que o server tenha tempo suficiente para receber os resultados das checagens ativas do agent. Observe que a execução de scripts em agent ativo é suportada a partir do Zabbix agent 7.0.

Caso o parâmetro Timeout tenha sido alterado na configuração do Zabbix agent, a seguinte mensagem de erro aparecerá:

Get value from agent failed: ZBX_TCP_READ() timed out.

Isso significa que a modificação foi feita na configuração do Zabbix agent, mas é necessário modificar também o parâmetro Timeout na configuração do Zabbix server.

Zabbix server/proxy

Veja um exemplo de script rodando no Zabbix server e a janela de resultado abaixo:

sleep 11
       df -h

Também é aconselhável otimizar o próprio script (em vez de ajustar o parâmetro TrapperTimeout para um valor correspondente (no nosso caso, > 11) modificando a configuração do Zabbix server).