إطار عمل التتبع الموزع لدليل مستخدم BPA الإصدار 5.1

• المقدمة
  • زيبكين
  • @opentelemetry/API
• المكونات الرئيسية
• المتطلبات الأساسية
  • متطلبات الشبكة
• يقوم Docker بتكوين عملية النشر
  • تمكين ملف تعريف المراقبة
  • التحقق من حاوية Zipkin
• تمكين التتبع في الخدمات
  • تشكيل تحميل التدرج الهرمي
    • التكوين الخاص ب POD
      • حالة الاستخدام
      • مثال سيناريو
    • التكوين العام
      • حالة الاستخدام
      • مثال سيناريو
    • التكوين الاحتياطي
      • حالة الاستخدام
  • إعداد تكوين التتبع
    • خصائص التكوين
  • تطبيق تغييرات التكوين
    • أمر ترقية Helm
• نشر Kubernetes و Helm
  • تمكين المراقبة في القيم
  • نشر خدمة Zipkin
  • التحقق من النشر
  • التحقق من حالة الخدمة
• الوصول والمراقبة
  • الوصول إلى لوحة معلومات Zipkin من عقدة واحدة
  • وصول Kubernetes إلى لوحة معلومات Zipkin ذات 3 عقد
  • إستخدام واجهة مستخدم Zipkin
• أجهزة التتبع والبث

المقدمة

زيبكين

Zipkin هو نظام تتبع موزع يساعد على تجميع بيانات التوقيت المطلوبة لاستكشاف أخطاء زمن الوصول وإصلاحها في بنية الخدمة. يوفر هذا الدليل تعليمات لنشر Zipkin وتمكين التتبع عبر خدمات منصة BPA.

@opentelemetry/API

حزمة @opentelemetry/api هي واجهة برمجة تطبيقات OpenTeleEmetry في Node.js. وهو يوفر واجهات وفئات لإنشاء وإدارة المسارات والمفسحة بين دعامتين ونشر السياق. تسمح هذه الحزمة للمطورين بتهيئة تطبيقاتهم لجمع بيانات القياس عن بعد مثل التتبع والمقاييس، والتي يمكن تصديرها بعد ذلك إلى نهايات خلفية مثل Zipkin للتحليل.

المكونات الرئيسية

تتضمن المكونات الرئيسية ل Zipkin ما يلي:

• خادم Zipkin: مجمع التتبع المركزي وواجهة المستخدم (UI)
• OpenTelemetry: مكتبة الأدوات الخاصة بالتتبع
• البحث المرن: وحدة التخزين الخلفية لبيانات التتبع
• طبقة مآخذ التوصيل الآمنة (SSL) وأمان طبقة النقل (TLS): توفر اتصال آمن

المتطلبات الأساسية

متطلبات الشبكة

لنشر Zipkin وتمكين التتبع، يلزم توفر متطلبات الشبكة التالية:

• المنفذ 9412: نقطة نهاية واجهة برمجة التطبيقات (API) لبروتوكول نقل النص التشعبي الآمن (HTTPS) ل Zipkin
• المنفذ 9411: نقطة نهاية إدارة بروتوكول نقل النص التشعبي (HTTP) من Zipkin
• المنفذ 9200: الوصول إلى مجموعة Elasticsearch

يقوم Docker بتكوين عملية النشر

تمكين ملف تعريف المراقبة

1. ابدأ إرساء BPA المكون من 1 عقدة من المسار التالي:

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

2. قم بتشغيل النص التنفيذي باستخدام خيار المراقبة باستخدام الأمر التالي:

   ./startbpa.1node.sh monitoring

التحقق من حاوية Zipkin

1. للتحقق من حالة الحاوية، قم بتشغيل الأمر التالي:

   docker ps | grep tracers-zipkin

2. لعرض سجلات حاوية Zipkin. قم بتشغيل الأمر التالي:

   docker logs tracers-zipkin -f

تمكين التتبع في الخدمات

يدعم تطبيق BPA تكوين التتبع المرن من خلال ملفات "traceConfig.json". يقوم النظام بتنفيذ آلية تحميل تهيئة هرمية مع ثلاثة مستويات من الأسبقية لاستيعاب سيناريوهات نشر مختلفة.

تشكيل تحميل التدرج الهرمي

يقوم التطبيق بتحميل تكوينات التتبع بالترتيب التالي بناء على الأسبقية:

التكوين الخاص ب POD

المسار: bpa-helm-chart/charts/<service name>/public_conf

حالة الاستخدام

• تكوين التتبع الفردي الخاص ب pod
• السماح بإعدادات تتبع مختلفة لخدمات أو أجهزة PODS معينة
• يتطلب الوضع اليدوي: يجب على المستخدمين وضع هذا الملف يدويا في مسار المجلد pod': bpa-helm-chart/charts/<service name>/public_conf

مثال سيناريو

• تمكين التتبع التفصيلي للخدمات الهامة فقط
• معدلات أخذ العينات المختلفة لخدمات مجهرية مختلفة
• التتبع الخاص بتصحيح الأخطاء لملفات أستكشاف الأخطاء وإصلاحها

التكوين العام

المسار: bpa-helm-chart/bpa/conf/common/globals/tracingConfig.json

حالة الاستخدام

• تكوين التتبع العام لجميع الحاويات والبطاقات
• إدارة التتبع المركزي
• التأثير العالمي: تؤثر التغييرات التي تمت على هذا الملف على كافة ملفات PODS في النشر

مثال سيناريو

• تمكين التتبع وتعطيله عبر نشر BPA بالكامل
• تعيين سياسات التتبع الموحدة لبيئة الإنتاج
• متطلبات مركزية للتوافق والمراقبة

التكوين الاحتياطي

المسار: ../conf/tracingConfig.json (إحتياطي)

حالة الاستخدام

• تكوين التتبع الافتراضي المضمن مع التطبيق
• الإعدادات الافتراضية لبيئة التطوير
• يضمن عدم فشل التطبيق أبدا بسبب تكوين التتبع المفقود

إذا كان أي ملف تكوين غير صحيح أو غير قابل للقراءة، فإن النظام:

• تسجيل الخطأ
• الافتراضيات ل {enable: خطأ} لمنع حالات فشل التتبع
• إستمرار بدء تشغيل التطبيق

إعداد تكوين التتبع

قم بإنشاء أو تحديث ملف "traceConfig.json" بالمحتوى التالي في مسار المجلد pod':

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

الأمثلة:

• لتمكين التتبع

  {
  
          "enable": true
  
      }

• لتعطيل التتبع:

  {
  
        "enable": false
  
      }

خصائص التكوين

• enable (منطقي) (مطلوب): التحكم في تمكين التتبع أو تعطيله للتطبيق
• صحيح: تمكين التتبع الموزع
  • يقوم التطبيق بتهيئة مساعد التتبع
  • يتم تجميع المسارات وإرسالها إلى الخلفية التي تم تكوينها
  • تم تنشيط قدرات مراقبة الأداء وتصحيح الأخطاء
• خطأ: تعطيل التتبع الموزع
  • لا توجد مصاريف تتبع فوق أداء التطبيق
  • لا توجد مجموعة بيانات تتبع أو نقل
  • يتم تشغيل التطبيق بدون أدوات التتبع

تطبيق تغييرات التكوين

أمر ترقية Helm

بعد وضع ملفات "traceConfig.json" في المواقع المناسبة، قم بتطبيق التغييرات باستخدام الأمر "ترقية عملية التشغيل":

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

تصنيف الأوامر:

• ترقية هيكله: تحديث إصدار موجود من "إدارة الأجهزة"
• BPA-rel: اسم إصدار رأس BPA
• — مساحة الاسم bpa-ns: يحدد مساحة اسم Kubernetes حيث يتم نشر BPA
• /opt/bpa-helm-chart: المسار إلى دليل مخطط BPA

نشر Kubernetes و Helm

تمكين المراقبة في القيم

في مسار مخطط Helm التالي، قم بتحرير قيم Helm في ملف "Values.yaml" لتمكين المراقبة:

yaml
  global:
  enableMonitoring: true

نشر خدمة Zipkin

قم بنشر خدمة Zipkin باستخدام الأمر Helm التالي:

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

التحقق من النشر

أستخدم الأوامر التالية للتحقق من النشر:

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

التحقق من حالة الخدمة

لعرض سجلات POD، أستخدم الأمر التالي:

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

للتحقق من نقاط نهاية الخدمة، أستخدم الأمر التالي:

kubectl describe svc tracers-zipkin -n bpa-ns

الوصول والمراقبة

الوصول إلى لوحة معلومات Zipkin من عقدة واحدة

URL: https://<server ip>:9412/zipkin/

وصول Kubernetes إلى لوحة معلومات Zipkin ذات 3 عقد

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

إستخدام واجهة مستخدم Zipkin

توفر لوحة معلومات Zipkin واجهة مستخدم للبحث عن التتبع وتخيله. وتتضمن المكونات الرئيسية ما يلي:

• القائمة المنسدلة لاسم الخدمة: تتبع عامل التصفية حسب اسم الخدمة

اسم الخدمة

• محدد النطاق الزمني: تعريف الإطار الزمني للبحث عن التتبع

• قائمة التتبع: يعرض قائمة من المسارات مطابقة لمعايير البحث

• تتبع المخطط الزمني: التمثيل المرئي للفواصل الزمنية (أي فسحة بين دعامتين) ضمن تتبع

• فسحة بين دعامتين تفاصيل: عرض مفصل لكل فسحة بين دعامتين، بما في ذلك المدة، العلامات، والسجلات.

أجهزة التتبع والبث

تتتبع المسارات مسؤولة عن إنشاء وإدارة البسطات. يتم إقران أداة التتبع مع خدمة معينة أو مكون تطبيق معين. تمثل الشقق وحدة عمل واحدة أو عملية واحدة ضمن مسار. يحتوي كل فسحة بين دعامتين على معلومات مثل اسم العملية، وقت البدء والانتهاء، السمات، وعلاقات الأصل-التابع مع الفسحة بين دعامتين أخرى.