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

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

أنت تعرض وثائق Apigee X.
عرض مستندات Apigee Edge:

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

وصف المشكلة

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

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

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

المنتج

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

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

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

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

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

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

تعذَّر تثبيت عملية إعداد 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 للتاريخ والوقت تقديم المعلومات الدقيقة حول وقت رصد المشكلة.

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

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

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

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

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

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

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

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

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

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

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

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

لقد زادت أخطاء 401 على Edge Public Cloud منذ 2020-11-06 الساعة 09:30 CST.

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

في ما يلي تفاصيل واجهة برمجة التطبيقات التي تعذّر تنفيذها:
أسماء المؤسسات: 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 خطأ.

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

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

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

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

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

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

عناصر مفيدة

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

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

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

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

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

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

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

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

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

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

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

نماذج الحالات وأمثلة على الحالات

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

Apigee Edge على Public Cloud

النموذج

يقدم هذا القسم نموذجًا Apigee Edge على Public Cloud.

المشكلة:

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

رسالة الخطأ:

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

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

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

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

خطوات إعادة إنتاج الخطأ:

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

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

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

نموذج لحالة

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

المشكلة:

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

رسالة الخطأ:

{"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:

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

خطوات إعادة إنتاج الخطأ:

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

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

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

نموذج لحالة

يوفّر هذا القسم نموذجًا لحالة 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