Usando o pacote de suporte do Automation Suite

Visão geral da ferramenta de pacote de suporte do Automation Suite, seu conteúdo e como ela ajuda na solução de problemas.

Visão geral

O pacote de suporte do Automation Suite coleta logs no nível do aplicativo de serviços da UiPath® e objetos relevantes necessários para avaliar e corrigir o problema. O pacote de suporte do Automation Suite também contém logs históricos que você pode usar para analisar padrões ao solucionar um problema. Os logs históricos são especialmente úteis quando a possível causa raiz de um problema não é evidente apenas examinando o estado do cluster.

O pacote de suporte do Automation Suite também é necessário ao pedir orientação ou uma correção da equipe de suporte da UiPath®, pois ela precisa dele para fins de análise.

Observação:

O pacote de suporte do Automation Suite não coleta nem armazena quaisquer PII ou dados confidenciais de você, seu usuário ou sua automação. Os aplicativos da UiPath® não vazam nem registram quaisquer informações confidenciais em seus registros. No nível da plataforma, o coletor de logs foi projetado para mascarar essas informações críticas.

Parâmetros da ferramenta do pacote de suporte do Automation Suite

• A telemetria de uso e configuração resumida de alto nível também é exportada com essa ferramenta, gerando um arquivo XML. Essa telemetria inclui:
  • Detalhes da configuração de instalação do Automation Suite (como versão do Kubernetes, modo de instalação, versão e serviços habilitados, entre outras configurações).
  • Informações de uso de recursos no nível do cluster (como disponibilidade e utilização de CPU e memória, entre outras métricas).
  • Detalhes de execução do comando UiPathctl (como status, logs, e duração, entre outros detalhes).
  • Telemetria de uso:
    • Duração da execução do robô por mês por tipo de robô.
    • Concorrência de robôs - o número máximo de robôs que foram executados ao mesmo tempo.
    • Métricas sobre trabalhos executados, processos executados, itens de fila, taxa de falha de trabalho e usuários.
    • Informações do ambiente.
    • Resumo do uso de AI Units se você usar o AI Center.
• A UiPath usa esses dados apenas para relatórios internos para fortalece a compreensão do cliente e melhorar a qualidade do suporte e a experiência geral.
• Você pode carregar o arquivo XML no Customer Portal para compartilhar sua telemetria de uso auto-hospedado de alto nível com a equipe de suporte da UiPath.
• Para visualizar o arquivo XML, abra-o usando o SQL Server Management Studio ou qualquer visualizador de XML.
• Você pode parar de gerar telemetria resumida adicionando service-metrics à lista de exclusão com a opção --exclude=service-metrics . Essa opção está disponível no Automation Suite 2.2510 e posterior.

Gerar o pacote de suporte

Para gerar o pacote de suporte, execute o seguinte comando no diretório do instalador:

./bin/uipathctl health bundle cluster_config.json --versions versions/helm-charts.json

A partir do Automation Suite 2.2510.1, os caminhos para o arquivo de configuração (cluster_config.json) e os parâmetros do arquivo de versões (helm-charts.json) são opcionais. Você pode gerar o pacote de suporte simplesmente executando:

./bin/uipathctl health bundle

Essa ferramenta requer algum tempo para coletar e armazenar todos os logs em um local temporário em sua máquina local ou de gerenciamento.

A tabela a seguir lista os sinalizadores opcionais que você pode usar para a ferramenta do pacote de suporte:

Bandeiras	Description
--output-dir string	Especifique o diretório para armazenar o pacote de suporte.
--namespace string	Especifique o namespace no qual o UiPath Automation Suite é implantado.
--include string	Especifique componentes adicionais (separados por vírgula) a serem incluídos no pacote (como --include=historical-logs).
--exclude string	Especifique os componentes (separados por vírgula) a serem excluídos do pacote (como--exclude=rke2-bundle ou --exclude=service-metrics).
--from YYYY-MM-DD	A data de início para coletar os logs históricos no formato AAAA-MM-DD.
--days int	O número de dias a partir da data de início para os quais coletar os logs históricos.
--limit-bytes int	Limita o tamanho dos logs de pods em execução fornecendo o valor inteiro em bytes.

Por padrão, se o sinalizador --from não for especificado, os logs históricos serão coletados dos últimos 2 dias a partir de hoje, independentemente do --days especificado. Se o --from for especificado e o --days não for especificado, os logs históricos serão coletados por 2 dias a partir da data de início especificada.

O pacote RKE2 está incluído por padrão no pacote de suporte. Para excluí-lo, use oflag --exclude=rke2-bundle.

Os logs históricos não são incluídos por padrão no pacote de suporte. Para incluí-los, use o sinalizador --include=historical-logs.

Estrutura do pacote de suporte do Automation Suite

O arquivamento .tar.gz contém os seguintes arquivos e pastas:

Arquivo/Pasta	Description
logs	Contém os logs históricos coletados do ceph ou armazenamento de objetos externo.
current-logs	Contém os logs ao vivo (como logs para a instância atual e anterior de pods).
events.json	Contém as descrições de eventos de todos os namespaces.
alerts	Contém os alertas do prometheus ativos no cluster.
server0.tar.gz, server1.tar.gz, ...	Contém o pacote do RKE2 para cada nó no cluster.
namespace/resource/object.yaml	Contém as descrições do objeto para o namespace servidor preferido/personalizado e recursos com escopo de cluster.
service-metrics	Contém a configuração de alto nível e a telemetria de uso armazenadas em arquivos XML individuais.

A estrutura do pacote RKE2 é a seguinte:

Diretório	Description
systemlogs	Contém os logs relacionados a eventos do sistema, auditorias de segurança e mensagens gerais do sistema.
systeminfo	Contém as informações sobre os processos em execução, uso do disco, utilização da CPU, e assim por diante.
etcd	Contém as informações relacionadas ao armazenamento de dados do armazenamento de chave-valor etcd .
journald	Contém os logs gerenciados por systemd-journald.
networking	Contém os detalhes de configuração de rede, como iptables, roteamento e assim por diante.
rke2	Contém os logs do kubelet, certificados de agente e servidor, informações sobre o crictl e os recursos em execução no cluster e logs do pod.