Guía del usuario de BPA sobre Distributed Tracing Framework v5.1

• Introducción
  • Cremallera
  • @opentelemetry/api
• Componentes clave
• Prerequisites
  • Requisitos de la red
• Docker crea la implementación
  • Activación del perfil de supervisión
  • Verificación del contenedor Zipkin
• Habilitación del seguimiento en los servicios
  • Jerarquía de carga de configuración
    • Configuración específica de POD
      • caso de uso
      • Situación de ejemplo
    • Configuración global
      • caso de uso
      • Situación de ejemplo
    • Configuración de reserva
      • caso de uso
  • Establecer configuración de seguimiento
    • Propiedades de configuración
  • Aplicación de cambios de configuración
    • Comando Helm Upgrade
• Implementación de Kubernetes y Helm
  • Habilitación de la supervisión en valores
  • Implementación del servicio Zipkin
  • Verificación de la implementación
  • Comprobación del estado del servicio
• Acceso y supervisión
  • Acceso de 1 nodo al panel de cremallera
  • Acceso de Kubernetes de 3 nodos al panel de Zipkin
  • Uso de Zipkin UI
• Trazadores y extensiones

Introducción

Cremallera

Zipkin es un sistema de seguimiento distribuido que ayuda a recopilar los datos de tiempo necesarios para solucionar los problemas de latencia en la arquitectura de servicio. Esta guía proporciona instrucciones para implementar Zipkin y habilitar el seguimiento en los servicios de la plataforma BPA.

@opentelemetry/api

El paquete @opentelemetry/api es la API principal para OpenTelemetry en Node.js. Proporciona interfaces y clases para crear y administrar seguimientos, extensiones y propagación de contexto. Este paquete permite a los desarrolladores instrumentar sus aplicaciones para recopilar datos de telemetría, como rastros y métricas, que luego se pueden exportar a motores como Zipkin para su análisis.

Componentes clave

Los componentes clave de Zipkin incluyen:

• Servidor Zipkin: Recopilador de seguimiento central e interfaz de usuario (IU)
• Telemetría abierta: Biblioteca de instrumentación para seguimiento
• Elasticsearch: Motor de almacenamiento para datos de seguimiento
• Secure Sockets Layer (SSL) y Transport Layer Security (TLS): Proporciona una comunicación segura

Prerequisites

Requisitos de la red

Para implementar Zipkin y habilitar el seguimiento, se requieren los siguientes requisitos de red:

• Port 9412: Extremo API de protocolo de transferencia de hipertexto seguro (HTTPS) Zipkin
• Port 9411: Extremo de administración del Protocolo de transferencia de hipertexto (HTTP) Zipkin
• Port 9200: Acceso al clúster Elasticsearch

Docker crea la implementación

Activación del perfil de supervisión

1. Inicie el acoplador de 1 nodo BPA desde la siguiente ruta:

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

2. Ejecute la secuencia de comandos bash con la opción de supervisión mediante el siguiente comando:

   ./startbpa.1node.sh monitoring

Verificación del contenedor Zipkin

1. Para comprobar el estado del contenedor, ejecute el siguiente comando:

   docker ps | grep tracers-zipkin

2. Para ver los registros de un contenedor Zipkin. ejecute el siguiente comando:

   docker logs tracers-zipkin -f

Habilitación del seguimiento en los servicios

La aplicación BPA admite una configuración de seguimiento flexible a través de los archivos "traceConfig.json". El sistema implementa un mecanismo de carga de configuración jerárquico con tres (3) niveles de precedencia para dar cabida a diferentes escenarios de implementación.

Jerarquía de carga de configuración

La aplicación carga las configuraciones de seguimiento en el orden siguiente en función de la precedencia:

Configuración específica de POD

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

caso de uso

• Configuración de seguimiento individual específica de grupo de dispositivos
• Permite una configuración de seguimiento diferente para servicios o grupos de dispositivos específicos
• Colocación manual requerida: Los usuarios deben colocar manualmente este archivo en la ruta de la carpeta del grupo de dispositivos: bpa-helm-chart/charts/<service name>/public_conf

Situación de ejemplo

• Habilitar el seguimiento detallado solo para servicios críticos
• Diferentes tasas de muestreo para diferentes microservicios
• Seguimiento específico de depuración para grupos de solución de problemas

Configuración global

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

caso de uso

• Configuración de seguimiento global para todos los contenedores y grupos de dispositivos
• Administración de seguimiento centralizada
• Impacto global: Los cambios realizados en este archivo afectan a todos los grupos de dispositivos de la implementación

Situación de ejemplo

• Habilitar y deshabilitar el seguimiento en toda la implementación de BPA
• Establecer políticas de seguimiento uniformes para el entorno de producción
• Cumplimiento y requisitos de supervisión centralizados

Configuración de reserva

Ruta: ../conf/tracingConfig.json (reserva)

caso de uso

• Configuración de seguimiento predeterminada incluida con la aplicación
• Valores predeterminados del entorno de desarrollo
• Garantiza que la aplicación nunca falle debido a una configuración de seguimiento que falta

Si algún archivo de configuración está mal formado o es ilegible, el sistema:

• Registra el error
• El valor predeterminado es {enable: false} para evitar errores de seguimiento
• Continúa el inicio de la aplicación

Establecer configuración de seguimiento

Cree o actualice el archivo "traceConfig.json" con el siguiente contenido en la ruta de la carpeta del grupo de dispositivos:

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

Examples:

• Para habilitar el seguimiento

  {
  
          "enable": true
  
      }

• Para deshabilitar el seguimiento:

  {
  
        "enable": false
  
      }

Propiedades de configuración

• enable (boolean)(required): Controla si el seguimiento está habilitado o deshabilitado para la aplicación
• verdadero: Habilita el seguimiento distribuido
  • La aplicación inicializa el ayudante de seguimiento
  • Los seguimientos se recopilan y se envían al backend configurado
  • Capacidades de depuración y supervisión del rendimiento activadas
• falso: Deshabilita el seguimiento distribuido
  • Sin sobrecarga de seguimiento en el rendimiento de la aplicación
  • Sin recopilación ni transmisión de datos de seguimiento
  • La aplicación se ejecuta sin instrumentación de seguimiento

Aplicación de cambios de configuración

Comando Helm Upgrade

Después de colocar los archivos "traceConfig.json" en las ubicaciones apropiadas, aplique los cambios mediante el comando Helm upgrade:

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

Desglose de comandos:

• actualización de helm: Actualiza una versión de Helm existente
• bpa-rel: Nombre de la versión de BPA Helm
• —namespace bpa-ns: Especifica el espacio de nombres de Kubernetes donde se implementa BPA
• /opt/bpa-helm-chart: Ruta de acceso al directorio de gráficos de BPA Helm

Implementación de Kubernetes y Helm

Habilitación de la supervisión en valores

En la siguiente ruta del gráfico del timón, edite los valores del timón en el archivo "values.yaml" para habilitar la supervisión:

yaml
  global:
  enableMonitoring: true

Implementación del servicio Zipkin

Implemente el servicio Zipkin con el siguiente comando Helm:

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

Verificación de la implementación

Utilice los siguientes comandos para verificar la implementación:

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

Comprobación del estado del servicio

Para ver los registros de grupo de dispositivos, utilice el siguiente comando:

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

Para comprobar los extremos del servicio, utilice el siguiente comando:

kubectl describe svc tracers-zipkin -n bpa-ns

Acceso y supervisión

Acceso de 1 nodo al panel de cremallera

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

Acceso de Kubernetes de 3 nodos al panel de Zipkin

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

Uso de Zipkin UI

El panel de Zipkin proporciona una interfaz de usuario para buscar y visualizar rastros. Los componentes clave son:

• Menú desplegable Nombre de servicio: Filtrar seguimientos por nombre de servicio

Nombre del servicio

• Selector de rango de tiempo: Definir la ventana de tiempo para la búsqueda de seguimiento

• Lista de seguimiento: Muestra una lista de los seguimientos que coinciden con los criterios de búsqueda

• Línea de tiempo de seguimiento: Representación visual de intervalos de tiempo (es decir, span) dentro de un seguimiento

• Detalles del tramo: Vista detallada de cada tramo, incluida la duración, las etiquetas y los registros.

Trazadores y extensiones

Los rastreadores son responsables de crear y administrar los tramos. Un rastreador está asociado a un servicio o componente de aplicación específico. Los tramos representan una sola unidad de trabajo u operación dentro de un seguimiento. Cada tramo contiene información como el nombre de la operación, la hora de inicio y finalización, los atributos y las relaciones principal-secundario con otros tramos.