استخدام أداة تتبع

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X.
معلومات

ما هي أداة التتبُّع؟

Trace هي أداة لتحديد المشاكل وحلّها ومراقبة الخوادم الوكيلة لواجهة برمجة التطبيقات التي تعمل على Apigee Edge. تتبُّع التحقق من تفاصيل كل خطوة من خلال مسار الخادم الوكيل لواجهة برمجة التطبيقات.

شاهد هذا الفيديو للاطلاع على مقدمة عن أداة التتبع.

كيفية استخدام Trace

Trace سهل الاستخدام. تبدأ جلسة تتبع، ثم تقوم بإجراء استدعاء واجهة برمجة التطبيقات إلى نظام Edge، وقراءة النتائج.

  1. يمكنك الدخول إلى صفحة الخوادم الوكيلة لواجهة برمجة التطبيقات، كما هو موضح أدناه.

    Edge

    للوصول إلى صفحة الخوادم الوكيلة لواجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge:

    1. سجِّل الدخول إلى apigee.com/edge.
    2. اختَر التطوير > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.

    الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)

    للوصول إلى صفحة الخوادم الوكيلة لواجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge الكلاسيكي:

    1. سجّل الدخول إلى http://ms-ip:9000، حيث ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
    2. حدد APIs > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل العلوي.
  2. حدد خادمًا وكيلاً لواجهة برمجة التطبيقات من صفحة "الخوادم الوكيلة لواجهة برمجة التطبيقات".
  3. تأكّد من نشر واجهة برمجة التطبيقات التي تريد تتبُّعها.
  4. انقر على Trace للانتقال إلى عرض "أداة التتبُّع".
  5. استخدِم القائمة المنسدلة النشر المطلوب تتبُّعه لاختيار بيئة النشر ومراجعة الخادم الوكيل التي تريد تتبعها.
  6. انقر على بدء جلسة تتبُّع. عندما تكون جلسة التتبع نشطة، يعمل الخادم الوكيل لواجهة برمجة التطبيقات تسجل تفاصيل كل خطوة في مسار المعالجة. أثناء تشغيل جلسة التتبع، يتم تسجيل الرسائل والبيانات السياقية من حركة البيانات المباشرة.

  7. إذا لم يكن لديك أي زيارات مباشرة تتدفق من خلال الخادم الوكيل، ما عليك سوى إرسال طلب. بواجهة برمجة التطبيقات. يمكنك استخدام أي أداة تريد إرسال الطلب إليها، مثل curl أو Postman أو أي أداة مألوفة. أو يمكنك إرسال الطلب مباشرةً من أداة التتبُّع نفسها. ما عليك سوى إدخال عنوان URL وانقر على إرسال. ملاحظة: لا يمكنك إرسال طلب GET إلا من أداة التتبع، وليس طلب POST.

    ملاحظة: يمكن أن تتيح جلسة تتبُّع واحدة 10 معاملات للطلبات/الاستجابة لكل إلى معالج الرسائل من خلال الخادم الوكيل المحدد لواجهة برمجة التطبيقات. في السحابة الإلكترونية Edge، مع معالِج بيانات للرسائل للتعامل مع حركة المرور، ويدعم 20 معاملة طلب/استجابة. تتبُّع جلسة تلقائيًا يتوقف بعد 10 دقائق إذا لم توقفه يدويًا.
  8. عند تسجيل عدد كافٍ من الطلبات، انقر على إيقاف التتبُّع. الجلسة.
  9. تظهر قائمة بمعاملات الطلبات/الاستجابة التي تم تسجيلها في القائمة اليمنى. انقر على أي من المعاملات لعرض النتائج التفصيلية.

كيفية قراءة بيانات التتبُّع

تتكون أداة التتبع من جزأين رئيسيين، وهما خريطة المعاملات وتفاصيل المرحلة:

  • تستخدم خريطة المعاملات رموزًا لتمييز كلّ المعاملات البارزة تحدث أثناء معاملة الخادم الوكيل لواجهة برمجة التطبيقات، بما في ذلك تنفيذ السياسة، والعمليات المشروطة والخطوات والانتقالات. مرِّر مؤشر الماوس فوق أي رمز لعرض الملخّص المعلومات. تظهر خطوات مسار الطلب أعلى خريطة المعاملات والردّ. خطوات التدفق على طول الجزء السفلي.
  • يسرد قسم تفاصيل المرحلة في الأداة المعلومات عن المعالجة الداخلية للخادم الوكيل، بما فيها المتغيرات التي تم ضبطها أو قراءتها، وعناوين الطلبات والاستجابة وغيرها الكثير. انقر على أي رمز لرؤية تفاصيل المرحلة لهذه الخطوة.

في ما يلي نموذج لخريطة أداة التتبُّع مع تصنيف المقاطع الرئيسية لمعالجة الخادم الوكيل:

خريطة المعاملات في "أداة التتبُّع"

خريطة المعاملات تسمية توضيحية

يوضّح الجدول التالي الغرض من الرموز التي ستظهر لك في العملية. الخريطة. تحدد هذه الرموز كل خطوة من خطوات المعالجة البارزة خلال تدفق الخادم الوكيل.

رموز خريطة المعاملات

تطبيق العميل الذي يرسل طلبًا إلى نقطة نهاية الخادم الوكيل للخادم الوكيل لواجهة برمجة التطبيقات
تحدد الدوائر نقاط نهاية انتقالية في تدفق الخادم الوكيل. تكون موجودة عندما الطلب يأتي من العميل، عندما ينتقل الطلب إلى الهدف، وعندما يكون الرد يعود من الهدف، وعندما يعود الرد إلى العميل.

تشير الأشرطة الطويلة إلى بداية مقطع التدفق في مسار الخادم الوكيل لواجهة برمجة التطبيقات. التدفق شرائح هي: طلب ProxyEndpoint وTargetEndpoint request وTargetEndpoint response ردّ ProxyEndpoint يتضمن أي جزء كلاً من PreFlow و"التدفقات الشرطية" PostFlow:

راجع إعداد التدفقات لمزيد من المعلومات.

يشير إلى تنفيذ إجراءات "إحصاءات Google" في الخلفية.

يشير ذلك المصطلح إلى تدفق شرطي يتم تقييمه على أنّه صحيح. للحصول على مقدمة حول التدفقات الشرطية، يُرجى الاطِّلاع على إعداد التدفقات.

لاحظ أن بعض الشروط يتم إنشاؤها من خلال Edge. على سبيل المثال، فيما يلي تعبير يستخدمه Edge للتحقق من حدوث خطأ في ProxyEndpoint:

((error.state equals PROXY_REQ_FLOW) or (error.state equals PROXY_RESP_FLOW))

يشير ذلك المصطلح إلى تدفق شرطي يتم تقييمه إلى false. للحصول على مقدمة عن الخوارزمية الشرطية ، يُرجى الاطِّلاع على إعداد التدفقات.

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

(((error.state equals TARGET_REQ_FLOW) or (error.state equals TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals RESP_START)))

السياسات لكل نوع من السياسات رمز فريد. هذا من أجل AssignMessage . تتيح لك هذه الرموز معرفة مكان تنفيذ السياسات بالترتيب الصحيح وما إذا سواء كانوا ناجحين أم لا. يمكنك النقر على رمز سياسة للاطلاع على نتائج وما إذا كانت متوقعة أم لا. على سبيل المثال، يمكنك معرفة ما إذا كانت الرسالة بشكل صحيح أو ما إذا كان يتم تخزينها مؤقتًا.

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

ملاحظة: عليك الانتباه إلى التلميح أو الخط الزمني لمعرفة ما إذا كانت أي سياسة سارية. تستغرق وقتًا أطول من المتوقَّع.

يظهر عندما يكون هدف الخلفية تطبيق Node.js. عرض نظرة عامة على Node.js على Apigee Edge
هدف الخلفية الذي يطلبه الخادم الوكيل لواجهة برمجة التطبيقات.
ويشير السطر الزمني إلى المدة (بالمللي ثانية) التي استغرقها وقت المعالجة مكتملة. تساعدك مقارنة شرائح الوقت المنقضية في عزل السياسات تستغرق وقتًا أطول في التنفيذ، ما يؤدي إلى إبطاء طلبات البيانات من واجهة برمجة التطبيقات.
يشير إبسيلون إلى فترة زمنية أصغر من مللي ثانية.

الزر غير مفعّل. تظهر على رمز السياسة في حال إيقاف إحدى السياسات. يمكن إيقاف سياسة مع واجهة برمجة التطبيقات العامة. يُرجى الاطّلاع على مرجع إعداد الخادم الوكيل لواجهة برمجة التطبيقات.

حدث خطأ. تظهر على رمز السياسة عندما يتم تقييم شرط "خطوة السياسة" على "خطأ" (يُرجى الاطّلاع على متغيّرات التدفق وشروطه) أو على رمز سياسة FetchFault كلما تم تنفيذ سياسة RestoreFault.
تم التخطي. تظهر على رمز السياسة عند عدم تنفيذ السياسة لأنّ الخطوة الشرط الذي تم تقييمه على false. يُرجى الاطّلاع على متغيّرات التدفق وشروطه لمزيد من المعلومات.

فهم تفاصيل المرحلة

يخبرك جزء تفاصيل المرحلة في الأداة كثيرًا عن حالة الخادم الوكيل في كل خطوة من خطوات المعالجة. في ما يلي بعض التفاصيل الواردة في تفاصيل المرحلة. (يُرجى النقر.) أي رمز في أداة التتبع للاطلاع على تفاصيل الخطوة المحددة، أو يمكنك استخدام أزرار التالي/رجوع للانتقال من خطوة إلى أخرى.

تفاصيل المرحلة الوصف
نقطة نهاية الخادم الوكيل تشير إلى تدفق ProxyEndpoint الذي تم اختياره للتنفيذ. يمكن أن يتضمن وكيل واجهة برمجة التطبيقات عدة نقاط نهاية للخادم الوكيل المُعنون.
المتغيرات

لسرد متغيرات التدفق التي تمت قراءتها وتعيين قيمة من خلال سياسة ما، راجع أيضًا إدارة حالة الخادم الوكيل باستخدام متغيّرات التدفق

ملاحظة:

  • تشير علامة يساوي (=) إلى القيمة التي تم تعيينها للمتغير.
  • تشير علامة يساوي المشطوبة (الدقائق) إلى أنه لا يمكن تعيين المتغير لأنّها للقراءة فقط أو كان هناك خطأ في تنفيذ السياسة.
  • يشير الحقل الفارغ إلى أنّه تمت قراءة قيمة المتغيّر.
عناوين الطلبات يدرج عناوين طلبات HTTP.
طلب المحتوى عرض نص طلب HTTP.
أماكن إقامة تمثِّل المواقع الحالة الداخلية للخادم الوكيل لواجهة برمجة التطبيقات. لا يتم عرضها بواسطة الافتراضي.
نقطة النهاية المستهدفة تشير إلى TargetEndpoint الذي تم اختياره للتنفيذ.
عناوين الردود يدرج عناوين استجابة HTTP.
محتوى الرد عرض نص استجابة HTTP.
PostClientFlow تعرض معلومات حول PostClientFlow، والذي يتم تنفيذه بعد إلى تطبيق العميل الذي أرسل الطلب. يمكن فقط إرفاق سياسات تسجيل الرسائل PostClientFlow. يُستخدم PostClientFlow حاليًا بشكل أساسي لقياس الوقت الفاصل الزمني بين الطابع الزمني لرسالة الردّ ونهايته.

تحسين التقاط الرسائل باستخدام الفلاتر

يمكنك فلترة الطلبات التي تظهر في أداة "التتبُّع" من خلال تحديد العنوان و/أو طلب البحث. قيم المعاملات. تتيح لك الفلاتر استهداف مكالمات معيَّنة قد تسبب مشاكل. على سبيل المثال، قد تحتاج إلى التركيز على الطلبات التي تتضمّن محتوى أو طلبات معيّنة واردة من شركاء أو تطبيقات معيّنة يمكنك الفلترة حسب:

  • عناوين HTTP - يمكنك قصر التتبع على المكالمات التي تحتوي على عنوان HTTP فقط . وهذه طريقة جيدة لمساعدتك في تحديد المشاكل وحلّها. يمكنك إرسال عنوان إلى مطوّر التطبيق واطلب منه تضمينه في المكالمة التي تتسبّب في حدوث مشاكل. ثم Apigee Edge ستسجّل فقط المكالمات ذات العنوان المحدد حتى تتمكن من فحص النتائج.
  • مَعلمات طلب البحث - فقط المكالمات التي تتضمّن قيمة معيّنة لمَعلمة تسجيل الدخول.

نقاط يجب معرفتها عن ميزة "الفلتر"

  • يجب إعادة تشغيل جلسة "التتبّع" بعد تحديد مَعلمات الفلاتر في الفلتر. الحقول.
  • يتم ربط مَعلمات الفلاتر معًا (و). كل أزواج الاسم/القيمة المحدّدة لطلب البحث و/أو العنوان يجب أن يكون متوفّرًا في طلب إجراء مطابقة ناجحة.
  • لا تتوفر مطابقة الأنماط في أداة الفلاتر.
  • تكون مَعلمات الفلاتر وقيمها حسّاسة لحالة الأحرف.

كيفية إنشاء تتبُّع الفلترة

  1. في حال كانت جلسة تتبُّع قيد التشغيل، يمكنك إيقافها من خلال النقر على إيقاف التتبُّع. الجلسة.
  2. انقر على الفلاتر في أعلى يمين أداة التتبُّع لتوسيع الفلاتر.

    في أداة التتبُّع، يتم وضع دائرة حول تصنيف الشريط الجانبي لـ "الفلاتر".
  3. في الحقل "الفلاتر"، حدِّد مَعلمات طلب البحث و/أو قيم العناوين التي تريد فلترتها. مفعَّلة. في هذا المثال، نحدّد مَعلمتَي طلب بحث لإجراء فلترة عليهما. يجب أن تكون كلتا المعلمتين الموجودة في طلب المطابقة الناجحة.

    في أداة التتبع، ضمن عوامل التصفية، ضمن "معلمة طلب البحث"، يظهر مثالان للأسماء والقيم
     تحديدها.
  4. ابدأ جلسة التتبُّع.
  5. استدعِ واجهات برمجة التطبيقات. الطلبات التي تتضمن فقط جميع العناوين و/أو طلبات البحث المحدّدة ينتج عنها مطابقة ناجحة.

ضمن "المعاملات"، تظهر أربع نتائج تتطابق مع مَعلمتَي طلب بحث تم إعدادهما مسبقًا.

في المثال أعلاه، سيظهر طلب البيانات من واجهة برمجة التطبيقات في Trace (التتبّع):

http://docs-test.apigee.net/cats?name=Penny&breed=Calico

لكن هذا لن:

http://docs-test.apigee.net/cats?name=Penny

تصحيح الأخطاء باستخدام Trace

يتيح لك التتبع الاطّلاع على الكثير من التفاصيل الداخلية حول الخادم الوكيل لواجهة برمجة التطبيقات. على سبيل المثال:

  • يمكنك إلقاء نظرة سريعة على السياسات التي يتم تنفيذها بشكل صحيح أو التي يتعذّر تنفيذها.
  • لنفترض أنّك لاحظت من خلال إحدى لوحات بيانات "إحصاءات Google" أنّ إحدى واجهات برمجة التطبيقات حدوث انخفاض غير معتاد في الأداء. الآن، يمكنك استخدام Trace للمساعدة في تحديد مكان حدوث المعوقات. يمنحك Trace الوقت، بالمللي ثانية، الذي يستغرقه كل خطوة المعالجة لإكمالها. إذا وجدت أن إحدى الخطوات تستغرق وقتًا طويلاً، فيمكنك اتخاذ اتخاذ القرار.
  • ومن خلال الاطلاع على تفاصيل المرحلة، يمكنك التحقق من العناوين التي يتم إرسالها إلى الخلفية، وعرض المتغيرات التي حددتها السياسات، وهكذا.
  • يمكنك التأكّد من أنّ السياسة توجّه الرسالة إلى العنوان الصحيح من خلال التحقّق من المسار الأساسي. الخادم.

تحديد خيارات العرض

حدِّد خيارات العرض لجلسة التتبُّع.

الخيار الوصف
عرض السياسات التي تم إيقافها اعرض أي سياسات تم إيقافها. يمكن إيقاف سياسة باستخدام واجهة برمجة التطبيقات العامة. عرض مرجع إعداد الخادم الوكيل لواجهة برمجة التطبيقات.
إظهار المراحل التي تم تخطّيها اعرض أي مراحل تم تخطيها. تحدث مرحلة التخطّي في حال عدم تنفيذ السياسة لأن شرط الخطوة تم تقييمه على أنه false. يُرجى الاطّلاع على متغيّرات التدفق وشروطه لمزيد من المعلومات.
عرض كل FlowInfos تمثيل الانتقالات ضمن جزء التدفق.
مقارنة المرحلة المحدّدة تلقائيًا لمقارنة المرحلة المحدّدة بالمرحلة السابقة. إيقاف هذا الخيار لعرض العناصر المحددة فقط بنجاح.
عرض المتغيّرات يمكنك إظهار أو إخفاء المتغيّرات التي تمت قراءتها و/أو تم تخصيصها.
إظهار الخصائص تمثِّل المواقع الحالة الداخلية للخادم الوكيل لواجهة برمجة التطبيقات. (مخفي تلقائيًا.)

جارٍ تنزيل نتائج التتبُّع

يمكنك تنزيل ملف XML لنتائج التتبُّع الأولية لعرضها والبحث بلا اتصال بالإنترنت في ملف نصي. المحرِّر. يعرض الملف التفاصيل الكاملة لجلسة الاستماع بما في ذلك محتوى وجميع العناوين والمتغيرات والسياسات.

للتنزيل، انقر على تنزيل جلسة تتبُّع.

يتم عرض الطلبات على شكل تجعيد.

بعد تتبُّع طلب بيانات من واجهة برمجة التطبيقات تم إرساله إلى خادم هدف، يمكنك عرض الطلب على شكل حلقة. الأمر. يعد ذلك مفيدًا بشكل خاص لتصحيح الأخطاء لعدة أسباب:

  • قد يقوم الخادم الوكيل لواجهة برمجة التطبيقات بتعديل الطلب، لذا من المفيد معرفة كيف يتم تنفيذ الطلب من الخادم الوكيل اختلاف الخادم المستهدف عن الطلب الأصلي. يمثل الأمر curl القيمة المعدّلة طلبك.
  • بالنسبة إلى حمولات الرسائل الأكبر حجمًا، يسمح لك حلزون (curl) بمشاهدة عناوين HTTP والرسالة المحتوى في مكان واحد. (الحد الأقصى لعدد الأحرف المسموح به حاليًا هو 1,000 حرف تقريبًا. للحصول على نصيحة حول تجاوز هذا الحد، راجع هذه المشاركة في "المنتدى").

ولأغراض تتعلق بالأمان، تحجب ميزة curl عنوان تفويض HTTP.

للاطّلاع على الطلبات في شكل تجعيد بعد وصول طلب بيانات من واجهة برمجة التطبيقات في Trace، اختَر "تم إرسال الطلب إلى الخادم الهدف" في مخطط "خريطة المعاملات"، ثم انقر على إظهار التجعيد زر "تم إرسال الطلب إلى الخادم الهدف" في جزء تفاصيل المرحلة.

تشير التعليقات التوضيحية للصور إلى زر إظهار التصفيق وإحدى الدوائر في
    مخطط خريطة المعاملات.

استخدام ميزة التتبُّع في Apigee

بشكل تلقائي، تسمح Apigee Edge لفريق دعم Apigee باستخدام أداة Trace على الخوادم الوكيلة لواجهة برمجة التطبيقات لتقديم الدعم. يمكنك إيقاف هذا الخيار في أي وقت. ومع ذلك، قد يؤدي إيقاف هذا الخيار إلى الحدّ من قدرة فريق دعم Apigee على تقديم الدعم لك.

لإيقاف دعم Apigee من استخدام أداة "تتبُّع":

  1. سجِّل الدخول إلى https://apigee.com/edge.
  2. اختَر المشرف > الخصوصية والأمان في شريط التنقّل الأيمن.
  3. انقر على زر التبديل تفعيل دعم Apigee إلى ميزة التتبُّع لإيقاف استخدام أداة تتبُّع Apigee.