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

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

أنت الآن بصدد الاطّلاع على مستندات Apigee X.
عرض مستندات Apigee Edge

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

وصف المشكلة

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

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

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

المنتج

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

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

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

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

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

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

تعذّر التثبيت على إعداد Private Cloud.

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

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

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

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

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

يتعذّر إنشاء خادم وكيل 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 أمس بين 2020-11-06 17:30 بتوقيت المحيط الهادئ و2020-11-06 17:35 بتوقيت المحيط الهادئ...

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

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

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

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

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

الإعداد

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

  • إذا كنت تستخدم 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 بعد إضافة عُقد بوابة إضافية.

(سجلات "معالج الرسائل" وبنية الشبكة غير متوفّرة).

عناصر مفيدة

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

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

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

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

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

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

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

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

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

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

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

نماذج الحالات وعيّنات الحالات

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

‫Apigee Edge على السحابة الإلكترونية العامة

نموذج

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

المشكلة:

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

رسالة الخطأ:

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

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

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

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

خطوات إعادة إنتاج المشكلة:

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

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

<List of files attached>

مثال على حالة

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

المشكلة:

نلاحظ عددًا كبيرًا من أخطاء "503: الخدمة غير متاحة" في مؤسسة السحابة الإلكترونية العامة. يُرجى التحقّق من المشكلة وحلّها أو إعلامنا بكيفية حلّها.

رسالة الخطأ:

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

<Attach the network topology describing the setup of your Private Cloud including data centers and nodes>

خطوات إعادة إنتاج المشكلة:

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

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

<List of files attached>

مثال على حالة

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

المشكلة:

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