Introdução ao Agente de Diagnóstico Java
Este artigo descreve como começar a usar o Java Diagnostic Agent. Ele também descreve a ferramenta de diagnóstico Java no plugin AKS para IntelliJ IDEA.
O Java Diagnostic Agent é um agente Java para solucionar problemas de um processo Java. Ele não precisa reconstruir, reimplantar ou reiniciar um aplicativo. Atualmente, ele suporta a adição de logs em torno de uma função em uma classe Java. Quando a função é chamada, o log é impresso junto com um cálculo do tempo total consumido pela função.
Pré-requisitos
diag4j está instalado no cluster.
Java LTS versão 11, 17 ou 21.
O plug-in IntelliJ IDEA , instalado localmente através de Configurações>Plugins>Instalar plug-in a partir do disco.
Aplicativos Java para solucionar problemas. Para obter mais informações, consulte Implantar o aplicativo Spring Boot no Serviço Kubernetes do Azure.
Estabelecer encaminhamento de porta
Use o seguinte comando para estabelecer o reencaminhamento de porta para o serviço do agente:
kubectl port-forward svc/diag4j-agent-service -n <namespace> <port>:8080
Use a ferramenta de diagnóstico do Java no plug-in AKS para IntelliJ IDEA
Você pode usar a Ferramenta de Diagnóstico Java no plug-in AKS para anexar o Agente de Diagnóstico Java ao aplicativo Java em execução em um contêiner pod em um cluster do Serviço Kubernetes do Azure (AKS).
Depois de anexar o agente, ele permite que você execute tarefas de solução de problemas, como adicionar logs em torno de uma função de classe. Você pode usar esse log para testar se a função é executada e para calcular o tempo total gasto na função. Essa análise pode ajudá-lo a localizar gargalos de desempenho em seu aplicativo.
A configuração do plug-in é mostrada na guia de diagnóstico. Aqui, você pode fazer as seguintes tarefas:
- Configure a porta local que encaminha para o serviço de agente.
- Veja os pods listados com
kubeconfigem seu ambiente local. - Selecione Atualizar para atualizar a tabela de pods. Após alternares os clusters, deves atualizar a tabela para carregar os pods no novo cluster.
Anexar o agente
O contêiner pod deve ter uma pasta /tmp e deve ter permissão de gravação para a pasta /tmp.
Para habilitar a conexão do agente na JVM, certifique-se de não adicionar -XX:+DisableAttachMechanism às opções da JVM.
O servidor de diagnóstico de back-end é fechado após 6 horas.
Para anexar o agente, clique no pod ao qual deseja anexar o agente e selecione o contêiner. Você só pode conectar o agente a um contêiner no pod. Em seguida, aguarde a conclusão do processo de anexo.
Definir contentor ativo do pod
Depois de anexar o agente com êxito, você pode usá-lo para solução de problemas.
Vários pods podem ter injetado o agente, por isso deve-se definir um pod como ativo. No IntelliJ IDEA, no separador de Diagnóstico, clique com o botão direito do rato num pod e, em seguida, selecione Selecionar como oativo.
Adicionar registo para uma função de classe
O log configurado é removido automaticamente após 30 minutos.
Você pode usar a ferramenta para adicionar registo nas funções de classe, mas não nas interfaces, construtores, etc.
Para adicionar registo em log a uma função, clique com o botão direito do rato sobre a função no editor e selecione Diagnóstico Java>Adicionar AroundLog, conforme mostrado na captura de ecrã a seguir.
Neste exemplo, depois de adicionar o log, você pode chamar <host>/infor para ver uma saída semelhante ao exemplo a seguir antes e depois que a função for chamada:
===== START ===== Method: updateInformation Start Time: 2024-12-12T07:37:55.404107848Z
Done with the validation
Done with the DB access
Done with the data filtering
===== END ===== Method: updateInformation End Time: 2024-12-12T07:37:55.404316940Z Total Time: 0 milliseconds
Remover todos os logs configurados
Para remover todos os logs adicionados pelo agente, selecione Remover todos os AroundLogs.
Observação
O agente Java de back-end é usado por um contêiner efémero no pod. Depois de o pod ser reiniciado, o agente será removido.
Solução de problemas
Um timeout pode ocorrer quando se tenta anexar o agente a um pod em execução num nó que não tenha ainda habilitado o recurso. O tempo limite pode ocorrer porque o nó deve primeiro recuperar a imagem do agente, o que causa um atraso. Quando isso ocorre, pode selecionar Atualizar para verificar se o agente foi anexado ou pode tentar anexar o agente novamente.
Se o anexo falhar, você pode verificar o log chamado diagnostic-container-<hashcode> no contêiner efêmero.
Você pode encontrar informações sobre as operações do plugin nos logs sob o contêiner pod chamado diag4j-agent-service-<hashcode>.
Próximo passo
Introdução ao componente Spring Boot Admin da Ferramenta de Diagnóstico Java (diag4j) no AKS