3 Scripts

Visão geral

Na seção Alertas > Scripts, é possível configurar e manter scripts globais definidos pelo usuário.

Este menu está disponível somente para usuários do tipo SuperAdmin.

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

• No menu do host, em vários locais do frontend (Dashboard, Problemas, Dados mais recentes, Mapas etc.).
• No menu de eventos.
• Podem ser executados como uma operação de uma ação.

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

Tanto no Zabbix agent quanto no Zabbix proxy, os scripts remotos são desabilitados por padrão. Eles podem ser habilitados da seguinte forma:

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

A execução de scripts globais no Zabbix server 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 Zabbix server é desabilitada por padrão.

É exibida uma lista dos scripts existentes com seus detalhes.

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:

• Delete - excluir os scripts

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

Usando o filtro

Você pode usar o filtro para exibir apenas os scripts de seu interesse. Para melhor desempenho na pesquisa, os dados são pesquisados com macros não resolvidos.

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

Configurando um script global

Atributos do script:

Configuração avançada

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

Se a entrada manual do usuário e uma mensagem de confirmação estiverem configuradas, elas serão exibidas em janelas pop-up 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 de 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 do host' ou 'Ação manual do 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 concluído com sucesso (código de saída 0), o valor de retorno é limitado a 16 MB (incluindo espaços em branco à direita, que são truncados).
• Se o script sair com erro (código de saída diferente de zero), o valor de retorno é um erro padrão limitado a 2 KB.

Por padrão, o Zabbix não armazena a saída estendida do script. 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 no Zabbix proxy, os limites do banco de dados também se aplicam.

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

uname -v
/tmp/non_existing_script.sh
echo "This script was started by {USER.USERNAME}"

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

Tempo limite de script no Zabbix agent

Você pode se deparar com uma situação em que ocorre um tempo limite durante a execução de um script.

Veja abaixo um exemplo de um script em execução 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, é recomendável otimizar o próprio script (no exemplo acima, "5") em vez de ajustar o parâmetro Timeout em Zabbix agent configuration e Zabbix server configuration.

Caso o parâmetro Timeout tenha sido alterado em Zabbix agent configuration, a seguinte mensagem de erro será exibida:

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

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

Tempo limite de script em agents ativos

É possível executar scripts em agents que operam apenas no modo ativo. Depois que a execução do script é acionada pela operation da action ou pela execução manual do script, o comando é incluído na configuração de verificação ativa e executado assim que o active agent o recebe.

Scripts manuais são enviados ao active agent juntamente com o timeout do server/proxy para execução do script. Aumente o timeout padrão do server/proxy para execução do script. O timeout deve ser maior que a frequência de atualização da verificação ativa; caso contrário, o timeout será excedido antes que o active agent receba o script e consiga retornar o resultado.

Tempo limite do script no Zabbix server/proxy

Veja um exemplo de um script em execução no Zabbix server e a janela de resultado abaixo:

sleep 11
df -h

Também é recomendá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).