Implantação do Agente de criação de log para Windows

Você pode implementar o Agente de criação de log para coletar e rotear logs de infraestrutura e de aplicativos de sistemas Windows para uma instância IBM Cloud Logs. Para obter mais informações sobre os ambientes Windows compatíveis, consulte Agente de criação de log para ambientes não iniciados.

Conclua as etapas a seguir para implantar um agente em um sistema Windows compatível.

Definir o método de autenticação para o agente

Escolha o tipo de identidade e o método de autenticação para o agente. Em seguida, crie uma chave de API, se necessário.

Conclua as etapas a seguir:

  1. Escolha o tipo de identidade: Service ID ou Trusted Profile

    Você pode usar uma ID de serviço ou um perfil confiável para se autenticar no serviço IBM Cloud Logs. Os perfis confiáveis são compatíveis apenas com os Virtual Servers for VPC. Você deve criar a instância com o serviço de metadados ativado e vincular o perfil confiável à sua instância, especificando o ID ao criá-la. Para obter mais informações, consulte Criação de instâncias de servidor virtual.

  2. Conceda permissões de ingestão à identidade que você escolheu.

    A função ' Sender é necessária para enviar os registros para IBM Cloud Logs.

    Para obter mais informações, consulte Concessão de permissões de IAM para ingestão.

    Para obter mais informações sobre perfis confiáveis, consulte Geração de um perfil confiável para ingestão.

  3. Gerar uma chave de API para autenticação de ID de serviço.

    Para autenticação com perfis confiáveis, essa etapa não é necessária.

    Para obter mais informações, consulte Geração de uma chave de API para ingestão.

Faça o download dos arquivos do agente

Conclua as etapas a seguir:

  1. Faça login no seu ambiente Windows.

  2. Faça o download do arquivo ZIP do agente do Windows.

    Para obter informações sobre a versão atual Agente de criação de log, consulte as notas de versão do agente.

  3. Valide a soma de verificação executando o seguinte comando:

    sha256sum -c <sha256_filename>
    

    Onde " <sha256_filename> é o nome do arquivo de download " *.sha256.

  4. Usando o Powershell, expanda o arquivo do agente do Windows no diretório " Program Files.

    Expand-Archive -Path <archive_filename> -DestinationPath "C:\Program Files\"
    

    Onde <archive_filename> é o nome do arquivo *.zip baixado.

  5. Altere o diretório para o arquivo expandido do agente do Windows.

    cd "C:\Program Files\logs-agent"
    
  6. Faça o download do arquivo de configuração do local C:\Program Files\logs-agent.

    wget https://logs-router-agent-config.s3.us.cloud-object-storage.appdomain.cloud/configure-logs-agent.ps1
    

Implante o Agente de criação de log para coletar o registro de eventos do Windows

Execute o script Powershell de configuração.

./configure-logs-agent.ps1 -TargetHost <target_host> -TargetPort <target_port> -AuthMode <auth_mode> -IAMEnv <IAM_environment> [[-IAMApiKey] <iam_api_key>] [-TrustedProfile] <trusted_profile_id>] -Channels <channels_list> [[-DBPath] <database_path>] [-VSISecureAccess]

em que

-TargetHost <target_host>

O host para ingestão de IBM Cloud Logs, encontrado na seção ' Endpoints da sua instância IBM Cloud Logs ' Overview. Use o ponto de extremidade de entrada. Para obter mais informações, consulte Pontos de extremidade de entrada

-TargetPort <target_port>

Especifica a porta do ponto de extremidade de entrada que dependerá de sua conectividade de rede com IBM Cloud Logs. Especifique ' 3443 para IBM Cloud Logs Routing.

  • 443: Ponto de extremidade de entrada público
  • 443: Ponto de extremidade de entrada privado (VPE)
  • 3443: Ponto de extremidade de entrada privado (CSE)
-IAMEnv <IAM_environment>

(Opcional) Especifica se um ponto de extremidade público ou privado é usado para autenticação do IAM. Production indica o uso do ponto de extremidade público. PrivateProduction especifica o uso do ponto de extremidade privado. Production é o padrão.

Se o seu sistema não tiver acesso à Internet pública, você deverá usar ' PrivateProduction para usar o endpoint privado.

-AuthMode <auth_mode>

Especifique " IAMAPIKey ou " VSITrustedProfile.

-IAMApiKey <iam_api_key>

(Opcional) Especifique a Cloud Identity and Access Management (necessária para o modo " IAMAPIKey ). Certifique-se de seguir as instruções em Geração de uma chave de API.

Para obter mais informações sobre Cloud Identity and Access Management Consulte Gerenciamento de chaves de API.

-TrustedProfile <trusted_profile_id>

(Opcional) Especifique o ID do perfil confiável (necessário para o modo " VSITrustedProfile ). Ao usar perfis confiáveis, defina como a ID configurada em Conceder permissões de IAM para ingestão.

Para obter mais informações sobre perfis confiáveis, consulte Criação de um perfil confiável.

-Channels <channels_list>

(Opcional) Se uma lista de canais for fornecida, um plug-in de entrada padrão " winevtlog será configurado para ler eventos dos canais especificados. Especifique quais canais devem ser lidos no Registro de Eventos do Windows como uma lista separada por vírgulas e sem espaços.

-DBPath <database_path>

(Opcional) Se o parâmetro " Channels for fornecido, defina esse parâmetro como o arquivo de banco de dados para armazenar a posição dos eventos processados. Se esse parâmetro não for definido e o parâmetro " Channels for fornecido, o arquivo de banco de dados padrão será " C:\Program Files\logs-agent\winevtlog.sqlite.

-VSISecureAccess

(Opcional) Defina esse sinalizador se o acesso seguro estiver ativado em seu VSI. Essa opção não está ativada por padrão.

Configure o Agente de criação de log para incluir ou excluir arquivos

Você pode configurar o Agente de criação de log para incluir ou excluir arquivos que o agente monitora.

  1. Crie o arquivo de configuração do plug-in de entrada input-tail.conf em C:\Program Files\logs-agent\etc.

  2. Adicione a seção INPUT.

    Defina o Path (Caminho ) com os diretórios e arquivos que você deseja monitorar.

    Defina Exclude_Path com os diretórios e arquivos que você deseja excluir do monitoramento.

    [INPUT]
        Name              tail
        Tag               *
        Path              C:\logs\*.log
        Path_Key          file
        Exclude_Path      C:\logs\audit.log
        DB                C:\logs\fluent-bit.DB
        Buffer_Chunk_Size 32KB
        Buffer_Max_Size   256KB
        Skip_Long_Lines   On
        Refresh_Interval  10
    
  3. Salve o arquivo de configuração.

  4. Modifique o arquivo C:\Program Files\logs-agent\etc\fluent-bit.conf para incluir a referência ao arquivo C:\Program Files\logs-agent\etc\input-windows-event-log.conf.

    @INCLUDE C:\Program Files\logs-agent\etc\input-windows-event-log.conf
    

    O arquivo de configuração principal C:\Program Files\logs-agent\etc\fluent-bit.conf importa outros arquivos com a tag @INCLUDE <path_to_file>.

Incluir metadados

Você deve configurar o Agente de criação de log para incluir applicationName e subsystemName. Você também pode adicionar metadados personalizados.

  • O nome do aplicativo é o ambiente que produz e envia registros para uma instância IBM Cloud Logs. Defina o valor para o nome do host usando a variável ${COMPUTERNAME} ou digitando o nome do host do computador.
  • O nome do subsistema é o serviço ou aplicativo que produz e envia registros para uma instância IBM Cloud Logs. Por exemplo, você pode defini-lo como o nome do provedor.
[FILTER]
    Name modify
    Match winevtlog.*
    Copy ProviderName subsystemName
    Add applicationName ${COMPUTERNAME}
    Add meta.source ${SOURCE}
    Add meta.channel ${Channel}
    Add meta.providerName ${ProviderName}
    Add meta.environment prod
    Add meta.platform windows

[FILTER]
    Name nest
    Match winevtlog.*
    Operation nest
    Wildcard meta.*
    Nest_under meta
    Remove_prefix meta.

Verificar a configuração do agente

Verifique se a configuração do agente está correta executando o agente.

.\bin\fluent-bit.exe -c C:\Program Files\logs-agent\etc\fluent-bit.conf

O agente iniciará e estabelecerá uma conexão com o alvo desejado.

Criar um serviço do Windows

Os serviços do Windows são processos em segundo plano de longa duração e são a maneira preferida de executar o agente no Windows.

Conclua as etapas a seguir:

  1. Para registrar o agente como um serviço do Windows, execute o seguinte comando.

    É necessário um espaço simples após " binpath=.

    sc.exe create fluent-bit binpath= "C:\Program Files\logs-agent\bin\fluent-bit.exe -c \"C:\Program Files\logs-agent\etc\fluent-bit.conf\""
    
  2. Para agentes que usam " IAMAPIKey para autenticação, crie uma chave de API no registro para o serviço " fluent-bit.

    New-ItemProperty -Path "HKLM:\System\CurrentControlSet\Services\fluent-bit" -Name "Environment" -Value "IAM_API_KEY=<my_api_key>" -PropertyType MultiString
    
  3. Iniciar o serviço do Windows

    sc.exe start fluent-bit
    

Verificar se os registros estão sendo entregues ao seu destino de destino

Conclua as etapas a seguir:

  1. Acesse a interface do usuário da Web para sua instância IBM Cloud Logs.

  2. Quando o agente estiver configurado corretamente, você poderá ver os registros por meio da visualização padrão do painel.