4 Agente Zabbix 2 (UNIX)

Visão geral

O Zabbix agent 2 é uma nova geração do Zabbix agent e pode ser usado no lugar do Zabbix agent.

Os parâmetros compatíveis com o arquivo de configuração do Zabbix agent 2 (zabbix_agent2.conf) estão listados nesta seção.

Os parâmetros são listados sem informações adicionais. Clique no parâmetro para ver todos os detalhes. Clique no parâmetro para ver todos os detalhes.

Todos os parâmetros são não obrigatórios, a menos que seja explicitamente indicado que o parâmetro é obrigatório.

Observe que:

• Os valores padrão refletem os padrões do processo, não os valores dos arquivos de configuração fornecidos.
• O Zabbix oferece suporte apenas a arquivos de configuração codificados em UTF-8 sem BOM.
• Comentários iniciados com # são compatíveis apenas no início da linha.

Detalhes do parâmetro

Alias

Define um alias para uma chave de item. Ele pode ser usado para substituir uma chave de item longa e complexa por uma mais curta e simples.
Vários parâmetros Alias podem estar presentes. Não são permitidos vários parâmetros com a mesma chave Alias.
Diferentes chaves Alias podem referenciar a mesma chave de item.
Aliases podem ser usados em HostMetadataItem, mas não no parâmetro HostnameItem.

Exemplo 1: Recuperando o ID do usuário zabbix.

Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]

Agora a chave abreviada zabbix.userid pode ser usada para recuperar dados.

Exemplo 2: Obtendo a utilização de CPU com parâmetros padrão e personalizados.

Alias=cpu.util:system.cpu.util
Alias=cpu.util[*]:system.cpu.util[*]

Isso permite usar a chave cpu.util para obter a porcentagem de utilização de CPU com parâmetros padrão, bem como usar cpu.util[all, idle, avg15] para obter dados específicos sobre a utilização de CPU.

Exemplo 3: Executando várias regras de descoberta em baixo nível processando os mesmos itens descobertos.

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

Agora é possível configurar várias regras de descoberta usando vfs.fs.discovery com parâmetros diferentes para cada regra, por exemplo, vfs.fs.discovery[foo], vfs.fs.discovery[bar], etc.

AllowKey

Permite a execução daqueles item keys que correspondem a um padrão. O padrão da key é uma expressão curinga que suporta o caractere * para corresponder a qualquer número de quaisquer caracteres.
Várias regras de correspondência de key podem ser definidas em combinação com DenyKey. Os parâmetros são processados um por um de acordo com a ordem em que aparecem. Veja também: Restricting agent checks.

BufferSend

O intervalo de tempo em segundos que determina com que frequência os valores são enviados do buffer para o Zabbix server. Observe que, se o buffer estiver cheio, os dados serão enviados mais cedo.

Padrão: 5
Intervalo: 1-3600

BufferSize

O número máximo de valores no buffer de memória. O agent enviará todos os dados coletados para o server ou proxy do Zabbix se o buffer estiver cheio. Este parâmetro deve ser usado somente se o buffer persistente estiver desativado (EnablePersistentBuffer=0).

Padrão: 1000
Intervalo: 2-65535

ControlSocket

O socket de controle, usado para enviar comandos em tempo de execução com a opção -R.

Padrão: /tmp/agent.sock

DebugLevel

Especifique o nível de depuração:

• 0 - informações básicas sobre o início e a parada dos processos do Zabbix;
• 1 - informações críticas;
• 2 - informações de erro;
• 3 - avisos;
• 4 - para depuração (produz muitas informações);
• 5 - depuração estendida (produz ainda mais informações).

Padrão: 3
Intervalo: 0-5

DenyKey

Negue a execução das chaves de item que correspondam a um padrão.
O padrão da chave é uma expressão curinga que suporta o caractere * para corresponder a qualquer número de quaisquer caracteres.
Várias regras de correspondência de chaves podem ser definidas em combinação com AllowKey. Os parâmetros são processados um a um de acordo com a ordem em que aparecem. Veja também: Restricting agent checks.

EnablePersistentBuffer

Habilita o uso de armazenamento persistente local para items ativos. Se o armazenamento persistente estiver desabilitado, o buffer de memória será usado.

Padrão: 0
Valores: 0 - desabilitado, 1 - habilitado

EnableProfiler

Habilita a criação periódica de perfis do Go na inicialização do agent. A criação de perfis também pode ser habilitada ou desabilitada em tempo de execução usando a opção -R. Enquanto periodic_prof_execute estiver coletando perfis, todos os comandos de tempo de execução do profiler serão rejeitados, pois ele estará ocupado. Este parâmetro é compatível a partir do Zabbix 7.0.31.

Padrão: 0
Valores: 0 - desabilitado, 1 - habilitado

ForceActiveChecksOnStart

Executa verificações ativas imediatamente após a reinicialização para a primeira configuração recebida. Também disponível como um parâmetro de configuração por plugin, por exemplo: Plugins.Uptime.System.ForceActiveChecksOnStart=1

Padrão: 0
Valores: 0 - desabilitado, 1 - habilitado

HeartbeatFrequency

A frequência das mensagens de heartbeat em segundos. Usado para monitorar a disponibilidade de verificações ativas.
0 - mensagens de heartbeat desabilitadas.

Padrão: 60
Intervalo: 0-3600

HostInterface

Um parâmetro opcional que define a interface do host (endereço IP ou nome DNS) usada durante o processo de autoregistration do host. Esse valor será usado para preencher a interface no host recém-criado e permite configurar explicitamente um endereço IP ou DNS. Para mais detalhes, consulte Using DNS as default interface.

Se não for definido, o valor será obtido de HostInterfaceItem.

O agent emitirá um erro e não será iniciado se o valor ultrapassar o limite de 255 caracteres.

Faixa: 0-255 caracteres

HostInterfaceItem

Um parâmetro opcional que define um item usado para determinar a interface do host (endereço IP ou nome DNS) durante o processo de autoregistro do host. Esse valor é usado somente se HostInterface não estiver definido. Para mais detalhes, consulte Using DNS as default interface.

Durante uma solicitação de autoregistro, o agent registrará uma mensagem de aviso se o valor retornado pelo item especificado exceder o limite de 255 caracteres.

O item system.run[] é suportado independentemente das configurações AllowKey/DenyKey.

HostMetadata

Um parâmetro opcional que define os metadados usados para identificar ou distinguir o host durante o processo de autoregistration do host. HostMetadata permite distinguir entre hosts além do hostname.

Se não for definido, o valor será obtido de HostMetadataItem.

O agent emitirá um erro e não será iniciado se o valor especificado exceder o limite de 2034 bytes ou for uma string não UTF-8. Quando um parâmetro espera um endereço IP ou nome DNS, valores que sejam UTF-8 válidos, mas não sejam IPs ou nomes DNS válidos, também serão rejeitados e informados como inválidos.

Metadados com várias linhas não são suportados — a saída será truncada na primeira quebra de linha.

Intervalo: 0-2034 bytes

HostMetadataItem

Um parâmetro opcional que define um item do Zabbix agent usado para obter metadados do host. Esta opção é usada somente quando HostMetadata não está definido.

O valor de HostMetadataItem é recuperado em cada tentativa de autoregistro e é usado apenas no processo de autoregistro do host. HostMetadataItem permite distinguir entre hosts além do hostname.

Parâmetros de usuário e aliases são suportados. O item system.run[] é suportado независимо de configurações de AllowKey/DenyKey.

Durante uma solicitação de autoregistro, o agent registrará uma mensagem de aviso se o valor retornado pelo item especificado exceder o limite de 65535 pontos de código UTF-8. O valor retornado pelo item deve ser uma string UTF-8; caso contrário, será ignorado. Quando um parâmetro espera um endereço IP ou nome DNS, valores que sejam válidos em UTF-8, mas não sejam IPs ou nomes DNS válidos, também serão rejeitados e reportados como inválidos.

Metadados com várias linhas não são suportados — a saída será truncada na primeira quebra de linha.

Nome do host

Uma lista de nomes de host exclusivos, sensíveis a maiúsculas e minúsculas, separados por vírgulas. Obrigatório para verificações ativas e deve corresponder aos nomes de host configurados no server. O valor é obtido de HostnameItem se não estiver definido.
Caracteres permitidos: alfanuméricos, '.', ' ', '_' e '-'. Comprimento máximo: 128 caracteres por nome de host, 2048 caracteres para a linha inteira.

Padrão: definido por HostnameItem

HostnameItem

Um parâmetro opcional que define um item usado para obter o nome do host. Esta opção é usada somente quando Hostname não está definido. Parâmetros de usuário ou aliases não são suportados, mas o item system.run[] é suportado independentemente dos valores de AllowKey/DenyKey.

Padrão: system.hostname

Include

Especifique um diretório ou arquivos individuais a serem incluídos no arquivo de configuração.
Durante a instalação do Zabbix, esse parâmetro é definido como /usr/local/etc, a menos que você o altere durante a compilação.

Regras gerais para o parâmetro Include:

• O caminho pode ser relativo ao local do arquivo zabbix_agent2.conf.
• Você pode especificar vários parâmetros Include em um único arquivo de configuração.
• O Zabbix processa o parâmetro Include assim que o lê; portanto, considere colocá-lo no final do arquivo de configuração.

Regras para arquivos incluídos:

• Cada arquivo deve ser legível.
• Cada arquivo deve ter sintaxe correta. Caso contrário, o componente não será iniciado.

Regras para incluir diretórios ou padrões de arquivo:

• Não presuma nenhuma ordem de inclusão (por exemplo, os arquivos não são incluídos em ordem alfabética).
• Não defina o mesmo parâmetro em mais de um arquivo incluído (por exemplo, para substituir uma configuração geral por uma específica), pois não é possível prever qual valor será usado.
• Fique atento às cópias de backup que alguns editores de texto criam automaticamente (por exemplo, editar include/my_specific.conf pode criar include/my_specific.conf.BAK), pois ambos os arquivos serão incluídos.

Para incluir apenas os arquivos relevantes de um diretório, use o curinga (*) para correspondência de padrões.

Exemplo:

Include=/absolute/path/to/config/files/*.conf

ListenIP

Uma lista de endereços IP separados por vírgula nos quais o agent deve escutar. O primeiro endereço IP é enviado ao Zabbix server, se estiver conectando a ele, para recuperar a lista de verificações ativas.

Padrão: 0.0.0.0

ListenPort

O agente escutará nessa porta as conexões do servidor.

Padrão: 10050
Intervalo: 1024-32767

LogFile

O nome do arquivo de log.

Padrão: /tmp/zabbix_agent2.log
Obrigatório: Sim, se LogType estiver definido como file; caso contrário, não

LogFileSize

O tamanho máximo de um arquivo de log em MB.
0 - desativa a rotação automática de logs.
Nota: Se o limite de tamanho do arquivo de log for atingido e a rotação do arquivo falhar, por qualquer motivo, o arquivo de log existente será truncado e iniciado novamente.

Padrão: 1
Intervalo: 0-1024

LogType

O tipo da saída de log:

• file - grava o log no arquivo especificado pelo parâmetro LogFile;
• system - grava o log no syslog;
• console - grava o log na saída padrão.

Padrão: file

PersistentBufferFile

O arquivo no qual o Zabbix agent 2 deve manter o banco de dados SQLite. Deve ser um nome de arquivo completo. Esse parâmetro é usado somente se o buffer persistente estiver habilitado (EnablePersistentBuffer=1).

PersistentBufferPeriod

O período de tempo durante o qual os dados devem ser armazenados quando não houver conexão com o server ou proxy. Dados mais antigos serão perdidos. Dados de log serão preservados. Este parâmetro é usado somente se o buffer persistente estiver habilitado (EnablePersistentBuffer=1).

Padrão: 1h
Intervalo: 1m-365d

PidFile

O nome do arquivo PID.

Padrão: /tmp/zabbix_agent2.pid

Plugins.<PluginName>.System.Capacity

O limite de verificações do plugin <PluginName> que podem ser executadas simultaneamente.

Padrão: 1000 Intervalo: 1-1000

Plugins.Log.MaxLinesPerSecond

O número máximo de novas linhas que o agent enviará por segundo ao Zabbix server ou proxy ao processar verificações ativas log e logrt. O valor fornecido será substituído pelo parâmetro maxlines, informado na chave do item log e logrt.
Nota: O Zabbix processará 10 vezes mais novas linhas do que o definido em MaxLinesPerSecond para localizar a string necessária em itens de log.

Padrão: 20
Intervalo: 1-1000

Plugins.SystemRun.LogRemoteCommands

Ativa o registro dos comandos de shell executados como avisos.
Os comandos serão registrados somente se forem executados remotamente.
Entradas de log não serão criadas se system.run[] for iniciado localmente pelos parâmetros HostMetadataItem, HostInterfaceItem ou HostnameItem.

Padrão: 0
Valores: 0 - desativado, 1 - ativado

PluginSocket

O caminho para o soquete UNIX para comunicações de plug-in carregáveis.

Padrão: /tmp/agent.plugin.sock

PluginTimeout

O tempo limite para conexões com plug-ins carregáveis, em segundos.

Padrão: Timeout
Intervalo: 1-30

ProfilerDir

O diretório onde os dados de criação de perfil serão gravados. Este parâmetro é compatível a partir do Zabbix 7.0.31.

Padrão: /tmp/zabbix_agent2_profiles

ProfilerMaxFilesPerProfile

O número máximo de arquivos a serem mantidos para cada tipo de perfil. O limite é aplicado aos arquivos concluídos após cada despejo de perfil. O perfil de CPU ativo é coletado em um arquivo temporário oculto e não é contabilizado no limite. Os arquivos criados por periodic_prof_execute também estão sujeitos ao limite. Este parâmetro é compatível a partir do Zabbix 7.0.31.

Padrão: 10
Intervalo: 1-100

ProfilerInterval

O intervalo de gravação dos dados de criação de perfil, em segundos. Este parâmetro é compatível a partir do Zabbix 7.0.31.

Padrão: 3600
Intervalo: 1-86400

RefreshActiveChecks

Com que frequência a lista de verificações ativas é atualizada, em segundos. Observe que, após falhar ao atualizar as verificações ativas, a próxima atualização será tentada em 60 segundos.

Padrão: 5
Intervalo: 1-86400

Server

Uma lista de endereços IP separados por vírgulas, opcionalmente em notação CIDR, ou nomes DNS de servers Zabbix ou proxies Zabbix. As conexões de entrada serão aceitas somente dos hosts listados aqui. Se o suporte a IPv6 estiver habilitado, então 127.0.0.1, ::127.0.0.1, ::ffff:127.0.0.1 serão tratados igualmente e ::/0 permitirá qualquer endereço IPv4 ou IPv6. 0.0.0.0/0 pode ser usado para permitir qualquer endereço IPv4. Espaços são permitidos. Se este parâmetro não for especificado, as verificações passivas serão desativadas e o agent não escutará em nenhuma porta TCP.

Exemplo:

Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

ServerActive

O endereço do Zabbix server/proxy ou a configuração do cluster para obter verificações ativas. O endereço do server/proxy é um endereço IP ou nome DNS e uma porta opcional separada por dois pontos.
A configuração do cluster é um ou mais endereços de membros do grupo de server ou proxy separados por ponto e vírgula. Vários Zabbix servers/clusters e Zabbix proxies podem ser especificados, separados por vírgula. A menos que esteja usando grupos de proxy, não deve ser especificado mais de um Zabbix proxy de cada Zabbix server/cluster. Se um Zabbix proxy for especificado, o Zabbix server/cluster para esse proxy não deve ser especificado.
Vários endereços separados por vírgula podem ser fornecidos para usar vários Zabbix servers independentes em paralelo. Espaços são permitidos.
Se a porta não for especificada, a porta padrão será usada.
Endereços IPv6 devem ser colocados entre colchetes se a porta para esse host for especificada. Se a porta não for especificada, os colchetes para endereços IPv6 são opcionais.
Se este parâmetro não for especificado, as verificações ativas serão desativadas.

Exemplo para Zabbix proxy:

ServerActive=127.0.0.1:10051

Exemplo para grupo de Zabbix proxy:

ServerActive=proxy1.example.com;proxy2.example.com;proxy3.example.com;proxy4.example.com;proxy5.example.com

Exemplo para múltiplos servers:

ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]

Exemplo para alta disponibilidade:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3

Exemplo para alta disponibilidade com dois clusters e um server:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain

SourceIP

O endereço IP de origem para:

• conexões de saída para o Zabbix server ou Zabbix proxy.
• estabelecer conexões ao executar alguns items (web.page.get, net.tcp.port, etc.).

StatusPort

Se definido, o agente escutará nessa porta as solicitações de status HTTP (http://localhost:<port>/status).

Intervalo: 1024-32767

Timeout

Especifica quanto tempo esperar (em segundos) para estabelecer conexão e trocar dados com o Zabbix proxy ou server.

Este parâmetro define a duração de várias operações de comunicação, incluindo:

• aguardar uma resposta do Zabbix server;
• enviar solicitações ao Zabbix server, incluindo solicitações de configuração de item e dados de item em verificações ativas;
• recuperar dados de log através do logfile;
• enviar mensagens de heartbeat;
• duração máxima para verificações vfs.*;
• servir como fallback em cenários onde um server ou proxy anterior à versão 7.0 envia verificações sem timeouts.

Este timeout não será usado para aquelas verificações de agent que possuem configurações de timeout configuráveis no frontend (em nível global, proxy ou por item).

Padrão: 3
Intervalo: 1-30

TLSAccept

O nível de criptografia exigido para conexões de entrada. Usado para verificações passivas. Vários valores podem ser especificados, separados por vírgula:

• unencrypted - aceita conexões sem criptografia (padrão);
• psk - aceita conexões com TLS e uma chave pré-compartilhada (PSK);
• cert - aceita conexões com TLS e um certificado.

Obrigatório: sim, se os parâmetros de certificado TLS ou PSK estiverem definidos (mesmo para conexão unencrypted); caso contrário, não

TLSCAFile

O nome completo do caminho do arquivo que contém os certificados da(s) CA(s) de nível superior para verificação de certificados de pares, usados para comunicações criptografadas entre os componentes do Zabbix.

TLSCertFile

O nome completo do caminho do arquivo que contém o certificado do agente ou a cadeia de certificados, usado para comunicações criptografadas com os componentes do Zabbix.

TLSCipherAll

A string de cifra do OpenSSL (TLS 1.2). Substitui os critérios padrão de seleção de ciphersuite para criptografia baseada em certificado e PSK.

Exemplo:

EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128

Este parâmetro é suportado a partir do Zabbix 7.0.4.

TLSCipherAll13

A string de cifra do OpenSSL (TLS 1.3) para OpenSSL 1.1.1 ou mais recente. Substitui os critérios padrão de seleção de ciphersuite para criptografia baseada em certificado e PSK.

Exemplo:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

Este parâmetro é suportado desde o Zabbix 7.0.4.

TLSCipherCert

A string de cifra do OpenSSL (TLS 1.2). Substitui os critérios padrão de seleção de ciphersuite para criptografia baseada em certificado.

Exemplo:

EECDH+aRSA+AES128:RSA+aRSA+AES128

Observe que este parâmetro não pode ser usado junto com TLSAccept=cert,psk; para conexão por certificado (TLSConnect=cert) use TLSCipherAll.

Este parâmetro é suportado a partir do Zabbix 7.0.4.

TLSCipherCert13

A string de cifra do OpenSSL (TLS 1.3) para OpenSSL 1.1.1 ou mais recente. Substitui os critérios padrão de seleção de ciphersuite para criptografia baseada em certificado.

Observe que este parâmetro não pode ser usado junto com TLSAccept=cert,psk; para conexão por certificado (TLSConnect=cert) use TLSCipherAll13 em vez disso.

Este parâmetro é suportado desde o Zabbix 7.0.4.

TLSCipherPSK

A string de cifra do OpenSSL (TLS 1.2). Substitui os critérios de seleção do conjunto de cifras padrão para criptografia baseada em PSK.

Exemplo:

kECDHEPSK+AES128:kPSK+AES128

Este parâmetro é suportado a partir do Zabbix 7.0.4.

TLSCipherPSK13

A string de cifra do OpenSSL (TLS 1.3) para OpenSSL 1.1.1 ou mais recente. Substitui os critérios padrão de seleção de ciphersuite para criptografia baseada em PSK.

Exemplo:

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

Este parâmetro é suportado desde o Zabbix 7.0.4.

TLSConnect

O nível de criptografia exigido para conexões do agent com o server ou proxy do Zabbix. Usado para verificações ativas. Apenas um valor pode ser especificado:

• unencrypted - conectar sem criptografia (padrão);
• psk - conectar usando TLS e uma chave pré-compartilhada (PSK);
• cert - conectar usando TLS e um certificado.

Obrigatório: sim, se os parâmetros de certificado TLS ou PSK estiverem definidos (mesmo para conexão unencrypted); caso contrário, não

TLSCRLFile

O caminho completo do arquivo contendo certificados revogados. Este parâmetro é usado para comunicações criptografadas entre os componentes do Zabbix.

TLSKeyFile

O nome completo do caminho do arquivo que contém a chave privada do agente, usada para comunicações criptografadas entre os componentes do Zabbix.

TLSPSKFile

O caminho completo do arquivo que contém a chave pré-compartilhada do agent, usada para comunicações criptografadas com o Zabbix server ou proxy.

TLSPSKIdentity

A string de identidade da chave pré-compartilhada, usada para comunicações criptografadas com o Zabbix server ou proxy.

TLSServerCertIssuer

O emissor do certificado do servidor (proxy) permitido.

TLSServerCertSubject

O assunto do certificado do servidor (proxy) permitido.

UnsafeUserParameters

Permite que todos os caracteres sejam passados nos argumentos para parâmetros definidos pelo usuário. Os seguintes caracteres não são permitidos: \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @
Além disso, caracteres de nova linha não são permitidos.

Padrão: 0
Valores: 0 - não permitir, 1 - permitir

UserParameter

Um parâmetro definido pelo usuário para monitoramento. Pode haver vários parâmetros definidos pelo usuário.
Formato: UserParameter=<key>,<shell command>
Observe que o comando shell não deve retornar uma string vazia nem apenas EOL. Os comandos shell podem ter caminhos relativos, se o parâmetro UserParameterDir estiver especificado.

Exemplo:

UserParameter=system.test,who|wc -l
UserParameter=check_cpu,./custom_script.sh

UserParameterDir

O caminho de busca padrão para comandos UserParameter. Se usado, o agent alterará seu diretório de trabalho para o especificado aqui antes de executar um comando. Assim, os comandos UserParameter podem usar um prefixo relativo ./ em vez de um caminho completo.
Apenas uma entrada é permitida.

Exemplo:

UserParameterDir=/opt/myscripts