14 Plugins

Visão geral

Os plugins fornecem uma opção para estender as capacidades de monitoramento do Zabbix. Os plugins são escritos na linguagem de programação Go e são suportados apenas pelo agente Zabbix 2.

Os plugins oferecem uma alternativa aos módulos loadable modules (escritos em C), e outros métodos para estender a funcionalidade do Zabbix, como parâmetros do usuários user parameters (métricas do agente), external checks (monitoramento sem agente), e o item do agente do Zabbix system.run[] agent item.

As seguintes características são específicas do agente Zabbix 2 e de seus plugins:

• suporte a intervalos programados e flexíveis para verificações tanto passivas quanto ativas;;
• gerenciamento da fila de tarefas com relação ao cronograma e à concorrência de tarefas;
• timeouts no nível do plugin;
• verificação de compatibilidade do agente Zabbix 2 e seu plugin na inicialização..

Desde o Zabbix 6.0.0, os plugins não precisam ser integrados diretamente ao agente 2 e podem ser adicionados como plugins carregáveis, tornando assim o processo de criação de plugins adicionais para coletar novas métricas de monitoramento mais fácil.

Esta página lista os plugins nativos e carregáveis do Zabbix e descreve os princípios de configuração do plugin do ponto de vista do usuário. Para instruções sobre como escrever seus próprios plugins, consulte Plugin development guidelines. Para obter mais informações sobre o processo de comunicação entre o agente Zabbix 2 e um plugin carregável, bem como o processo de coleta de métricas, consulte Connection diagram.

Configurando plugins

Esta seção fornece princípios de configuração comuns e melhores práticas para plugins

Todos os parâmetros são configurados usando o parâmetro Plugins.* parameter, que pode fazer parte do Zabbix agent 2 configuration file ou do próprio plugin configuration file.Se um plugin usar um arquivo de configuração separado, o caminho para este arquivo deve ser especificado no parâmetro Include do arquivo de configuração do agente Zabbix 2.

Um parâmetro típico do plugin tem a seguinte estrutura: Plugins.<PluginName>.<Parameter>=<Value>

Além disso, existem dois grupos específicos de parâmetros:

• Plugins.<PluginName>.Default.<Parameter>=<Value> usado para definir default parameter values.

• Plugins.<PluginName>.<SessionName>.<Parameter>=<Value> ususado para definir conjuntos separados de parâmetros para diferentes alvos de monitoramento através de named sessions.

Todos os nomes de parâmetros devem seguir os seguintes requisitos:

• é recomendado que os nomes de seus plugins sejam capitalizados;
• o parâmetro deve ser capitalizado;
• caracteres especiais não são permitidos;
• aninhamento não está limitado por um nível máximo;
• o número de parâmetros não é limitado.

Sessões nomeadas

As sessões nomeadas representam um nível adicional de parâmetros de plugin e podem ser usadas para especificar conjuntos separados de parâmetros de autenticação para cada uma das instâncias sendo monitoradas. Cada parâmetro de sessão nomeada deve ter a seguinte estrutura:

Plugins.<PluginName>.Sessions.<SessionName>.<Parameter>=<Value>

Um nome de sessão pode ser usado como um parâmetro de item chave connString em vez de especificar um URI, nome de usuário e/ou senha separadamente.

Nos parâmetros de chave de item, o primeiro parâmetro pode ser um connString ou uma URI. Se o primeiro parâmetro da chave não corresponder a nenhum nome de sessão, ele será tratado como um URI. Note que embutir credenciais em um URI não é suportado, use parâmetros de sessão nomeada em seu lugar.

Essa lista named session parameters disponível depende do plugin.

No Zabbix antes da versão 6.0.17, ao fornecer um connString (nome da sessão) nos parâmetros da chave do item, os parâmetros do nome de usuário e senha devem estar vazios. Os valores serão retirados dos parâmetros da sessão. Se um parâmetro de autenticação não for especificado para a sessão nomeada, um valor padrão fixo será usado.

Desde o Zabbix 6.0.17, é possível substituir os parâmetros da sessão especificando novos valores nos parâmetros da chave do item (consulte example).

Desde o Zabbix 6.0.18, se um parâmetro não estiver definido para a sessão nomeada, Zabbix agent 2 usará o valor definido no parâmetro padrão de login default plugin parameter.

Prioridade de parâmetro

Desde a versão 6.0.18, os plugins do Zabbix agent 2 procuram por valores de parâmetros relacionados à conexão na seguinte ordem:

1. O primeiro parâmetro da chave do item é comparado com os nomes das sessões. Se nenhuma correspondência for encontrada, ele será tratado como um valor real; neste caso, a etapa 3 será ignorada. Se uma correspondência for encontrada, o valor do parâmetro (geralmente, um URI) deve ser definido na sessão nomeada.
2. Outros parâmetros serão retirados da chave do item se estiverem definidos.
3. Se um parâmetro da chave do item (por exemplo, senha) estiver vazio, o plugin procurará pelo parâmetro de sessão nomeada correspondente.
4. Se o parâmetro da sessão também não estiver especificado, o valor definido no parâmetro padrão correspondente default parameter será usado.
5. Se tudo falhar, o plugin usará o valor padrão codificado.

Exemplo 1

Monitoramento de duas instâncias “MySQL1” e “MySQL2”.

Parâmetros de configuração:

Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
       Plugins.Mysql.Sessions.MySQL1.User=mysql1_user
       Plugins.Mysql.Sessions.MySQL1.Password=unique_password
       Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.0:3306
       Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
       Plugins.Mysql.Sessions.MySQL2.Password=different_password

Como resultado desta configuração, cada nome da sessão pode ser usado como um connString em uma item key, por exemplo, mysql.ping[MySQL1] oi mysql.ping[MySQL2].

Exemplo 2

Fornecendo alguns dos parâmetros da chave do item (suportado desde o Zabbix 6.0.17).

Parâmetros de configuração:

Plugins.PostgreSQL.Sessions.Session1.Uri=tcp://192.0.2.234:5432
       Plugins.PostgreSQL.Sessions.Session1.User=old_username
       Plugins.PostgreSQL.Sessions.Session1.Password=session_password

Item key: pgsql.ping[session1,new_username,,postgres]

Como resultado desta configuração, o agente se conectará ao PostgreSQL usando os seguintes parâmetros:

• URI do parâmetro da sessão: 192.0.2.234:5432
• Nome de usuário da chave do item: new_username
• Senha do parâmetro da sessão (já que é omitida na chave do item): session_password
• Nome do banco de dados da chave do item: postgres

Exemplo 3

Colectando uma métrica usando parâmetros de configuração padrão:

Parâmetros de configuração:

Plugins.PostgreSQL.Default.Uri=tcp://192.0.2.234:5432
       Plugins.PostgreSQL.Default.User=zabbix
       Plugins.PostgreSQL.Default.Password=password

Item key: pgsql.ping[,,,postgres]

Como resultado desta configuração, o agente se conectará ao PostgreSQL usando os seguintes parâmetros:

• URI padrão: 192.0.2.234:5432
• Nome de usuário padrão: zabbix
• Senha padrão: password
• Nome do banco de dados da chave do item: postgres

Valores padrão

Desde o Zabbix 6.0.18, você pode definir valores padrão para os parâmetros relacionados à conexão (URI, nome de usuário, senha, etc.) no arquivo de configuração no formato:

Plugins.<PluginName>.Default.<Parameter>=<Value>

Por exemplo, Plugins.Mysql.Default.Username=zabbix, Plugins.MongoDB.Default.Uri=tcp://127.0.0.1:27017, etc.

Se um valor para tal parâmetro não for fornecido em uma chave de item ou nos parâmetros da named session, plugin usará o valor padrão. Se um parâmetro padrão também não estiver definido, serão usados valores padrão codificados.

Conexões

Alguns plugins suportam a coleta de métricas de várias instâncias simultaneamente. Tanto instâncias locais quanto remotas podem ser monitoradas. Conexões TCP e Unix-socket são suportadas.

É recomendável configurar os plugins para manter as conexões com as instâncias em um estado aberto. Os benefícios incluem redução de congestionamento de rede, latência e uso de CPU e memória devido ao menor número de conexões. A biblioteca do cliente cuida disso.

Plugins

Todas as métricas suportada pelo Zabbix agent 2 são coletadas pelos plugins.

Integrados

Os seguintes plugins para o agente Zabbix 2 estão disponíveis e prontos para uso. Clique no nome do plugin para acessar o repositório do plugin com informações adicionais.

Carregável

Clique no nome do plugin para acessar o repositório do plugin com informações adicionais.

Consulte também: Building loadable plugins.

Notas de rodapé

¹ - Desde o Zabbix 6.0.13, os plugins carregáveis começaram a usar o mesmo sistema de versionamento que o próprio Zabbix. Como resultado, a versão do plugin MongoDB plugin mudou de 1.2.0 para 6.0.13 e a versão PostgreSQL plugin mudou de 1.2.1 para 6.0.13.