Coletar registros do HAProxy

Compatível com:

Google SecOps SIEM

Neste documento, explicamos como ingerir registros do HAProxy no Google Security Operations usando o agente do Bindplane.

O HAProxy é um balanceador de carga e servidor proxy de alta disponibilidade que gera mensagens de syslog para solicitações HTTP, eventos de conexão, verificações de integridade de back-end e atividade de processo. O analisador usa a correspondência de padrões do Grok para extrair campos de vários formatos de registro do HAProxy e os mapeia para o modelo de dados unificado (UDM).

Antes de começar

Verifique se você tem os pré-requisitos a seguir:

• Uma instância do Google SecOps
• Windows Server 2016 ou mais recente ou host Linux com systemd
• Conectividade de rede entre o agente do Bindplane e o servidor HAProxy
• Se estiver em execução atrás de um proxy, verifique se as portas do firewall estão abertas de acordo com os requisitos do agente do Bindplane.
• Acesso administrativo à configuração do HAProxy

Receber credenciais do Google SecOps para o agente do BindPlane

Para autenticar o agente do Bindplane no Google SecOps, escolha um dos seguintes métodos:

• Novas implantações: use a API Chronicle (opção 1).
• Implantações legadas: continue usando o arquivo de autenticação de ingestão (opção 2) até que a API Ingestion seja descontinuada em 20 de julho de 2027.

Opção 1: criar uma conta de serviço para a API Chronicle (recomendado)

1. Faça login no console doGoogle Cloud e selecione o projeto do Google Cloud vinculado à sua instância do Google SecOps.
2. Acesse IAM e administrador > Contas de serviço.
3. Clique em Criar conta de serviço.
4. Informe os seguintes detalhes de configuração:
   • Nome da conta de serviço: insira um nome para a conta (por exemplo, bindplane-ingest).
   • Descrição da conta de serviço: insira uma descrição (por exemplo, Bindplane agent log ingestion).
5. Clique em Criar e continuar.
6. Na seção Conceder a essa conta de serviço acesso ao projeto, clique em Selecionar uma função e escolha Editor do Chronicle.
7. Clique em Continuar e depois em Concluído.
8. Clique na conta de serviço que você criou e acesse a guia Chaves.
9. Clique em Adicionar chave > Criar nova chave.
10. Selecione JSON e clique em Criar. O download do arquivo de chave é feito no seu computador.
11. Salve o arquivo de chave como ingestion-auth.json no diretório do coletor do BindPlane (/opt/observiq-otel-collector/ingestion-auth.json no Linux ou C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json no Windows) ou atualize creds_file_path em config.yaml para corresponder ao caminho em que você o salvou.
12. Acesse IAM e administrador > Configurações e copie o número do projeto. Você vai precisar dele para a configuração do exportador.

Observação: a chave JSON é uma credencial. Restrinja o acesso ao arquivo no host do BindPlane e alterne a chave de acordo com a política da sua organização.

Opção 2: fazer o download do arquivo de autenticação de ingestão (legado)

1. Faça login no console do Google SecOps.
2. Acesse Configurações do SIEM > Agentes de coleta.
3. Faça o download do arquivo de autenticação de ingestão.
4. Salve o arquivo com segurança no sistema em que o agente do Bindplane será instalado.

Observação: esse arquivo autentica o agente na API Ingestion legada (malachiteingestion-pa.googleapis.com), que o Google programou para ser desativada em 20 de julho de 2027. Planeje migrar para a opção 1 antes dessa data.

Receber o ID de cliente do Google SecOps

1. Faça login no console do Google SecOps.
2. Acesse Configurações do SIEM > Perfil.

3. Copie e salve o ID de cliente na seção Detalhes da organização.

   Observação :o ID de cliente é necessário para configurar o exportador do agente do BindPlane.

Instalar o agente do BindPlane

Instale o agente do Bindplane no seu sistema operacional Windows ou Linux de acordo com as instruções a seguir.

Instalação do Windows

1. Abra o prompt de comando ou o PowerShell como administrador.

2. Execute este comando:

   msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
   

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sc query observiq-otel-collector
   

   O serviço precisa aparecer como RUNNING.

Instalação do Linux

1. Abra um terminal com privilégios de root ou sudo.

2. Execute este comando:

   sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
   

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sudo systemctl status observiq-otel-collector
   

   O serviço vai aparecer como ativo (em execução).

Outros recursos de instalação

Para mais opções de instalação e solução de problemas, consulte o guia de instalação do agente do Bindplane.

Observação: a configuração do exportador da API Chronicle requer o coletor do Bindplane v1.106.0 ou mais recente. Os comandos anteriores instalam a versão mais recente. Se você estiver atualizando uma instalação, faça upgrade do coletor antes de mudar a configuração.

Configurar o agente do Bindplane para ingerir syslog e enviar ao Google SecOps

Localizar o arquivo de configuração

• Linux:

  sudo nano /opt/observiq-otel-collector/config.yaml
  

• Windows:

  notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
  

Editar o arquivo de configuração

• Substitua todo o conteúdo de config.yaml pela seguinte configuração:

  receivers:
    udplog:
      listen_address: "0.0.0.0:514"
  
  exporters:
    chronicle/haproxy:
      protocol: https
      # Region of your instance, for example us, europe, asia-southeast1
      location: <LOCATION>
      # Project number of the Google Cloud project linked to the instance
      project: '<PROJECT_NUMBER>'
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: HAPROXY
      raw_log_field: body
  
  service:
    pipelines:
      logs/haproxy_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/haproxy
  

Parâmetros de configuração

Substitua os seguintes marcadores de posição:

• Configuração do receptor:

  • listen_address: endereço IP e porta a serem detectados:
    • 0.0.0.0 para ouvir em todas as interfaces (recomendado)
    • A porta 514 é a porta padrão do syslog (requer raiz no Linux; use 1514 para não raiz).

• Configuração do exportador:

  • creds_file_path: caminho completo para o arquivo de chave JSON da conta de serviço (opção 1):
    • Linux: /opt/observiq-otel-collector/ingestion-auth.json
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • customer_id: ID de cliente copiado do console do Google SecOps
  • location: substitua <LOCATION> pela região da sua instância do Google SecOps (por exemplo, us, europe ou asia-southeast1). O exportador prefixa chronicle.googleapis.com com esse valor. Consulte Endpoints regionais para ver a lista completa.
  • project: substitua <PROJECT_NUMBER> pelo número do projeto em IAM e administrador > Configurações.
  • endpoint: mantenha definido como chronicle.googleapis.com.

Exportador da API de ingestão legada

• Se você usar o arquivo de autenticação de ingestão da opção 2, substitua o bloco exporters pelo seguinte. Defina creds_file_path como o caminho para o arquivo de autenticação de ingestão e, se a instância estiver fora dos EUA, substitua malachiteingestion-pa.googleapis.com pelo endpoint regional (por exemplo, europe-malachiteingestion-pa.googleapis.com).

  exporters:
    chronicle/haproxy:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: HAPROXY
      raw_log_field: body
  

Observação: esse exportador vai parar de funcionar quando a API Ingestion for desativada em 20 de julho de 2027.

Salve o arquivo de configuração.

• Depois de editar, salve o arquivo:
  • Linux: pressione Ctrl+O, depois Enter e, em seguida, Ctrl+X.
  • Windows: clique em Arquivo > Salvar.

Reinicie o agente do Bindplane para aplicar as mudanças:

• Para reiniciar o agente do Bindplane no Linux, execute o seguinte comando:

  sudo systemctl restart observiq-otel-collector
  

  1. Verifique se o serviço está em execução:

     sudo systemctl status observiq-otel-collector
     

  2. Verifique se há erros nos registros:

     sudo journalctl -u observiq-otel-collector -f
     

• Para reiniciar o agente do BindPlane no Windows, escolha uma das seguintes opções:

  • Prompt de comando ou PowerShell como administrador:

    net stop observiq-otel-collector && net start observiq-otel-collector
    

  • Console de serviços:

    1. Pressione Win+R, digite services.msc e pressione Enter.
    2. Localize o coletor do OpenTelemetry da observIQ.
    3. Clique com o botão direito do mouse e selecione Reiniciar.

    4. Verifique se o serviço está em execução:

       sc query observiq-otel-collector
       

    5. Verifique se há erros nos registros:

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
       

Configurar o syslog para o HAProxy

1. Faça login no HAProxy usando a CLI.

2. Adicione a diretiva log na seção global à Configuração para encaminhar mensagens syslog por UDP.

   • Substitua <bindplane-ip> pelo endereço IP real do agente do BindPlane.

   global
       log <bindplane-ip>:514 local0
   
   defaults
       log global
   

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
accept_date_ms
actconn
backend_name
backend_queue
beconn
bytes_read	network.received_bytes	Extraído do campo bytes_read no registro e convertido em um número inteiro não assinado.
captured_request_headers
client_ip	principal.ip	Extraído do campo client_ip no registro.
client_port	principal.port	Extraído do campo client_port no registro e convertido em um número inteiro.
command_description	metadata.description	Extraído do campo command_description no registro, se disponível. Caso contrário, ele será derivado de outros campos, como action ou status, dependendo da mensagem de registro.
datetime	metadata.event_timestamp.seconds	Extraído do campo datetime no registro, se disponível. Caso contrário, ele é derivado do campo timestamp na entrada de registro.
descrição	metadata.description	Extraído do campo description no registro, se disponível. Caso contrário, ele é derivado de outros campos, como command_description ou action, dependendo da mensagem de registro.
feconn
frontend_name
http_request	target.url	Extraído do campo http_request no registro.
http_status_code	network.http.response_code	Extraído do campo http_status_code no registro e convertido em um número inteiro.
http_verb	network.http.method	Extraído do campo http_verb no registro.
http_version	metadata.product_version	Extraído do campo http_version no registro e formatado como HTTP/{version}.
iniciador	target.application	Extraído do campo initiator no registro.
module
msg	security_result.summary	Extraído do campo msg no registro.
pid	target.process.pid	Extraído do campo pid no registro.
difusão reversa que restaura
process_name	target.application	Extraído do campo process_name no registro.
retries
server_name	target.hostname	Extraído do campo server_name no registro. Se estiver vazio, o padrão será o valor de syslog_server.
gravidade,	security_result.severity	Mapeado do campo severity no registro. WARNING é mapeado para MEDIUM, ALERT é mapeado para CRITICAL e NOTICE é mapeado para INFORMATIONAL.
shell
srv_queue
srvconn
status
syslog_server	target.hostname, intermediary.hostname	Extraído do campo syslog_server no registro. Usado para o nome do host de destino (se server_name estiver vazio) e o nome do host intermediário.
syslog_timestamp
syslog_timestamp_1
syslog_timestamp_2
syslog_timestamp_4
target_ip
time_backend_connect
time_backend_response
time_duration
time_queue
time_request
timestamp	metadata.event_timestamp.seconds	Extraído do campo timestamp no registro e analisado para informações de data e hora. Usado como o carimbo de data/hora do evento.
unknown_parameters1
unknown_parameters2
user_name	target.user.userid	Extraído do campo user_name no registro.
	metadata.event_type	Definido como NETWORK_HTTP por padrão. Mudou para tipos de evento específicos, como PROCESS_UNCATEGORIZED, STATUS_UPDATE ou USER_UNCATEGORIZED, com base na mensagem de registro e nos campos analisados.
	metadata.vendor_name	Defina como HAProxy Enterprise.
	metadata.product_name	Defina como HAProxy.
	network.application_protocol	Defina como HTTP se o campo message contiver HTTP.
	metadata.log_type	Defina como HAPROXY.
source_ip	event.idm.read_only_udm.principal.ip	Mapeado do registro de alterações
source_ip	event.idm.read_only_udm.principal.asset.ip	Mapeado do registro de mudanças
source_port	event.idm.read_only_udm.principal.port	Mapeado do registro de mudanças
status_code	event.idm.read_only_udm.network.http.response_code	Mapeado do registro de mudanças
bytes	event.idm.read_only_udm.network.received_bytes	Mapeado do registro de mudanças
inter_ip	event.idm.read_only_udm.intermediary.ip	Mapeado do registro de mudanças
inter_port	event.idm.read_only_udm.intermediary.port	Mapeado do registro de mudanças
destination_ip	event.idm.read_only_udm.target.ip	Mapeado do registro de mudanças
destination_ip	event.idm.read_only_udm.target.asset.ip	Mapeado do registro de mudanças
destination_port	event.idm.read_only_udm.target.port	Mapeado do registro de mudanças
referer	event.idm.read_only_udm.network.http.referral_url	Mapeado do registro de mudanças
user_agent	event.idm.read_only_udm.network.http.user_agent	Mapeado do registro de mudanças
time_stamp	event.idm.read_only_udm.security_result.detection_fields	Mapeado do registro de mudanças
x_forwarded_for	event.idm.read_only_udm.security_result.detection_fields	Mapeado do registro de mudanças
content_length	event.idm.read_only_udm.security_result.detection_fields	Mapeado do registro de mudanças
datetime	event.idm.read_only_udm.metadata.event_timestamp	Mapeado do registro de alterações

Registro de alterações

Confira o registro de alterações deste analisador

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.