Parâmetros de configuração: Zabbix agent (Windows)

Visão geral

Os parâmetros de configuração permitem personalizar o comportamento do Zabbix agent no Windows.

Especifique os valores dos parâmetros no arquivo de configuração (zabbix_agentd.win.conf). Todos os parâmetros são opcionais, a menos que seja explicitamente indicado que o parâmetro é obrigatório.

Esta página está estruturada da seguinte forma:

• Visão geral dos parâmetros (para ver os detalhes completos de um parâmetro, clique no nome dele)
• Detalhes dos parâmetros

Observe que:

• Os valores padrão refletem os padrões do daemon, não os valores nos arquivos de configuração fornecidos.
• Os valores suportam variáveis de ambiente.
• O Zabbix suporta arquivos de configuração somente em codificação UTF-8 sem BOM.
• Comentários que começam com "#" são suportados apenas no início da linha.

Detalhes do parâmetro

Alias

Defina 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 em HostnameItem ou no parâmetro PerfCounter.

Exemplo 1: Recuperando o uso do arquivo de paginação em porcentagem do server.

Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]

Agora a chave abreviada pg_usage pode ser usada para recuperar dados.

Exemplo 2: Obtendo a carga da CPU com parâmetros padrão e personalizados.

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

Isso permite usar a chave cpu.load para obter a carga da CPU com parâmetros padrão, bem como usar cpu.load[percpu,avg15] para obter dados específicos sobre a carga da 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

Defina a frequência de envio dos valores do buffer para o Zabbix server/proxy (em segundos).

Padrão: 5
Intervalo: 1-3600

BufferSize

Define 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.

Padrão: 100
Intervalo: 2-65535

DebugLevel

Defina o nível de depuração:
0 - informações básicas sobre a inicialização e a finalização dos processos do Zabbix
1 - informações críticas;
2 - informações de erro;
3 - avisos;
4 - para depuração (gera muitas informações);
5 - depuração estendida (gera ainda mais informações).

Padrão: 3
Intervalo: 0-5

DenyKey

Negue 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 AllowKey. Os parâmetros são processados um a um de acordo com a ordem em que aparecem. Veja também: Restricting agent checks.

EnableRemoteCommands

Permite comandos remotos do Zabbix server.
Este parâmetro está obsoleto, use AllowKey=system.run[*] ou DenyKey=system.run[*] em vez disso.
É um alias interno para os parâmetros AllowKey/DenyKey, dependendo do valor:
0 - DenyKey=system.run[*]
1 - AllowKey=system.run[*]

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

HeartbeatFrequency

Define a frequência das mensagens de heartbeat em segundos. Usado para monitorar a disponibilidade de active checks.
0 - mensagens de heartbeat desativadas.

Padrão: 60
Intervalo: 0-3600

HostInterface

Especifique a interface do host (endereço IP ou nome DNS) usada durante a 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 iniciará se o valor ultrapassar o limite de 255 caracteres.

Intervalo: 0-255 caracteres

HostInterfaceItem

Especifique um item para determinar a interface do host (endereço IP ou nome DNS) durante a autoregistration 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 autoregistration, 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

Especifique os metadados usados para identificar ou distinguir o host durante a autoregistration do host (agent ativo). 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 iniciará se o valor especificado exceder o limite de 2034 bytes ou se 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 reportados como inválidos.

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

Intervalo: 0-2034 bytes

HostMetadataItem

Especifique um item do Zabbix agent 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 autoregistration e é usado apenas no processo de autoregistration do host (agent ativo). HostMetadataItem permite distinguir hosts além do hostname.

Parâmetros de usuário, contadores de desempenho e aliases são suportados. O item system.run[] é suportado independentemente das configurações AllowKey/DenyKey.

Durante uma solicitação de autoregistration, o agent registrará uma mensagem de aviso se o valor retornado pelo item especificado estiver acima do 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 informados como inválidos.

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

Nome do host

Especifique nomes de host exclusivos e sensíveis a maiúsculas e minúsculas. Uma lista delimitada por vírgulas.
Obrigatório para verificações ativas e deve corresponder aos nomes de host conforme 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

Especifique um item do Zabbix agent para obter o nome do host.
Esta opção é usada apenas quando Hostname não está definido.
Parâmetros de usuário, contadores de desempenho ou aliases não são suportados, mas o item system.run[] é suportado independentemente dos valores de AllowKey/DenyKey.
Veja também uma descrição mais detalhada.

Padrão: system.hostname

Incluir

Especifique um diretório ou arquivos individuais para serem incluídos no arquivo de configuração (localizado em C:\Program Files\Zabbix Agent por padrão, se o Zabbix agent estiver instalado usando pacotes do instalador MSI do Windows; localizado na pasta especificada durante a instalação, se o Zabbix agent estiver instalado como um arquivo zip). Todos os arquivos incluídos devem ter sintaxe correta; caso contrário, o agent não iniciará.
Para incluir apenas os arquivos relevantes no diretório especificado, o caractere curinga asterisco é suportado para correspondência de padrões.
Consulte notas especiais sobre limitações.

Exemplo:

Include=C:\Program Files\Zabbix Agent\zabbix_agentd.d\*.conf

ListenBacklog

Define o número máximo de conexões pendentes na fila TCP.
O valor padrão é uma constante codificada, que depende do sistema.
O valor máximo suportado também depende do sistema; valores muito altos podem ser truncados silenciosamente para o "máximo especificado pela implementação".

Padrão: SOMAXCONN
Intervalo: 0 - INT_MAX

ListenIP

Especifique o endereço IP de escuta do agent para conexões provenientes do server/proxy. Uma lista delimitada por vírgulas.

Padrão: 0.0.0.0

ListenPort

Especifique a porta de escuta do agent para conexões provenientes do server/proxy.

Padrão: 10050
Intervalo: 1024-32767

LogFile

Especifique o arquivo de log do agent.

Padrão: c:\zabbix_agentd.log
Obrigatório: Sim, se LogType estiver definido como file; caso contrário, não

LogFileSize

Defina o tamanho máximo do arquivo de log (em MB).
0 - desativa a rotação automática do log.
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 reiniciado.

Padrão: 1
Intervalo: 0-1024

LogRemoteCommands

Ative o registro dos comandos de shell executados como avisos.
Os comandos serão registrados somente se forem executados remotamente.
As 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

LogType

Especifique o tipo de saída do log:
file - grava o log no arquivo especificado pelo parâmetro LogFile;
system - grava o log no Windows Event Log;
console - grava o log na saída padrão.

Padrão: file

MaxLinesPerSecond

Define o número máximo de novas linhas por segundo para envio ao server/proxy do Zabbix ao processar verificações ativas log, logrt ou eventlog.
O valor fornecido será substituído pelo parâmetro 'maxlines', informado na chave do item 'log', 'logrt' ou 'eventlog'.
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

PerfCounter

Defina um novo parâmetro <parameter_name> que seja o valor médio do contador de desempenho do sistema <perf_counter_path> para o período de tempo especificado <period> (em segundos).
Sintaxe: <parameter_name>,"<perf_counter_path>",<period>

Por exemplo, se você quiser receber o número médio de interrupções do processador por segundo no último minuto, você pode definir um novo parâmetro "interrupts" da seguinte forma:

PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60

Observe as aspas duplas ao redor do caminho do contador de desempenho. O nome do parâmetro (interrupts) deve ser usado como a chave do item ao criar um item. As amostras para calcular o valor médio serão coletadas a cada segundo.
Você pode executar "typeperf -qx" para obter a lista de todos os contadores de desempenho disponíveis no Windows.

PerfCounterEn

Define um novo parâmetro <parameter_name> que é o valor médio do contador de desempenho do sistema <perf_counter_path> para o período de tempo especificado <period> (em segundos). Em comparação com PerfCounter, os caminhos do perfcounter devem estar em inglês. Suportado apenas no Windows Server 2008/Vista e versões posteriores.
Sintaxe: <parameter_name>,"<perf_counter_path>",<period>

Por exemplo, se você quiser receber o número médio de interrupções do processador por segundo no último minuto, você pode definir um novo parâmetro "interrupts" da seguinte forma:

PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60

Observe as aspas duplas ao redor do caminho do contador de desempenho. O nome do parâmetro (interrupts) deve ser usado como a chave do item ao criar um item. As amostras para calcular o valor médio serão coletadas a cada segundo.
Você pode encontrar a lista de strings em inglês visualizando a seguinte chave do registro: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009.

RefreshActiveChecks

Especifique a frequência de atualização da lista de verificações ativas, 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

Especifique os endereços IP, opcionalmente em notação CIDR, ou os nomes DNS dos servers/proxies do Zabbix. Uma lista separada por vírgulas.
As conexões de entrada serão aceitas apenas 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' sã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. Observe que "endereços IPv6 compatíveis com IPv4" (prefixo 0000::/96) são suportados, mas estão obsoletos conforme RFC4291. Espaços são permitidos.

Exemplo:

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

Obrigatório: sim, se StartAgents não estiver definido explicitamente como 0

ServerActive

Especifique o endereço do server/proxy do Zabbix ou a configuração de cluster para obter active checks.
O endereço do server/proxy é um endereço IP ou nome DNS, com porta opcional separada por dois-pontos.
A configuração de cluster é um ou mais endereços de membros do grupo de server ou proxy separados por ponto e vírgula. Vários servers/clusters do Zabbix e proxies do Zabbix podem ser especificados, separados por vírgula. A menos que esteja usando grupos de proxy, não deve ser especificado mais de um proxy do Zabbix para cada server/cluster do Zabbix. Se um proxy do Zabbix for especificado, então o server/cluster do Zabbix para esse proxy não deve ser especificado.
Vários endereços delimitados por vírgula podem ser fornecidos para usar vários servers independentes do Zabbix 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 desse 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, os active checks serão desativados.

Exemplo para proxy do Zabbix:

ServerActive=127.0.0.1:10051

Exemplo para grupo de proxy do Zabbix:

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

Exemplo para vários 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

Intervalo: O número de servers ativos listados em ServerActive mais o número de instâncias pré-fork para passive checks especificadas em StartAgents deve ser menor que 64.

SourceIP

Especifique o endereço IP de origem para:

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

StartAgents

Defina o número de instâncias pré-forked de zabbix_agentd para processar verificações passivas.
Se definido como 0, as verificações passivas serão desativadas e o agent não escutará em nenhuma porta TCP.

Padrão: 10
Intervalo: 0-100 (*)

Tempo limite

Especifique por quanto tempo aguardar (em segundos) para estabelecer a 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 active checks;
• recuperar dados de log por meio do monitoramento de logfile ou do log de eventos do Windows;
• enviar mensagens de heartbeat;
• duração máxima para verificações vfs.*;
• usado por módulos do Zabbix agent;
• servir como fallback em cenários em que um server ou proxy mais antigo que a versão 7.0 envia verificações sem timeouts.

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

Padrão: 3
Intervalo: 1-30

TLSAccept

Especifique 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

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

TLSCertFile

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

TLSConnect

Especifique o nível de criptografia exigido para conexões do agent com o Zabbix server ou proxy.
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

Especifique o caminho completo do arquivo que contém os certificados revogados. Este parâmetro é usado para comunicações criptografadas entre os componentes do Zabbix.

TLSKeyFile

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

TLSPSKFile

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

TLSPSKIdentity

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

TLSServerCertIssuer

Especifique o emissor do certificado do server (proxy) permitido.

TLSServerCertSubject

Especifique o subject do certificado permitido do server (proxy).

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

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

Exemplo:

UserParameter=system.test,dir /b | find /c /v ""
UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

Especifique o caminho de pesquisa padrão para comandos UserParameter. Se usado, o agent alterará seu diretório de trabalho para o diretório 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=C:\opt\myscripts