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

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

أنت تطّلع على مستندات Apigee X.
اطّلِع على مستندات Apigee Edge.

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

وصف المشكلة

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

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

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

المنتج

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

يعرض الجدول التالي بعض الأمثلة التي تعرض معلومات كاملة في عمود الإجراءات التي يجب اتّخاذها ومعلومات غير مكتملة في عمود الإجراءات التي يجب تجنّبها:

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

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

(يجب معرفة منتج Apigee الذي تظهر فيه المشكلة).

تعذّر التثبيت بسبب الخطأ التالي في Edge Private Cloud الإصدار 4.50.00:

تعذّر التثبيت في عملية إعداد "سحابة خاصة".

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

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

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

يعرض الجدول التالي بعض الأمثلة التي تعرض معلومات كاملة في عمود الإجراءات التي يجب اتّخاذها، ومعلومات غير مكتملة في عمود الإجراءات التي يجب تجنّبها:

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

يتعذّر الاتصال بخادم الوكيل edgemicro الجديد edgemicro_auth بسبب الخطأ التالي:

{"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 بالأمس بين ‎06-11-2020 17:30 بتوقيت المحيط الهادئ و‎06-11-2020 17:35 بتوقيت المحيط الهادئ...

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

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

تم رصد أوقات استجابة طويلة في أدوات الربط التالية لواجهات برمجة التطبيقات من 09‏/11‏/2020 15:30 IST إلى 09‏/11‏/2020 18:10 IST ...

تم رصد أوقات استجابة عالية في بعض أدوات الربط بواجهة برمجة التطبيقات الأسبوع الماضي.

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

ضبط إعدادات الجهاز

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

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

يعرض الجدول التالي بعض الأمثلة التي تعرض معلومات كاملة في عمود الإجراءات التي يجب اتّخاذها، ومعلومات غير مكتملة في عمود الإجراءات التي يجب تجنّبها:

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

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

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

في ما يلي تفاصيل واجهة برمجة التطبيقات التي تواجه مشكلة:
  أسماء المؤسسات: myorg
  أسماء البيئات: test
  أسماء الوكلاء لواجهة برمجة التطبيقات: myproxy
  أرقام المراجعات: 3

الخطأ:

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

401 زيادة عدد الأخطاء

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

تعذّر بدء "معالج الرسائل" على Edge Private Cloud الإصدار 4.19.06، بعد إضافة عقد بوابة إضافية.

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

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

تعذّر بدء "معالج الرسائل" على Edge Private Cloud الإصدار 4.19.06، بعد إضافة عقد بوابة إضافية.

(تُرجى العِلم أنّ سجلّات Message Processor وtopologiy للشبكة غير متوفّرة).

العناصر المفيدة

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

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

العناصر الشائعة لجميع منتجات Apigee

تكون العناصر التالية مفيدة لجميع منتجات Apigee: Apigee Edge على السحابة الإلكترونية العامة وApigee Edge على السحابة الإلكترونية الخاصة:

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

عناصر إضافية لخدمة Apigee Edge for Private Cloud

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

العناصر الوصف
شبكة الطوبولوجيا مخطّط توصيل Edge الذي يصف إعداد "سحابة Google الخاصة" بما في ذلك جميع مراكز البيانات والعقد والمكونات المثبّتة في كل عقدة
سجلّات بيانات تشخيص مكوّنات Edge سجلّات بيانات التشخيص ذات الصلة بمكوّن Apigee Edge المحدّد، مثل Message Processor أو Router أو Cassandra
ملف إعدادات التثبيت ملف الإعدادات الصامتة الذي يتم استخدامه عند تثبيت Apigee Edge أو ترقيته.

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

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

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

نماذج الطلبات وعينات الطلبات

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

‫Apigee Edge on Public Cloud

نموذج

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

المشكلة:

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

رسالة الخطأ:

<يجب تضمين رسالة الخطأ الكاملة التي تم رصدها (إن توفّرت)>

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

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

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

الخطوات التي يمكن إعادة تنفيذها لتؤدّي إلى ظهور المشكلة:

<يُرجى تقديم خطوات إعادة إنتاج المشكلة متى أمكن ذلك>

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

<List of files attached>

نموذج الحالة

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

المشكلة:

نلاحظ عددًا كبيرًا من أخطاء 503 Service Unavailable (خطأ 503: الخدمة غير متاحة) في 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
  أسماء البيئات: dev
  أسماء الوكلاء لواجهة برمجة التطبيقات: myproxy
  أرقام المراجعات: 3

الخطوات التي يمكن إعادة تنفيذها لتؤدّي إلى ظهور المشكلة:

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

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

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

نتيجة أداة التتبُّع (trace-503.xml)

Apigee Edge for Private Cloud

نموذج

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

المشكلة:

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

رسالة الخطأ:

<يجب تضمين رسالة الخطأ الكاملة التي تم رصدها (إن توفّرت)>

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

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

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

<يجب إرفاق مخطّط شبكة يصف إعداد "سحابةك الخاصة"، بما في ذلك مراكز البيانات والعقد>

الخطوات التي يمكن إعادة تنفيذها لتؤدّي إلى ظهور المشكلة:

<يُرجى تقديم خطوات إعادة إنتاج المشكلة متى أمكن ذلك>

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

<List of files attached>

نموذج الحالة

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

المشكلة:

أثناء تثبيت "خادم إدارة Apigee" على العقدة رقم 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