تفعيل سجلات تصحيح الأخطاء في NGINX على أجهزة التوجيه

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

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

يوضّح هذا المستند كيفية تفعيل سجلات تصحيح الأخطاء على جهاز التوجيه Apigee Edge للطلبات على مضيف افتراضي محدد. يمكن تفعيل ميزة تسجيل معلومات تصحيح الأخطاء لتسجيل المزيد من المعلومات عند حدوث أي مشاكل، مثل الطلب غير الصحيح أو 400 طلب غير صالح - خطأ في شهادة طبقة المقابس الآمنة، في الجزء الشمالي (بين تطبيق العميل وجهاز التوجيه).

قبل البدء

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

تفعيل سجلات تصحيح أخطاء NGINX على أجهزة التوجيه

يوضِّح هذا القسم كيفية تفعيل سجلّات تصحيح الأخطاء على أجهزة Edge Router.

تحديد ملف إعدادات المضيف الظاهري ذي الصلة

توضح الخطوات التالية كيفية تحديد موقع ملف إعداد المضيف الظاهري ذي الصلة على جهاز التوجيه:

  1. إذا كنت تعرف اسم المؤسسة واسم البيئة والمضيف الافتراضي لطلب واجهة برمجة التطبيقات المحدّد الذي تريد تصحيح أخطائه، حدِّد ملف conf المضيف الافتراضي على النحو التالي:
    1. انتقِل إلى الدليل /opt/nginx/conf.d/.
    2. ابحث عن ملف ORG_NAME_ENV_NAME_VIRTUALHOST.conf في دليل conf.d باستخدام الأمر التالي:
      ls -ltrh | grep "ORG_NAME_ENV_NAME_VIRTUALHOST_NAME"
      
  2. إذا كنت لا تعرف اسم المؤسسة، يمكنك تحديد ملف إعداد المضيف الافتراضي من خلال استخدام اسم الاسم المستعار للمضيف المُستخدَم في طلب واجهة برمجة التطبيقات على النحو التالي:

    انتقِل إلى دليل /opt/nginx/conf.d/ وابحث عن hostalias الذي تم تقديم الطلب من خلاله باستخدام الأمر التالي:

    ls -ltrh | grep -r 'HOST_ALIAS_NAME'
    

    نموذج المخرجات:

    لنفترض أن الاسم المستعار للمضيف هو opdk.cert-test.com. عند تشغيل الأمر ls -ltrh، ستظهر لك النتيجة على النحو الموضّح أدناه:

تفعيل تسجيل تصحيح الأخطاء لمضيف افتراضي محدَّد على جهاز التوجيه

توضّح الخطوات التالية كيفية تفعيل سجلات تصحيح الأخطاء على أجهزة توجيه Apigee لمضيف افتراضي محدّد.

  1. افتح الملف التالي على جهاز التوجيه في أداة التعديل: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf. مثلاً:
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
    
  2. غيِّر السطر التالي:
    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
    

    إلى

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
    
  3. احفظ التغييرات.
  4. شغّل أمر إعادة تحميل NGINX. مثلاً:
    sudo /opt/nginx/scripts/apigee-nginx reload
    
  5. سيلتقط الملف التالي الآن سجلّات debug:
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
    
  6. إذا أردت التقاط سجلات تصحيح الأخطاء على أكثر من جهاز توجيه، كرِّر هذه الخطوات على كل جهاز من أجهزة التوجيه.

تسجيل التحقق من معلومات تصحيح الأخطاء في ملف سجلّ أخطاء NGINX

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

    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log

  2. تأكّد من ظهور معلومات تصحيح الأخطاء لطلبات واجهة برمجة التطبيقات كما هو موضّح في المثال التالي:

    نموذج معلومات تصحيح الأخطاء:

    2021/01/27 02:48:40 [warn] 27624#27624: *3777 a client request body is buffered to a temporary file /opt/apigee/var/log/edge-router/nginx/client_temp/0000000001, client: XX.XX.XX.XX, server: XX.XX.XX.XX, request: "POST /post-no-target HTTP/1.1", host: "XX.XX.XX.XX:443"
    

    سيتم تسجيل المعلومات المعروضة أعلاه عندما يرسل العميل طلب POST يتضمّن حمولة كبيرة. ولن يظهر هذا السجلّ إلا عند تفعيل تسجيل تصحيح الأخطاء.

  3. إذا لم تظهر لك معلومات تصحيح الأخطاء الإضافية، تأكّد من أنّك اتّبعت جميع الخطوات الموضّحة في تفعيل تسجيل تصحيح الأخطاء لمضيف افتراضي معيّن على جهاز التوجيه بشكلٍ صحيح. إذا فاتتك أي خطوة، كرِّر جميع الخطوات مرّة أخرى بشكل صحيح.
  4. إذا كنت لا تزال غير قادر على الحصول على معلومات تصحيح الأخطاء، يُرجى التواصل مع فريق دعم Apigee Edge.

إيقاف سجلات تصحيح الأخطاء لمضيف افتراضي معيّن على جهاز التوجيه

يوضّح هذا القسم كيفية إيقاف سجلات تصحيح الأخطاء في جهاز التوجيه لمضيف افتراضي محدَّد.

  1. افتح الملف التالي على جهاز التوجيه في محرِّر: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf على سبيل المثال:
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
    
  2. تغيير السطر التالي:

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
    

    إلى

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
    
  3. احفظ التغييرات.
  4. شغّل أمر إعادة تحميل NGINX. مثلاً:
    /opt/nginx/scripts/apigee-nginx reload
    
  5. سيلتقط الملف التالي الآن سجلّات الأخطاء فقط:
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
    
  6. إذا أردت إيقاف سجلات تصحيح الأخطاء على أكثر من جهاز توجيه، كرِّر هذه الخطوات على كل جهاز من أجهزة التوجيه.

يتم تسجيل التحقق من معلومات الخطأ فقط في ملف سجلّ أخطاء NGINX

  1. يمكنك إجراء بعض طلبات البيانات من واجهة برمجة التطبيقات على الاسم المستعار للمضيف والمنفذ المرتبط بإعدادات المضيف الافتراضي المحدّدة أو انتظار إرسال العملاء للطلبات.
  2. تحقَّق من الملف التالي: /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  3. تأكّد من أنك تظهر لك معلومات الخطأ فقط وأنّ معلومات تصحيح الأخطاء لم تعُد مُسجَّلة للطلبات.
  4. إذا استمر تسجيل معلومات تصحيح الأخطاء الإضافية، تأكّد من أنّك اتّبعت جميع الخطوات الموضّحة في إيقاف سجلّات تصحيح الأخطاء لمضيف افتراضي معيّن على جهاز التوجيه بشكلٍ صحيح. إذا فاتتك أي خطوة، كرِّر جميع الخطوات مرّة أخرى بشكل صحيح.
  5. إذا لم تتمكّن من الحصول على معلومات تصحيح الأخطاء إلى الآن، يُرجى التواصل مع فريق دعم Apigee Edge.