أفضل الممارسات لطلبات الحصول على الدعم في Google Cloud Apigee

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

يتم الآن الاطّلاع على مستندات Apigee X.
يمكنك الاطّلاع على مستندات Apigee Edge.

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

وصف المشكلة

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

المعلومات الأساسية الوصف Apigee Edge for Public Cloud Apigee Edge لـ Private Cloud
المنتج منتج Apigee المحدد الذي تظهر فيه المشكلة، بما في ذلك معلومات الإصدار حيثما ينطبق ذلك.
  • الإصدار
تفاصيل المشكلة وصف واضح ومفصّل للمشكلة، بما في ذلك رسالة الخطأ الكاملة، إن وجدت.
  • رسالة الخطأ
  • ناتج أداة التتبُّع
  • خطوات إعادة إظهار المشكلة
  • إكمال طلب/أمر واجهة برمجة التطبيقات
  • رسالة الخطأ
  • ناتج أداة التتبُّع
  • خطوات إعادة إظهار المشكلة
  • إكمال طلب/أمر واجهة برمجة التطبيقات
  • السجلات التشخيصية للمكوّنات
الوقت الطابع الزمني المحدّد لوقت بدء المشكلة ومدة استمرارها.
  • تاريخ حدوث المشكلة ووقتها والمنطقة الزمنية
  • مدة المشكلة
  • تاريخ حدوث المشكلة ووقتها والمنطقة الزمنية
  • مدة المشكلة
الإعداد معلومات مفصّلة عن مكان ملاحظة المشكلة.
  • اسم المؤسسة
  • اسم Env
  • اسم الخادم الوكيل لواجهة برمجة التطبيقات
  • التغيير
  • مخطط الشبكة
  • مكوِّن False Edge

توضح الأقسام التالية هذه المفاهيم بمزيد من التفصيل.

المنتَج

هناك منتجات مختلفة من Apigee، مثل Apigee Edge على Public Cloud وApigee Edge على Private Cloud، لذلك نحتاج إلى معلومات محدَّدة حول المنتج المحدَّد الذي تحدث فيه المشكلة.

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

الإجراءات المسموح بها الإجراءات غير المسموح بها
تعذّر نشر الخادم الوكيل لواجهة برمجة التطبيقات OAuth2 في مؤسسة Public Cloud ...

تعذَّر نشر الخادم الوكيل لواجهة برمجة التطبيقات.

(نحتاج إلى معرفة منتج Apigee الذي تواجه فيه المشكلة).

تعذّر التثبيت مع ظهور الخطأ التالي على إصدار Edge Private Cloud 4.50.00 ...

تعذّر تثبيت التطبيق في إعداد Private Cloud.

(معلومات الإصدار غير متوفّرة)

تفاصيل المشكلة

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

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

الإجراءات المسموح بها الإجراءات غير المسموح بها

يتعذّر تنفيذ edgemicro_auth للخادم الوكيل edgemicro الجديد مع ظهور الخطأ التالي:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

الخادم الوكيل edgemicro الجديد الذي تم إنشاؤه اليوم لا يعمل

(اسم الخادم الوكيل غير معروف. ليس من الواضح ما إذا كان الخادم الوكيل يعرض خطأً أو أي استجابة غير متوقعة).

يظهر لعملائنا أخطاء 500 مع رسالة الخطأ التالية أثناء إرسال طلبات إلى الخادم الوكيل لواجهة برمجة التطبيقات:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

يتلقّى عملاؤنا 500 من الأخطاء أثناء إرسال طلبات إلى الخادم الوكيل لواجهة برمجة التطبيقات.

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

الوقت

الوقت هو معلومة مهمة للغاية. من المهم أن يعرف مهندس الدعم متى لاحظت هذه المشكلة لأول مرة والمدة التي استمرت فيها وما إذا كانت المشكلة لا تزال قائمة.

قد لا يكون مهندس الدعم الذي يحلّ المشكلة في منطقتك الزمنية، لذا فإنّ إضافة البيانات النسبية الخاصة بالوقت يجعل من الصعب تشخيص المشكلة. وبالتالي، ننصح باستخدام تنسيق ISO 8601 لطابع التاريخ والوقت لتقديم معلومات دقيقة عن الوقت الذي تم رصد المشكلة فيه.

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

الإجراءات المسموح بها الإجراءات غير المسموح بها
تم رصد عدد كبير من عناصر 503s أمس في الفترة بين 2020-11-06 الساعة 17:30 بتوقيت المحيط الهادئ و2020-11-06 الساعة 17:35 بتوقيت المحيط الهادئ...

تمت مراقبة عدد كبير من 503s أمس في الساعة 5:30 مساءً لمدة 5 دقائق.

(نحن مضطرون إلى استخدام التاريخ الضمني، وليس من الواضح أيضًا المنطقة الزمنية التي ظهرت فيها هذه المشكلة).

تمت ملاحظة أوقات استجابة عالية على الخوادم الوكيلة التالية لواجهة برمجة التطبيقات من 2020-11-09 الساعة 15:30 بتوقيت الهند إلى 2020-11-09 18:10 بتوقيت الهند ...

لوحظ في الأسبوع الماضي وجود وقت استجابة مرتفع على بعض الخوادم الوكيلة لواجهة برمجة التطبيقات.

(لم يتضح اليوم والمدة التي ظهرت فيها المشكلة في الأسبوع الماضي).

الإعداد

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

  • إذا كنت تستخدم Apigee Cloud، قد يكون لديك أكثر من مؤسسة واحدة، لذلك نحتاج إلى معرفة المؤسسة المحدّدة وغيرها من التفاصيل التي تلاحظ فيها المشكلة:
    • أسماء المؤسسات والبيئة
    • اسم الخادم الوكيل لواجهة برمجة التطبيقات وأرقام النُسخ السابقة (لحالات تعذُّر إرسال طلبات واجهة برمجة التطبيقات)
  • إذا كنت تستخدم خاصة سحابة إلكترونية ، قد تكون تستخدم أحد مخططات التثبيت العديدة المتوافقة. لذلك، نحتاج إلى معرفة المخطط الذي تستخدمه، بما في ذلك التفاصيل، مثل عدد مراكز البيانات والعُقد.

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

الإجراءات المسموح بها الإجراءات غير المسموح بها

زادت 401 الأخطاء في Edge Public Cloud منذ 2020-11-06 09:30 CST.

تفاصيل إعداد الحافة:

تفاصيل واجهة برمجة التطبيقات التي تعذّر تنفيذها هي على النحو التالي:
أسماء المؤسسات: myorg
أسماء Env: test
أسماء الخوادم الوكيلة لواجهة برمجة التطبيقات: myproxy
أرقام النُسخ السابقة: 3

الخطأ:

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

تمت زيادة 401 من الأخطاء.

(لا يوفّر أي معلومات عن المنتج المستخدَم، بما في ذلك وقت رصد المشكلة أو أي تفاصيل حول عملية الإعداد).

تعذَّر بدء "معالج الرسائل" في الإصدار 4.19.06 من Edge الخاص، بعد إضافة عُقد مدخل إضافية.

سجلّات بيانات التشخيص:
تم إرفاق سجلّات "معالج الرسائل".

مخطط الشبكة:
تم إرفاق الملف network-topology.png الذي يحتوي على العُقد الإضافية.

تعذَّر بدء "معالج الرسائل" في الإصدار 4.19.06 من Edge الخاص، بعد إضافة عُقد مدخل إضافية.

(سجلات معالج الرسائل ومخطط الشبكة غير موجودين.)

عناصر مفيدة

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

يصف هذا القسم بعض الأدوات المفيدة التي تفيد جميع منتجات Apigee:

الأدوات الشائعة لجميع منتجات Apigee

العناصر التالية مفيدة لجميع منتجات Apigee: Apigee Edge على Public Cloud وApigee Edge على Private Cloud:

العناصر الوصف
نتيجة أداة التتبُّع تحتوي نتيجة أداة التتبُّع على معلومات تفصيلية حول طلبات واجهة برمجة التطبيقات التي تتدفق من خلال منتجات Apigee. ويفيد هذا الإجراء في الإبلاغ عن أي أخطاء في وقت التشغيل، مثل 4XX و5XX ومشاكل وقت الاستجابة.
لقطات الشاشة وتساعد لقطات الشاشة في نقل سياق السلوك أو الخطأ الفعلي الذي تتم ملاحظته. ويكون هذا الإجراء مفيدًا في ما يتعلق بأي أخطاء أو مشاكل يتم رصدها، مثل مشاكل واجهة المستخدم أو "إحصاءات Google".
HAR (أرشيف Http) HAR هو ملف تم التقاطه بواسطة أدوات جلسة HTTP لتصحيح أخطاء أي مشكلات تتعلق بواجهة المستخدم. يمكن التقاط هذه الصورة باستخدام متصفحات مثل Chrome أو Firefox أو Internet Explorer.
tcpdumps تلتقط أداة tcpdump حزم TCP/IP التي يتم نقلها أو استلامها على الشبكة. ويفيد هذا في أي مشاكل متعلقة بالشبكة، مثل تعذُّر تأكيد الاتصال من خلال بروتوكول أمان طبقة النقل (TLS) وأخطاء 502 ومشاكل وقت الاستجابة وما إلى ذلك.

عناصر إضافية في Apigee Edge لـ Private Cloud

بالنسبة إلى Apigee Edge for Private Cloud، قد نحتاج إلى بعض العناصر الإضافية التي من شأنها تسهيل تشخيص المشاكل بشكل أسرع.

العناصر الوصف
طوبولوجيا الشبكة يوضّح الرسم البياني لمخطط تثبيت Edge الخاص بك معلومات حول إعداد Private Cloud، بما في ذلك جميع مراكز البيانات والعُقد والمكونات المثبَّتة في كل عقدة.
سجلات تشخيص مكونات Edge السجلات التشخيصية ذات الصلة بمكوِّن Apigee Edge المحدّد، مثل معالج الرسائل أو جهاز التوجيه أو Cassandra.
ملف إعداد التثبيت ملف الإعداد الصامت الذي يتم استخدامه عند تثبيت Apigee Edge أو ترقيته.

يُعد هذا الملف مفيدًا للتحقق من صحة جميع الإعدادات في الحالات التي تظهر فيها مشاكل في التثبيت أو نقل البيانات.

نسخ الذاكرة يعد تفريغ الذاكرة نبذة عن عملية ذاكرة Java. ويكون هذا الأمر مفيدًا إذا تم رصد استخدام مرتفع للذاكرة أو ظهور أخطاء OutOfMemory على بعض مكونات Edge.
عمليات تفريغ سلاسل المحادثات أما عملية تفريغ سلسلة التعليمات، فهي لقطة لجميع سلاسل التعليمات في عملية Java قيد التشغيل.

ويكون هذا الأمر مفيدًا إذا تمت ملاحظة ارتفاع وحدة المعالجة المركزية (CPU) أو التحميل في بعض مكونات Edge.

نماذج الطلبات ونماذج الحالات

يقدم هذا القسم نماذج حالات وحالات نموذجية لمنتجات مختلفة استنادًا إلى أفضل الممارسات الموضحة في هذا المستند:

Apigee Edge على Public Cloud

النموذج

يوفّر هذا القسم نموذجًا لنموذج حول Apigee Edge على Public Cloud.

المشكلة:

<قدِّم وصفًا تفصيليًا للمشكلة أو السلوك الذي تتم ملاحظته من جانبك. أدرِج اسم المنتج وإصداره، حيثما أمكن.>

رسالة الخطأ:

<تضمين رسالة الخطأ الكاملة التي تمت ملاحظتها (إن وجدت)>

وقت بدء المسألة (تنسيق ISO 8601):

وقت انتهاء المسألة (تنسيق ISO 8601):

تفاصيل إعداد واجهة برمجة التطبيقات:
أسماء المؤسسات:
أسماء Env:
أسماء الخوادم الوكيلة لواجهة برمجة التطبيقات:
أرقام المراجعة:

خطوات إعادة إظهار المشكلة:

<تقديم خطوات لإعادة إظهار المشكلة إن أمكن>

معلومات التشخيص:

<قائمة الملفات المرفقة>

نموذج لطلب

يقدّم هذا القسم نموذجًا لحالة Apigee Cloud (Apigee على Google Cloud/Apigee Edge على Public Cloud).

المشكلة:

نلاحظ عددًا كبيرًا من أخطاء 503 Service Unavailable في مؤسسة Public Cloud الخاصة بنا. هل يمكنك النظر في المشكلة وحلّها أو إبلاغنا بكيفية حلّها؟

رسالة الخطأ:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

وقت بدء المسألة (تنسيق ISO 8601): 2020-10-04 06:30 IST

وقت انتهاء المشكلة (تنسيق ISO 8601): لا تزال المشكلة قائمة.

تفاصيل إعداد Apigee Cloud:
أسماء المؤسسات: myorg
أسماء Env: dev
أسماء الخادم الوكيل لواجهة برمجة التطبيقات: myproxy
أرقام المراجعة: 3

خطوات إعادة إظهار المشكلة:

شغِّل أمر curl التالي لإعادة إظهار المشكلة:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

معلومات التشخيص:

إخراج أداة التتبُّع (trace-503.xml)

Apigee Edge لـ Private Cloud

النموذج

يوفّر هذا القسم نموذجًا لنموذج Apigee Edge for Private Cloud.

المشكلة:

<قدِّم وصفًا تفصيليًا للمشكلة أو السلوك الذي تتم ملاحظته من جانبك. أدرِج اسم المنتج وإصداره، حيثما أمكن.>

رسالة الخطأ:

<تضمين رسالة الخطأ الكاملة التي تمت ملاحظتها (إن وجدت)>

وقت بدء المسألة (تنسيق ISO 8601):

وقت انتهاء المسألة (تنسيق ISO 8601):

تفاصيل إعداد Edge Private Cloud:

<إرفاق بنية الشبكة التي تصف عملية إعداد Private Cloud بما في ذلك مراكز البيانات والعُقد>

خطوات إعادة إظهار المشكلة:

<تقديم خطوات لإعادة إظهار المشكلة إن أمكن>

معلومات التشخيص

<قائمة الملفات المرفقة>

نموذج لطلب

يقدّم هذا القسم نموذجًا لحالة Apigee Edge الخاصة بخدمة Private Cloud.

المشكلة:

أثناء عملية تثبيت خادم Apigee Management على العقدة رقم 10 كجزء من Edge Private Cloud 4.19.06 على نظام التشغيل Linux RHEL 7.6، يظهر لنا الخطأ التالي.

رسالة الخطأ:

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

وقت بدء المشكلة (تنسيق ISO 8601): يحدث ذلك عند تثبيت المشكلة

وقت انتهاء المشكلة (تنسيق ISO 8601): غير سارٍ

تفاصيل إعداد Edge Private Cloud:

تم إرفاق الملف network-topology.png

خطوات إعادة إظهار المشكلة:

في ما يلي الأمر الذي نتج عنه الخطأ أعلاه:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

معلومات التشخيص:

تم إرفاق الملفات التالية:

  • output.txt تحتوي على نتيجة كاملة للأمر أعلاه، بما في ذلك رسالة الخطأ
  • سجلات خادم الإدارة
  • ملف الإعداد NonProdConfig.txt