Execução da ferramenta do pacote de suporte

Gere o pacote de suporte que contém logs de aplicativo e informações de cluster para o Suporte da UiPath.

A ferramenta de pacote de suporte do Automation Suite coleta logs no nível do aplicativo de serviços da UiPath® e outros componentes de software, como Istio e ArgoCD. A ferramenta de pacote de suporte do Automation Suite também contém registros históricos que você pode usar para analisar padrões ao solucionar um problema. Logs detalhados são especialmente úteis quando a possível causa raiz de um problema não é evidente apenas examinando o estado do cluster.

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

Observação:

A ferramenta de 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 nenhuma informação confidencial em seus registros. No nível da plataforma, o coletor de logs foi projetado para mascarar essas informações críticas.

A telemetria de uso 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 optar por não gerar essa telemetria resumida listando service-metrics na lista de excluídos no Automation Suite 2.2510 e superior.

Gerar o pacote de suporte

Para gerar o pacote de suporte, execute o seguinte comando:

./uipathctl health bundle input.json --versions versions.json

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

A tabela a seguir lista os sinalizadores opcionais compatíveis com 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 service-metrics).
--limit-bytes int	Limita o tamanho dos logs de pods em execução fornecendo o valor inteiro em bytes.

Estrutura do pacote de suporte do Automation Suite

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

Arquivo/Pasta	Description
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.
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.