Guia do usuário do BPA Estrutura de rastreamento distribuído v5.1

• Introdução
  • Zipkin
  • @opentelemetry/API
• Principais componentes
• Pré-requisitos
  • Requisitos de Rede
• O Docker compõe a implantação
  • Ativando o perfil de monitoramento
  • Verificando o recipiente Zipkin
• Ativando o Rastreamento em Serviços
  • Hierarquia de Carregamento de Configuração
    • Configuração Específica Do Pod
      • Caso de uso
      • Cenário de exemplo
    • Configuração global
      • Caso de uso
      • Cenário de exemplo
    • Configuração de Fallback
      • Caso de uso
  • Definindo Configuração de Rastreamento
    • Propriedades de configuração
  • Aplicando alterações de configuração
    • Comando de atualização do Helm
• Distribuição de Kubernetes e Helm
  • Ativando Monitoramento em Valores
  • Implantação do serviço Zipkin
  • Verificação da Implantação
  • Verificando o status do serviço
• Acesso e monitoramento
  • Acesso de 1 nó ao painel Zipkin
  • Acesso Kubernetes de 3 nós ao painel Zipkin
  • Usando a IU Zipkin
• Rastreadores e Spans

Introdução

Zipkin

O Zipkin é um sistema de rastreamento distribuído que ajuda a coletar dados de temporização necessários para solucionar problemas de latência na arquitetura de serviço. Este guia fornece instruções para a implantação do Zipkin e a habilitação do rastreamento nos serviços da plataforma BPA.

@opentelemetry/API

O pacote @opentelemetry/api é a API central para OpenTelemetry em Node.js. Ele fornece interfaces e classes para criar e gerenciar rastreamentos, extensões e propagação de contexto. Esse pacote permite que os desenvolvedores instrumentem seus aplicativos para coletar dados de telemetria, como rastreamentos e métricas, que podem ser exportados para back-ends como Zipkin para análise.

Principais componentes

Os principais componentes da Zipkin incluem:

• Servidor Zipkin: Coletor de rastreamento central e Interface de Usuário (UI)
• Telemetria aberta: Biblioteca de instrumentação para rastreamento
• Pesquisa elástica: Infraestrutura de armazenamento para dados de rastreamentoName
• Secure Sockets Layer (SSL) e Transport Layer Security (TLS): Fornece comunicação segura

Pré-requisitos

Requisitos de Rede

Para implantar o Zipkin e habilitar o rastreamento, os seguintes requisitos de rede são necessários:

• Porta 9412: Ponto de extremidade da API do Protocolo de Transferência de Hipertexto Zipkin Seguro (HTTPS)
• Porta 9411: Ponto de extremidade de gerenciamento do Protocolo de Transferência de Hipertexto (HTTP) Zipkin
• Porta 9200: Acesso ao cluster Elasticsearch

O Docker compõe a implantação

Ativando o perfil de monitoramento

1. Inicie o docker de 1 nó BPA no seguinte caminho:

   cd /opt/bpa/bpa-{build_version}/scripts

2. Execute o script bash com a opção de monitoramento usando o seguinte comando:

   ./startbpa.1node.sh monitoring

Verificando o recipiente Zipkin

1. Para verificar o status do contêiner, execute o seguinte comando:

   docker ps | grep tracers-zipkin

2. Para exibir os logs de um recipiente Zipkin. execute o seguinte comando:

   docker logs tracers-zipkin -f

Ativando o Rastreamento em Serviços

O aplicativo BPA oferece suporte à configuração de rastreamento flexível através de arquivos "tracingConfig.json". O sistema implementa um mecanismo de carregamento de configuração hierárquica com três (3) níveis de precedência para acomodar diferentes cenários de implantação.

Hierarquia de Carregamento de Configuração

O aplicativo carrega as configurações de rastreamento na seguinte ordem com base na precedência:

Configuração Específica Do Pod

Caminho: bpa-helm-chart/charts/<service name>/public_conf

Caso de uso

• Configuração de rastreamento individual e específica do pod
• Permite configurações de rastreamento diferentes para serviços ou pods específicos
• Posicionamento manual necessário: Os usuários devem colocar manualmente este arquivo no caminho da pasta do pod: bpa-helm-chart/charts/<service name>/public_conf

Cenário de exemplo

• Habilitar rastreamento detalhado somente para serviços críticos
• Taxas de amostragem diferentes para microsserviços diferentes
• Rastreamento específico de depuração para pods de solução de problemas

Configuração global

Caminho: bpa-helm-chart/bpa/conf/common/globals/tracingConfig.json

Caso de uso

• Configuração de rastreamento global para todos os contêineres e pods
• Gerenciamento centralizado de rastreamento
• Impacto global: As alterações neste arquivo afetam todos os pods na implantação

Cenário de exemplo

• Habilitar e desabilitar o rastreamento em toda a implantação do BPA
• Definir políticas uniformes de rastreamento para o ambiente de produção
• Requisitos de conformidade e monitoramento centralizados

Configuração de Fallback

Caminho: ../conf/tracingConfig.json (fallback)

Caso de uso

• Configuração de rastreamento padrão agrupada com o aplicativo
• Padrões do ambiente de desenvolvimento
• Garante que o aplicativo nunca falhe devido a uma configuração de rastreamento ausente

Se algum arquivo de configuração estiver malformado ou ilegível, o sistema:

• Registra o erro
• O padrão é {enable: false} para evitar falhas de rastreio
• Continua a inicialização do aplicativo

Definindo Configuração de Rastreamento

Crie ou atualize o arquivo "tracingConfig.json" com o seguinte conteúdo no caminho da pasta do pod:

bpa-helm-chart/charts/<service name>/public_conf/

Examples:

• Para ativar o rastreamento

  {
  
          "enable": true
  
      }

• Para desativar o rastreamento:

  {
  
        "enable": false
  
      }

Propriedades de configuração

• enable (booleano)(obrigatório): Controla se o rastreamento está ativado ou desativado para o aplicativo
• verdadeiro: Habilita o rastreamento distribuído
  • O aplicativo inicializa o auxiliar de rastreamento
  • Os rastreamentos são coletados e enviados para o back-end configurado
  • Recursos de depuração e monitoramento de desempenho ativados
• falso: Desabilita o rastreamento distribuído
  • Sem sobrecarga de rastreamento no desempenho do aplicativo
  • Sem coleta ou transmissão de dados de rastreamento
  • O aplicativo é executado sem rastrear a instrumentação

Aplicando alterações de configuração

Comando de atualização do Helm

Depois de colocar os arquivos "tracingConfig.json" nos locais apropriados, aplique as alterações usando o comando Helm upgrade:

helm upgrade bpa-rel --namespace bpa-ns /opt/bpa-helm-chart

Divisão de comando:

• upgrade de helm: Atualiza uma versão existente do Helm
• bpa-rel: Nome da versão do comando BPA
• —namespace bpa-ns: Especifica o namespace do Kubernetes onde o BPA é implantado
• /opt/bpa-helm-chart: Caminho para o diretório do gráfico Helm do BPA

Distribuição de Kubernetes e Helm

Ativando Monitoramento em Valores

No seguinte caminho do gráfico Helm, edite os valores Helm no arquivo "values.yaml" para ativar o monitoramento:

yaml
  global:
  enableMonitoring: true

Implantação do serviço Zipkin

Implante o serviço Zipkin usando o seguinte comando Helm:

helm install bpa-rel --create-namespace --namespace bpa-ns 

Verificação da Implantação

Use os seguintes comandos para verificar a implantação:

kubectl get pods -n bpa-ns | grep tracers-zipkin
kubectl get svc -n bpa-ns | grep tracers-zipkin

Verificando o status do serviço

Para exibir logs de pod, use o seguinte comando:

kubectl logs -n bpa-ns deployment/tracers-zipkin -f

Para verificar pontos finais de serviço, use o seguinte comando:

kubectl describe svc tracers-zipkin -n bpa-ns

Acesso e monitoramento

Acesso de 1 nó ao painel Zipkin

URL: https://<SERVER IP>:9412/zipkin/

Acesso Kubernetes de 3 nós ao painel Zipkin

URL: https://<cluster-ip>:30900/zipkin/

Usando a IU Zipkin

O painel do Zipkin fornece uma interface de usuário para pesquisar e visualizar rastreamentos. Os principais componentes incluem:

• Menu suspenso Nome do serviço: Filtrar rastreamentos por nome de serviço

Nome do serviço

• Seletor de intervalo de tempo: Definir a janela de tempo para a pesquisa de rastreamento

• Lista de rastreamento: Exibe uma lista de rastreamentos que correspondem aos critérios de pesquisa

• Rastrear Linha do Tempo: Representação visual de intervalos de tempo (ou seja, intervalo) dentro de um traçado

• Detalhes do intervalo: Exibição detalhada de cada intervalo, incluindo duração, marcas e logs.

Rastreadores e Spans

Os rastreadores são responsáveis por criar e gerenciar intervalos. Um rastreador é associado a um serviço específico ou componente de aplicativo. Os intervalos representam uma única unidade de trabalho ou operação dentro de um rastreamento. Cada intervalo contém informações como nome da operação, hora de início e término, atributos e relacionamentos pai-filho com outros intervalos.