Executar o analisador do cliente no Linux

Se você tiver problemas com o Microsoft Defender para Ponto de Extremidade no Linux e precisar de suporte, talvez seja solicitado que você forneça a saída da ferramenta Client Analyzer. É uma ferramenta de diagnóstico que ajuda administradores e equipes de suporte a solucionar problemas no Microsoft Defender para Ponto de Extremidade. Ele coleta informações detalhadas sobre instalação, configuração, saúde do serviço, logs, status da conectividade, etc. Essa ferramenta é usada principalmente para verificar a integridade do sistema, validar configurações e ajudar na solução de possíveis problemas.

Você pode coletar diagnósticos do Client Analyzer de qualquer uma das seguintes formas:

  1. Linha de comando: Execute o Analisador de Cliente localmente no dispositivo. Veja executar-a-versão-binária-do-analisador-de-cliente ou executar-o-analisador-de-cliente-baseado-em-Python.

  2. Resposta em tempo real: Execute o Analisador de Cliente remotamente durante uma sessão de resposta em tempo real. Veja use-live-response-to-collect-diagnostics-log

  3. Pacote de investigação: Colete um pacote de investigação na página do dispositivo no portal do Microsoft Defender. No Linux, o pacote inclui diagnósticos do Client Analyzer. Veja collect-investigation-package-from-devices

Dica

Assista a este vídeo para obter uma visão geral do analisador de cliente: Visão geral do analisador de cliente do Microsoft Defender para Endpoint

Execute a versão binária do analisador de cliente

A versão binária do analisador de cliente é disponibilizada de duas maneiras:

  • Fornecido com o Microsoft Defender para Linux
  • Fornecido como uma ferramenta independente

Execute o binário do Client Analyzer fornecido com o Microsoft Defender para Linux:

Observação

A partir da versão 101.25082.0000 do Microsoft Defender para Ponto de Extremidade, o Client Analyzer é fornecido com um agente. Ele pode ser encontrado no seguinte local: /opt/microsoft/mdatp/tools/client_analyzer/binary

A execução dessa ferramenta gera um pacote de diagnóstico como um arquivo .zip no diretório /tmp.

Para executar o Client Analyzer, siga estas etapas:

  1. Vá para o diretório /opt/microsoft/mdatp/tools/client_analyzer/binary:

    cd /opt/microsoft/mdatp/tools/client_analyzer/binary
    
  2. Execute a ferramenta com privilégios de root para gerar um pacote de diagnóstico:

    sudo ./MDESupportTool -d
    

Baixar e executar a ferramenta binária autônoma do Client Analyzer

Para usar o binário ClientAnalyzer autônomo, conclua as etapas a seguir.

  1. Baixe a ferramenta XMDE Client Analyzer Binary para a máquina Linux que você precisa investigar. Se você estiver usando um terminal, baixe a ferramenta digitando o seguinte comando:

    wget --quiet -O XMDEClientAnalyzerBinary.zip "https://go.microsoft.com/fwlink/?linkid=2336125"
    
  2. Verifique o download:

    echo '5F906591D33D675F14D73D5B658A796CEC7480B023B18D45C5D687713A4D4FBB XMDEClientAnalyzerBinary.zip' | sha256sum -c
    
  3. Extraia o conteúdo de XMDEClientAnalyzerBinary.zip na máquina.

    unzip -q XMDEClientAnalyzerBinary.zip -d XMDEClientAnalyzerBinary
    
  4. Altere o diretório:

    cd XMDEClientAnalyzerBinary
    
  5. Dois novos arquivos zip são produzidos:

    • SupportToolLinuxamd64Binary.zip: Para dispositivos Linux x86
    • SupportToolLinuxarm64Binary.zip: Para dispositivos ARM Linux
  6. Descompacte o zip específico com base na arquitetura do seu sistema operacional Linux. Por exemplo, usamos aqui o SupportToolLinuxamd64Binary.zip arquivo.

    unzip -q SupportToolLinuxamd64Binary.zip
    
  7. Execute a ferramenta com privilégios de root para gerar um pacote de diagnóstico:

    sudo ./MDESupportTool -d
    

Executar o analisador de cliente baseado em Python

A versão python do analisador de clientes é disponibilizada de duas maneiras:

  • Fornecido com o Microsoft Defender para Linux
  • Fornecido como uma ferramenta independente

Observação

  • O analisador depende de alguns pacotes PIP adicionais (decorator, sh, distro, lxml, e psutil) que são instalados no sistema operacional quando o usuário é root para gerar a saída de resultados. Se não for instalado, o analisador tentará buscá-lo no repositório oficial de pacotes Python.
  • Além disso, a ferramenta atualmente requer que o Python versão 3 ou posterior esteja instalado em seu dispositivo.
  • A partir do Client Analyzer para MDE Linux versão 1.7.0, o suporte para executar o analisador de cliente baseado em Python em um ambiente virtual Python (venv) está disponível. O uso de um ambiente virtual é opcional e não obrigatório.
  • Se o seu dispositivo estiver atrás de um proxy, você poderá passar o servidor proxy como uma variável de ambiente para o mde_support_tool.sh script. Por exemplo: https_proxy=https://myproxy.contoso.com:8080 ./mde_support_tool.sh".

Aviso

A execução do analisador de cliente baseado em Python requer a instalação de pacotes PIP, o que pode causar alguns problemas em seu ambiente. Para evitar problemas, recomendamos que você instale os pacotes em um ambiente PIP do usuário.

Executar a versão em Python do Client Analyzer fornecida com o Microsoft Defender para Linux

Observação

A partir da versão 101.25082.0000 do Defender for Endpoint, o Analisador de Cliente é fornecido com um agente. Ele pode ser encontrado no seguinte local: /opt/microsoft/mdatp/tools/client_analyzer/python

Para executar este analisador de cliente, siga estas etapas:

  1. Ir para o diretório /opt/microsoft/mdatp/tools/client_analyzer/python:

    cd /opt/microsoft/mdatp/tools/client_analyzer/python
    
  2. Execute com privilégios de root para instalar as dependências necessárias.

    sudo ./mde_support_tool.sh
    
  3. Para coletar o pacote de diagnóstico e gerar o arquivo compactado de resultados, execute novamente com privilégios de root.

    sudo ./mde_support_tool.sh -d
    

Baixar e executar a versão standalone em Python do Client Analyzer

  1. Baixe a ferramenta Analisador de Cliente XMDE na máquina Linux que você precisa investigar. Se você estiver usando um terminal, baixe a ferramenta digitando o seguinte comando:

    wget --quiet -O XMDEClientAnalyzerPython.zip "https://go.microsoft.com/fwlink/?linkid=2336046"
    
  2. Verifique o download:

    echo '0B7C350A1C19E049416B1C8FB7ED857569DDCC32FB90453A3FCCD083487C0B4E XMDEClientAnalyzerPython.zip' | sha256sum -c
    
  3. Extraia o conteúdo de XMDEClientAnalyzer.zip na máquina.

    unzip -q XMDEClientAnalyzerPython.zip -d XMDEClientAnalyzerPython
    
  4. Altere o diretório:

    cd XMDEClientAnalyzerPython
    
  5. Dê permissão executável à ferramenta:

    chmod a+x mde_support_tool.sh
    
  6. Execute como um usuário não root para instalar as dependências necessárias:

    ./mde_support_tool.sh
    
  7. Para coletar o pacote de diagnóstico e gerar o arquivo de resultados compactado, execute novamente com privilégios de root:

    sudo ./mde_support_tool.sh -d
    

Dica

Assista a este vídeo para saber mais sobre problemas de onboarding: Problemas de onboarding do analisador de cliente do Microsoft Defender for Endpoint

Opções da linha de comando

O analisador de cliente fornece as seguintes opções de linha de comando:


usage: MDESupportTool [-h] [--output OUTPUT] [--outdir OUTDIR] [--no-zip]
                      [--force] [--diagnostic] [--skip-mdatp]
                      [--bypass-disclaimer] [--interactive] [--delay DELAY]
                      [--mdatp-log {trace,info,warning,error,debug,verbose}]
                      [--max-log-size MAX_LOG_SIZE]
                      {certinfocollection,performance,installation,exclude,ratelimit,skipfaultyrules,trace,observespikes,connectivitytest}
                      ...

MDE Diagnostics Tool

positional arguments:
  {certinfocollection,performance,installation,exclude,ratelimit,skipfaultyrules,trace,observespikes,connectivitytest}
    certinfocollection  Collect cert information: Subject name and Hashes
    performance         Collect extensive machine performance tracing for
                        analysis of a performance scenario that can be
                        reproduced on demand
    installation        Collect different installation/onboarding reports
    exclude             Exclude specific processes from audit-d monitoring.
    ratelimit           Set the rate limit for auditd events. Rate limit will
                        update the limits for auditd events for all the
                        applications using auditd, which could impact
                        applications other than MDE.
    skipfaultyrules     Continue loading rules in spite of an error. This
                        summarizes the results of loading the rules. The exit
                        code will not be success if any rule fails to load.
    trace               Use OS tracing facilities to record Defender
                        performance traces.
    observespikes       Collect the process logs in case of spike or mdatp
                        crash
    connectivitytest    Perform connectivity test for MDE

optional arguments:
  -h, --help            show this help message and exit
  --output OUTPUT, -o OUTPUT
                        Output path to export report
  --outdir OUTDIR       Directory where diagnostics file will be generated.
  --no-zip, -nz         If set a directory will be created instead of an
                        archive file.
  --force, -f           Will overwrite if output directory exists.
  --diagnostic, -d      Collect extensive machine diagnostic information.
  --skip-mdatp          Skip any mdatp command. Use this when the mdatp
                        command is unresponsive.
  --bypass-disclaimer   Do not display disclaimer banner.
  --interactive, -i     Interactive diagnostic,
  --delay DELAY, -dd DELAY
                        Delay diagnostic by how many minutes (0~2880), use
                        this to wait for more debug logs before it collects.
  --mdatp-log {trace,info,warning,error,debug,verbose}
                        Set MDATP log level. If you use interactive or delay
                        mode, the log level will set to debug automatically,
                        and reset after 48h.
  --max-log-size MAX_LOG_SIZE
                        Maximum log file size in MB before rotating(Will
                        restart mdatp).

Modo de diagnóstico

O modo de diagnóstico é usado para coletar um conjunto extenso de informações do computador, como memória, disco e logs MDATP. Esse conjunto de arquivos fornece o principal conjunto de informações necessárias para depurar qualquer problema relacionado ao Defender for Endpoint.

As opções suportadas são as seguintes:


optional arguments:
  -h, --help            show this help message and exit
  --output OUTPUT, -o OUTPUT
                        Output path to export report
  --outdir OUTDIR       Directory where diagnostics file will be generated.
  --no-zip, -nz         If set a directory will be created instead of an
                        archive file.
  --force, -f           Will overwrite if output directory exists.
  --diagnostic, -d      Collect extensive machine diagnostic information.
  --skip-mdatp          Skip any mdatp command. Use this when the mdatp
                        command is unresponsive.
  --bypass-disclaimer   Do not display disclaimer banner.
  --interactive, -i     Interactive diagnostic,
  --delay DELAY, -dd DELAY
                        Delay diagnostic by how many minutes (0~2880), use
                        this to wait for more debug logs before it collects.
  --mdatp-log {trace,info,warning,error,debug,verbose}
                        Set MDATP log level. If you use interactive or delay
                        mode, the log level will set to debug automatically,
                        and reset after 48h.
  --max-log-size MAX_LOG_SIZE
                        Maximum log file size in MB before rotating(Will
                        restart mdatp).

Exemplo de uso: sudo ./MDESupportTool -d

Observação

O recurso de redefinição automática do nível de log está disponível apenas na versão do agente 101.24052.0002 ou superior.

Os arquivos gerados ao usar este modo estão resumidos na tabela a seguir:

Arquivo Observações
mde_diagnostic.zip Logs e configurações do Defender for Endpoint
health.txt O estado de integridade do Defender para Ponto de Extremidade
(Presente somente quando o Defender for Endpoint está instalado)
health_details_features.txt O status de integridade de outros recursos do Defender for Endpoint
(Presente somente quando o Defender for Endpoint está instalado)
permissions.txt Problemas de permissão com as pastas pertencentes/usadas pelo Defender para Ponto de Extremidade
(Presente somente quando o Defender for Endpoint está instalado)
crashes Despejos de memória gerados pelo Defender para Ponto de Extremidade
process_information.txt Processo em execução na máquina quando a ferramenta foi executada
proc_directory_info.txt Mapeamento da memória virtual de processos do Defender for Endpoint
(Presente somente quando o Defender for Endpoint está instalado)
auditd_info.txt Saúde do Auditd, regras, logs
auditd_log_analysis.txt Resumo dos eventos processados pelo auditd
auditd_logs.zip Arquivos de log do Auditd
ebpf_kernel_config.txt Configuração do Kernel do Linux atualmente carregada
ebpf_enabled_func.txt Lista de todas as funções do kernel que estão atualmente habilitadas para rastreamento
ebpf_syscalls.zip Informações sobre o rastreamento de chamadas do sistema
ebpf_raw_syscalls.zip Rastreamento de eventos relacionados a chamadas de sistema brutas
ebpf_maps_info.txt Informações de ID e tamanho dos mapas eBPF
syslog.zip Os arquivos em /var/log/syslog
messages.zip Os arquivos em /var/log/messages
conflicting_processes_information.txt Processos conflitantes do Defender for Endpoint
exclusions.txt Lista de exclusões de antivírus
definitions.txt Informações de definição do antivírus
mde_directories.txt Lista de arquivos nos diretórios do Defender for Endpoint
disk_usage.txt Detalhes de uso do disco
mde_user.txt Informações do usuário do Defender for Endpoint
mde_definitions_mount.txt Ponto de montagem de definições do Microsoft Defender for Endpoint
service_status.txt Status do serviço do Microsoft Defender for Endpoint
service_file.txt Arquivo de serviço do Defender para Ponto de Extremidade
hardware_info.txt Informações de hardware
mount.txt Informações sobre o ponto de montagem
uname.txt Informações do kernel
memory.txt Informações da memória do sistema
meminfo.txt Informações detalhadas sobre o uso da memória do sistema
cpuinfo.txt Informações sobre a CPU
lsns_info.txt Informações sobre namespace do Linux
lsof.txt Informações sobre descritores de arquivo abertos do Defender para Ponto de Extremidade
(veja a nota após esta tabela)
sestatus.txt Defender for Endpoint Informações sobre descritores de arquivo abertos
lsmod.txt Status dos módulos no kernel do Linux
dmesg.txt Mensagens do buffer de anel do kernel
kernel_lockdown.txt Informações sobre o bloqueio do kernel
rtp_statistics.txt Estatísticas de RTP (Proteção em Tempo Real) do Defender for Endpoint
(Presente somente quando o Defender for Endpoint está instalado)
libc_info.txt Informações sobre a biblioteca libc
uptime_info.txt Tempo desde a última reinicialização
last_info.txt Lista dos últimos usuários que fizeram login
locale_info.txt Exibir localidade atual
tmp_files_owned_by_mdatp.txt Arquivos em /tmp pertencentes ao grupo: mdatp
(Presente somente quando o Defender for Endpoint está instalado)
mdatp_config.txt Todas as configurações do Defender for Endpoint
(Presente somente quando o Defender for Endpoint está instalado)
mpenginedb.db
mpenginedb.db-wal
mpenginedb.db-shm
Arquivo de definições de antivírus
(Presente somente quando o Defender for Endpoint está instalado)
iptables_rules.txt Regras de iptables do Linux
network_info.txt Informações de rede
sysctl_info.txt Informações sobre as configurações do kernel
hostname_diagnostics.txt Informações de diagnóstico do nome do host
mde_event_statistics.txt Estatísticas de eventos do Defender para Ponto de Extremidade
(Presente somente quando o Defender for Endpoint está instalado)
mde_ebpf_statistics.txt Estatísticas de eBPF do Defender for Endpoint
(Presente somente quando o Defender for Endpoint está instalado)
kernel_logs.zip Registros do kernel
mdc_log.zip Logs do Microsoft Defender para Nuvem
netext_config.txt
threat_list.txt Lista de ameaças detectadas pelo Defender para Ponto de Extremidade
(Presente somente quando o Defender for Endpoint está instalado)
top_output.txt Processo em execução na máquina quando a ferramenta foi executada
top_summary.txt Análise de uso de memória e CPU do processo em execução

Argumentos opcionais para o Client Analyzer

O Client Analyzer fornece os seguintes argumentos opcionais para coleta de dados extra:

Coletar informações de desempenho

Coletar um extenso rastreamento de desempenho da máquina dos processos do Defender para Ponto de Extremidade para análise de um cenário de desempenho que pode ser reproduzido sob demanda.

-h, --help            show this help message and exit
--frequency FREQUENCY
                      profile at this frequency
--length LENGTH       length of time to collect (in seconds)

Exemplo de uso: sudo ./MDESupportTool performance --frequency 500

Esse modo gera o seguinte arquivo:

Arquivo Observações
perf_benchmark.tar.gz O Defender para Endpoint processa dados de desempenho

Observação

Os arquivos correspondentes ao modo de diagnóstico também são gerados.

O tar contém arquivos no formato <pid of a MDE process>.data. O arquivo de dados pode ser lido usando o comando:

perf report -i <pid>.data

Executar teste de conectividade

Esse modo testa se os recursos de nuvem necessários para o Defender for Endpoint estão acessíveis ou não.


  -h, --help            show this help message and exit
  -o ONBOARDING_SCRIPT, --onboarding-script ONBOARDING_SCRIPT
                        Path to onboarding script
  -g GEO, --geo GEO     Geo string to test <US|UK|EU|AU|CH|IN>

Exemplo de uso:

sudo ./MDESupportTool connectivitytest -o ~/MicrosoftDefenderATPOnboardingLinuxServer.py`

A saída impressa na tela mostra se as URLs estão acessíveis ou não.

Coletar diferentes relatórios de instalação/onboarding

Esse modo coleta informações relacionadas à instalação, como distro e requisitos do sistema.


  -h, --help                show this help message and exit
  -d, --distro              Check for distro support
  -m, --min-requirement     Check for the system info against offical minimum requirements
  -e, --external-dep        Check for externel package dependency
  -c, --connectivity        Check for connectivity for services used by MDE
  -a, --all                 Run all checks
  -o ONBOARDING_SCRIPT, --onboarding-script ONBOARDING_SCRIPT
                            Path to onboarding script
  -g GEO, --geo GEO         Geo string to test <US|UK|EU|AU|CH|IN>

Exemplo de uso:

sudo ./MDESupportTool installation --all

Um único relatório installation_report.json é gerado. As chaves no arquivo são as seguintes:

Chave Observações
agent_version Versão do Defender for Endpoint instalada.
onboarding_status Informações de integração e do buffer circular
support_status O MDE é compatível com as configurações atuais do sistema.
distro A distro na qual o agente está instalado tem suporte ou não.
Teste de conectividade O status dos testes de conectividade.
requisito mínimo Os requisitos mínimos de CPU e Memória foram atendidos.
Dependência externa As dependências externas são satisfeitas ou não.
mde_health Status de saúde do MDE Agent
folder_perm As permissões de pasta necessárias foram atendidas ou não.

Modo de exclusão

Este modo adiciona exclusões para monitoramento audit-d.


  -h, --help            show this help message and exit
  -e <executable>, --exe <executable>
                        exclude by executable name, i.e: bash
  -p <process id>, --pid <process id>
                        exclude by process id, i.e: 911
  -d <directory>, --dir <directory>
                        exclude by target path, i.e: /var/foo/bar
  -x <executable> <directory>, --exe_dir <executable> <directory>
                        exclude by executable path and target path, i.e: /bin/bash /var/foo/bar
  -q <q_size>, --queue <q_size>
                        set dispatcher q_depth size
  -r, --remove          remove exclusion file
  -s, --stat            get statistics about common executables
  -l, --list            list auditd rules
  -o, --override        Override the existing auditd exclusion rules file for mdatp
  -c <syscall number>, --syscall <syscall number>
                        exclude all process of the given syscall

Exemplo de uso:

sudo ./MDESupportTool exclude -d /var/foo/bar`

Usar a resposta ao vivo no Defender for Endpoint para coletar logs de suporte

O Client Analyzer pode ser executado durante uma sessão de Live Response, seja usando a versão já incluída no Microsoft Defender para Ponto de Extremidade no Linux, seja baixando o Client Analyzer como um pacote binário ou Python e extraindo-o no dispositivo.

  • Para a instalação, o unzip pacote é necessário.
  • Para a execução, o acl pacote é necessário.

Importante

O Windows usa os caracteres invisíveis de retorno de carro e alimentação de linha para representar o final de uma linha e o início de uma nova linha em um arquivo. Os sistemas Linux usam apenas o caractere invisível de Alimentação de Linha no final das linhas de arquivo. Quando você usa os scripts a seguir, se isso for feito no Windows, essa diferença pode resultar em erros e falhas na execução dos scripts. Uma solução potencial para isso é utilizar o Subsistema do Windows para Linux (WSL) e o pacote dos2unix para reformatar o script para que ele se alinhe com o padrão de formato Unix e Linux.

Documentos de solução de problemas do Defender para Ponto de Extremidade no Linux