BPA-gebruikershandleiding Distributed Tracing Framework v5.1

• Inleiding
  • Zipkin
  • @OpenTelemetry/API
• Belangrijkste onderdelen
• Voorwaarden
  • Netwerkvereisten
• Docker componeert implementatie
  • Bewakingsprofiel inschakelen
  • Zipkin-container controleren
• Tracering in services inschakelen
  • Configuratie Laden Hiërarchie
    • POD-specifieke configuratie
      • Use case
      • Voorbeeldscenario
    • globale configuratie
      • Use case
      • Voorbeeldscenario
    • noodconfiguratie
      • Use case
  • Trackingconfiguratie instellen
    • Configuratie-eigenschappen
  • Configuratiewijzigingen toepassen
    • Helm-upgrade, opdracht
• Kubernetes- en Helm-implementatie
  • Controle in waarden inschakelen
  • Zipkin-service implementeren
  • Implementatie controleren
  • Servicestatus controleren
• Toegang en monitoring
  • 1-knooppunt toegang tot Zipkin Dashboard
  • 3-knooppunten Kubernetes Toegang tot Zipkin Dashboard
  • Zipkin UI gebruiken
• Tracers en overspanningen

Inleiding

Zipkin

Zipkin is een gedistribueerd traceringssysteem dat helpt bij het verzamelen van timinggegevens die nodig zijn om latentieproblemen in de servicearchitectuur op te lossen. Deze handleiding bevat instructies voor het implementeren van Zipkin en het inschakelen van tracering over BPA-platformservices.

@OpenTelemetry/API

Het pakket @opentelemetry/api is de kern-API voor OpenTelemetry in Node.js. Het biedt interfaces en klassen voor het maken en beheren van sporen, reeksen en contextpropagatie. Met dit pakket kunnen ontwikkelaars hun applicaties instrumenteren om telemetriegegevens te verzamelen, zoals sporen en statistieken, die vervolgens kunnen worden geëxporteerd naar backends zoals Zipkin voor analyse.

Belangrijkste onderdelen

De belangrijkste componenten van Zipkin zijn:

• Zipkin-server: centrale traceringscollector en gebruikersinterface (UI)
• OpenTelemetry: instrumentatiebibliotheek voor tracering
• Elasticsearch: opslagbackend voor traceringsgegevens
• Secure Sockets Layer (SSL) en Transport Layer Security (TLS): biedt veilige communicatie

Voorwaarden

Netwerkvereisten

Om Zipkin te implementeren en tracing in te schakelen, zijn de volgende netwerkvereisten vereist:

• Poort 9412: API-eindpunt voor Zipkin Hypertext Transfer Protocol Secure (HTTPS)
• Poort 9411: beheerseindpunt van het Zipkin Hypertext Transfer Protocol (HTTP)
• Port 9200: toegang tot Elasticsearch-cluster

Docker componeert implementatie

Bewakingsprofiel inschakelen

1. Start de BPA 1-node docker vanaf het volgende pad:

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

2. Voer het bash-script uit met de monitoringoptie met de volgende opdracht:

   ./startbpa.1node.sh monitoring

Zipkin-container controleren

1. Voer de volgende opdracht uit om de status van de container te controleren:

   docker ps | grep tracers-zipkin

2. Om de logs van een Zipkin container te bekijken. voer de volgende opdracht uit:

   docker logs tracers-zipkin -f

Tracering in services inschakelen

De BPA-toepassing ondersteunt flexibele tracingconfiguratie via "tracingConfig.json"-bestanden. Het systeem implementeert een hiërarchisch configuratieladingsmechanisme met drie (3) prioriteitsniveaus om verschillende implementatiescenario's aan te passen.

Configuratie Laden Hiërarchie

De toepassing laadt de traceringsconfiguraties in de volgende volgorde op basis van prioriteit:

POD-specifieke configuratie

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

Use case

• Individuele, pod-specifieke tracingconfiguratie
• Maakt verschillende traceringsinstellingen voor specifieke services of pods mogelijk
• Handmatige plaatsing vereist: gebruikers moeten dit bestand handmatig in het pad van de map van de pod plaatsen: bpa-helm-chart/charts/<service name>/public_conf

Voorbeeldscenario

• Gedetailleerde tracering alleen voor kritieke services inschakelen
• Verschillende bemonsteringssnelheden voor verschillende microservices
• Foutopsporingsspecifiek voor probleemoplossende pods

globale configuratie

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

Use case

• Globale tracingconfiguratie voor alle containers en pods
• Gecentraliseerd traceringsbeheer
• Globale impact: wijzigingen in dit bestand zijn van invloed op alle pods in de implementatie

Voorbeeldscenario

• Overtrekken voor de volledige BPA-implementatie in- en uitschakelen
• Een uniform traceringsbeleid voor de productieomgeving vaststellen
• Gecentraliseerde nalevings- en monitoringvereisten

noodconfiguratie

Pad: ../conf/tracingConfig.json (noodoplossing)

Use case

• Standaardtraceringsconfiguratie meegeleverd met de toepassing
• Standaardwaarden voor ontwikkelomgeving
• Zorgt ervoor dat de toepassing nooit uitvalt vanwege een ontbrekende traceringsconfiguratie

Als een configuratiebestand onjuist of onleesbaar is, doet het systeem het volgende:

• Registreert de fout
• Standaard {enable: false} om traceringsfouten te voorkomen
• Doorgaan met opstarten van toepassing

Trackingconfiguratie instellen

Maak of werk het bestand "tracingConfig.json" bij met de volgende inhoud in het mappad van de pod:

BPA-helm-chart/charts/<Service Name>/public_conf/

Voorbeelden:

• Overtrekken inschakelen

  {
  
          "enable": true
  
      }

• Overtrekken uitschakelen:

  {
  
        "enable": false
  
      }

Configuratie-eigenschappen

• inschakelen (boolean)(vereist): bepaalt of overtrekken is ingeschakeld of uitgeschakeld voor de toepassing
• true: maakt gedistribueerde tracering mogelijk
  • Toepassing initialiseert de traceringshelper
  • Traces worden verzameld en naar de geconfigureerde backend verzonden
  • Functies voor prestatiecontrole en foutopsporing geactiveerd
• false: hiermee wordt gedistribueerde overtrekken uitgeschakeld
  • Geen overheadkosten bij prestaties van toepassing
  • Geen traceringsgegevensverzameling of -overdracht
  • Toepassing loopt zonder traceringsinstrumentatie

Configuratiewijzigingen toepassen

Helm-upgrade, opdracht

Nadat u de bestanden "tracingConfig.json" op de juiste locaties hebt geplaatst, past u de wijzigingen toe met de opdracht Helm-upgrade:

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

Opdrachtuitsplitsing:

• helm upgrade: Updates van een bestaande Helm release
• bpa-rel: Naam van de BPA Helm release
• --namespace bpa-ns: Hiermee geeft u de Kubernetes-naamruimte op waar BPA wordt geïmplementeerd
• /opt/bpa-helm-chart: Pad naar de BPA Helm chart directory

Kubernetes- en Helm-implementatie

Controle in waarden inschakelen

Bewerk in het volgende pad van het Helmdiagram de Helmwaarden in het bestand "values.yaml" om controle in te schakelen:

yaml
  global:
  enableMonitoring: true

Zipkin-service implementeren

Implementeer de Zipkin-service met de volgende opdracht Helm:

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

Implementatie controleren

Gebruik de volgende opdrachten om de implementatie te controleren:

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

Servicestatus controleren

Gebruik de volgende opdracht om pod-logs te bekijken:

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

Gebruik de volgende opdracht om service-eindpunten te controleren:

kubectl describe svc tracers-zipkin -n bpa-ns

Toegang en monitoring

1-knooppunt toegang tot Zipkin Dashboard

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

3-knooppunten Kubernetes Toegang tot Zipkin Dashboard

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

Zipkin UI gebruiken

Het Zipkin-dashboard biedt een gebruikersinterface om sporen te zoeken en te visualiseren. Belangrijke onderdelen zijn onder meer:

• Servicenaam Dropdown: Traces filteren op servicenaam

Servicenaam

• Tijdsbereikkiezer: het tijdsvenster voor de zoekopdracht voor overtrekken definiëren

• Trace List: geeft een lijst weer met sporen die voldoen aan de zoekcriteria

• Trace Timeline: Visuele weergave van tijdsintervallen (d.w.z. spanwijdte) binnen een trace

• Spandetails: Gedetailleerde weergave van elke reeks, inclusief duur, tags en logs.

Tracers en overspanningen

Tracers zijn verantwoordelijk voor het maken en beheren van overspanningen. Een tracer is gekoppeld aan een specifieke service of toepassingscomponent. Spans vertegenwoordigen een enkele eenheid van werk of werking binnen een spoor. Elke reeks bevat informatie zoals de naam van de bewerking, de begin- en eindtijd, kenmerken en ouder-kind-relaties met andere reeksen.