بهترین روش‌ها برای موارد پشتیبانی Google Cloud Apigee

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

شما در حال مشاهده مستندات Apigee X هستید.
مستندات Apigee Edge را مشاهده کنید.

ارائه اطلاعات دقیق و مورد نیاز در پرونده پشتیبانی، پاسخگویی سریع و کارآمد تیم پشتیبانی Google Cloud Apigee را آسان‌تر می‌کند. هنگامی که پرونده پشتیبانی شما فاقد جزئیات حیاتی است، ما باید اطلاعات بیشتری درخواست کنیم که ممکن است شامل چندین بار مراجعه به بخش مربوطه باشد. این کار زمان بیشتری می‌برد و می‌تواند منجر به تأخیر در حل مشکلات شود. این راهنمای بهترین شیوه‌ها، اطلاعات مورد نیاز برای حل سریع‌تر پرونده پشتیبانی فنی شما را در اختیار شما قرار می‌دهد.

توصیف مسئله

یک مشکل باید حاوی اطلاعاتی باشد که جزئیات مربوط به آنچه اتفاق افتاده در مقابل آنچه انتظار می‌رفت اتفاق بیفتد، و همچنین زمان و نحوه وقوع آن را توضیح دهد. یک پرونده پشتیبانی خوب Apigee باید شامل اطلاعات کلیدی زیر برای هر یک از محصولات Apigee باشد:

اطلاعات کلیدی توضیحات Apigee Edge برای فضای ابری عمومی Apigee Edge برای فضای ابری خصوصی
محصول محصول خاص Apigee که مشکل در آن مشاهده شده است، به همراه اطلاعات نسخه در صورت لزوم.
  • نسخه
جزئیات مشکل شرح مشکل به صورت واضح و با جزئیات که مشکل را شرح می‌دهد، از جمله پیام خطای کامل، در صورت وجود.
  • پیام خطا
  • خروجی ابزار ردیابی
  • مراحل بازتولید مشکل
  • درخواست/دستور API کامل
  • پیام خطا
  • خروجی ابزار ردیابی
  • مراحل بازتولید مشکل
  • درخواست/دستور API کامل
  • گزارش‌های تشخیصی اجزا
زمان زمان دقیق شروع مشکل و مدت زمان تداوم آن.
  • تاریخ، زمان و منطقه زمانی وقوع مشکل
  • مدت زمان مشکل
  • تاریخ، زمان و منطقه زمانی وقوع مشکل
  • مدت زمان مشکل
راه‌اندازی اطلاعات دقیق در جایی که مشکل مشاهده می‌شود.
  • نام سازمان
  • نام پاکت
  • نام پروکسی API
  • بازنگری
  • توپولوژی شبکه
  • کامپوننت لبه‌ی معیوب

بخش‌های بعدی این مفاهیم را با جزئیات بیشتری شرح می‌دهند.

محصول

محصولات Apigee مختلفی وجود دارد، Apigee Edge روی Public Cloud و Apigee Edge روی Private Cloud ، بنابراین ما به اطلاعات دقیقی در مورد اینکه کدام محصول خاص مشکل دارد، نیاز داریم.

جدول زیر چند مثال ارائه می‌دهد که اطلاعات کامل را در ستون «بایدها» و اطلاعات ناقص را در ستون «نبایدها» نشان می‌دهد:

انجام می‌دهد نبایدها
استقرار پروکسی API OAuth2 در سازمان ابر عمومی ما ناموفق بود ...

استقرار پروکسی API ناموفق بود

(ما باید بدانیم که مشکل از کدام محصول Apigee است.)

نصب با خطای زیر در نسخه ۴.۵۰.۰۰ Edge Private Cloud ما انجام نشد...

نصب در تنظیمات ابر خصوصی ما ناموفق بود.

(اطلاعات نسخه موجود نیست)

جزئیات مشکل

اطلاعات دقیقی در مورد مشکل مشاهده شده، از جمله پیام خطا (در صورت وجود) و رفتار مورد انتظار و واقعی مشاهده شده، ارائه دهید.

جدول زیر چند مثال ارائه می‌دهد که اطلاعات کامل را در ستون «بایدها» و اطلاعات ناقص را در ستون «نبایدها» نشان می‌دهد:

انجام می‌دهد نبایدها

پروکسی جدید edgemicro edgemicro_auth با خطای زیر مواجه می‌شود:

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

پروکسی جدید edgemicro که امروز ایجاد شده کار نمی‌کند

(نام پروکسی ناشناخته است. مشخص نیست که آیا پروکسی خطا برمی‌گرداند یا پاسخ غیرمنتظره‌ای می‌دهد.)

مشتریان ما هنگام ارسال درخواست به پروکسی API، با خطای 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"}}}

مشتریان ما هنگام ارسال درخواست به پروکسی API با خطای 500 مواجه می‌شوند.

(فقط بیان خطای 500 اطلاعات کافی برای بررسی مشکل را در اختیار ما قرار نمی‌دهد. ما باید پیام خطای واقعی و کد خطایی که مشاهده می‌شود را بدانیم.)

زمان

زمان، اطلاعات بسیار مهمی است. برای مهندس پشتیبانی مهم است که بداند شما اولین بار چه زمانی متوجه این مشکل شدید، چقدر طول کشید و آیا مشکل هنوز ادامه دارد یا خیر.

ممکن است مهندس پشتیبانی که مشکل را حل می‌کند در منطقه زمانی شما نباشد، بنابراین اظهارات نسبی در مورد زمان، تشخیص مشکل را دشوارتر می‌کند. از این رو، توصیه می‌شود از قالب ISO 8601 برای تاریخ و زمان استفاده کنید تا اطلاعات دقیق زمانی در مورد زمان مشاهده مشکل ارائه شود.

جدول زیر چند مثال ارائه می‌دهد که زمان و مدت دقیق وقوع مشکل را در ستون «بایدها» و اطلاعات مبهم یا نامشخص در مورد زمان وقوع مشکل را در ستون «نبایدها» نشان می‌دهد:

انجام می‌دهد نبایدها
دیروز بین ساعت ۱۷:۳۰ بامداد ۲۰۲۱ به وقت PDT و ساعت ۱۷:۳۵ بامداد ۲۰۲۱ به وقت PDT تعداد زیادی از 503s مشاهده شد...

دیروز ساعت ۵:۳۰ بعد از ظهر به مدت ۵ دقیقه تعداد زیادی از 503s مشاهده شد.

(ما مجبور به استفاده از تاریخ ضمنی هستیم و همچنین مشخص نیست که این مشکل در کدام منطقه زمانی مشاهده شده است.)

از تاریخ 2020-11-09 ساعت 15:30 به وقت IST تا 2020-11-09 ساعت 18:10 به وقت IST ، تأخیرهای بالایی در پروکسی‌های API زیر مشاهده شد...

هفته گذشته تأخیرهای بالایی در برخی از پروکسی‌های API مشاهده شد.

(مشخص نیست که این مشکل در کدام روز و به مدت چند هفته گذشته مشاهده شده است.)

راه‌اندازی

ما باید جزئیات مربوط به محل دقیق مشکل شما را بدانیم. بسته به محصولی که استفاده می‌کنید، به اطلاعات زیر نیاز داریم:

  • اگر از Apigee Cloud استفاده می‌کنید، ممکن است بیش از یک سازمان داشته باشید، بنابراین ما باید سازمان خاص و سایر جزئیاتی را که در آن مشکل را مشاهده می‌کنید، بدانیم:
    • نام سازمان و محیط
    • نام پروکسی API و شماره‌های ویرایش (برای درخواست‌های ناموفق API)
  • اگر از ابر خصوصی استفاده می‌کنید، ممکن است از یکی از توپولوژی‌های نصب پشتیبانی‌شده‌ی متعدد استفاده کنید. بنابراین ما باید بدانیم که از چه توپولوژی‌ای استفاده می‌کنید، از جمله جزئیاتی مانند تعداد مراکز داده و گره‌ها.

جدول زیر چند مثال ارائه می‌دهد که اطلاعات کامل را در ستون «بایدها» و اطلاعات ناقص را در ستون «نبایدها» نشان می‌دهد:

انجام می‌دهد نبایدها

از تاریخ 2020-11-06 ساعت 09:30 به وقت CST، خطاهای 401 در Edge Public Cloud افزایش یافته است.

جزئیات تنظیم لبه:

جزئیات API ناموفق به شرح زیر است:
نام سازمان: myorg
نام‌های Env: test
نام‌های پروکسی API: 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 نسخه ۴.۱۹.۰۶ راه‌اندازی کرد.

گزارش‌های تشخیصی:
گزارش‌های پردازشگر پیام پیوست شد.

توپولوژی شبکه:
فایل network-topology.png که حاوی گره‌های اضافی است، پیوست شد.

پس از افزودن گره‌های دروازه اضافی، نمی‌توان پردازشگر پیام را در Edge Private Cloud نسخه ۴.۱۹.۰۶ راه‌اندازی کرد.

(گزارش‌های پردازنده پیام و توپولوژی شبکه وجود ندارد.)

مصنوعات مفید

ارائه مصنوعات مرتبط با مشکل، سرعت حل مسئله را افزایش می‌دهد، زیرا به ما کمک می‌کند تا رفتار دقیقی را که مشاهده می‌کنید درک کنیم و بینش بیشتری در مورد آن به دست آوریم.

این بخش برخی از مصنوعات مفید را که برای همه محصولات Apigee مفید هستند، شرح می‌دهد:

مصنوعات مشترک برای همه محصولات Apigee

مصنوعات زیر برای همه محصولات Apigee مفید هستند: Apigee Edge در فضای ابری عمومی و Apigee Edge در فضای ابری خصوصی :

مصنوع توضیحات
خروجی ابزار ردیابی خروجی ابزار Trace شامل اطلاعات دقیقی در مورد درخواست‌های API که از طریق محصولات Apigee در جریان هستند، می‌باشد. این اطلاعات برای هرگونه خطای زمان اجرا مانند 4XX ، 5XX و مشکلات تأخیر مفید است.
اسکرین‌شات‌ها اسکرین‌شات‌ها به انتقال زمینه رفتار واقعی یا خطای مشاهده‌شده کمک می‌کنند. این برای هرگونه خطا یا مشکل مشاهده‌شده، مانند خطا در رابط کاربری یا تجزیه‌وتحلیل، مفید است.
HAR (بایگانی HTTP) HAR فایلی است که توسط ابزارهای HTTP session برای اشکال‌زدایی هرگونه مشکل مربوط به رابط کاربری ضبط می‌شود. این فایل را می‌توان با استفاده از مرورگرهایی مانند کروم، فایرفاکس یا اینترنت اکسپلورر ضبط کرد.
tcpdumps ابزار tcpdump بسته‌های TCP/IP منتقل شده یا دریافت شده از طریق شبکه را ضبط می‌کند. این ابزار برای هرگونه مشکل مرتبط با شبکه مانند خرابی‌های TLS handshake، خطاهای 502 و مشکلات تأخیر و غیره مفید است.

مصنوعات اضافی برای Apigee Edge برای فضای ابری خصوصی

برای Apigee Edge برای فضای ابری خصوصی، ممکن است به برخی مصنوعات اضافی نیاز داشته باشیم که تشخیص سریع‌تر مشکلات را تسهیل کند.

مصنوع توضیحات
توپولوژی شبکه نمودار توپولوژی نصب Edge که تنظیمات Private Cloud شما را شرح می‌دهد، شامل تمام مراکز داده، گره‌ها و اجزای نصب شده در هر گره.
لاگ‌های تشخیصی اجزای لبه گزارش‌های تشخیصی مربوط به مؤلفه خاص Apigee Edge مانند پردازنده پیام، روتر یا کاساندرا.
فایل پیکربندی نصب فایل پیکربندی بی‌صدا که هنگام نصب یا ارتقاء Apigee Edge استفاده می‌شود.

این فایل برای تأیید صحت تمام تنظیمات در مواردی که با مشکلات نصب یا مهاجرت مواجه می‌شوید، مفید است.

هیپ دامپ‌ها داده‌های هیپ (Heap dumps) تصویری از فرآیند حافظه جاوا هستند. این داده‌ها در صورتی مفید هستند که استفاده از حافظه زیاد باشد یا خطاهای OutOfMemory در برخی از اجزای Edge مشاهده شود.
تخلیه نخ‌ها یک دامپ ترد، تصویری لحظه‌ای از تمام تردهای یک فرآیند جاوای در حال اجرا است.

این قابلیت در صورتی مفید است که CPU یا Load بالایی روی برخی از اجزای Edge مشاهده شود.

الگوهای موردی و نمونه پرونده‌ها

این بخش، الگوهای موردی و نمونه‌های موردی را برای محصولات مختلف بر اساس بهترین شیوه‌های شرح داده شده در این سند ارائه می‌دهد:

Apigee Edge روی فضای ابری عمومی

الگو

این بخش یک الگوی نمونه برای Apigee Edge روی Public Cloud ارائه می‌دهد.

مشکل:

<شرح مفصلی از مشکل یا رفتاری که از سمت شما مشاهده می‌شود، ارائه دهید. در صورت لزوم، نام و نسخه محصول را نیز ذکر کنید.>

پیام خطا:

<پیام خطای کامل مشاهده شده (در صورت وجود) را وارد کنید>

زمان شروع مشکل (فرمت ISO 8601):

زمان پایان مشکل (فرمت ISO 8601):

جزئیات راه‌اندازی Apigee:
نام سازمان‌ها:
نام‌های Env:
نام‌های پروکسی API:
شماره‌های تجدیدنظر:

مراحل تکثیر:

<در صورت امکان، مراحلی برای بازتولید مشکل ارائه دهید>

اطلاعات تشخیصی:

<لیست فایل‌های پیوست شده>

نمونه موردی

این بخش یک نمونه موردی برای 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): 04-10-2020 06:30 IST

زمان پایان مشکل (فرمت ISO 8601): مشکل هنوز ادامه دارد.

جزئیات راه‌اندازی Apigee Cloud:
نام سازمان: myorg
نام‌های Env: dev
نام‌های پروکسی API: myproxy
تعداد نسخه‌های اصلاح‌شده: 3

مراحل تکثیر:

برای رفع مشکل، دستور curl زیر را اجرا کنید:

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

اطلاعات تشخیصی:

خروجی ابزار ردیابی ( trace-503.xml )

Apigee Edge برای فضای ابری خصوصی

الگو

این بخش یک الگوی نمونه برای Apigee Edge برای فضای ابری خصوصی ارائه می‌دهد.

مشکل:

<شرح مفصلی از مشکل یا رفتاری که از سمت شما مشاهده می‌شود، ارائه دهید. در صورت لزوم، نام و نسخه محصول را نیز ذکر کنید.>

پیام خطا:

<پیام خطای کامل مشاهده شده (در صورت وجود) را وارد کنید>

زمان شروع مشکل (فرمت ISO 8601):

زمان پایان مشکل (فرمت ISO 8601):

جزئیات راه‌اندازی Edge Private Cloud:

<توپولوژی شبکه که نحوه راه‌اندازی ابر خصوصی شما، شامل مراکز داده و گره‌ها را شرح می‌دهد، پیوست کنید>

مراحل تکثیر:

<در صورت امکان، مراحلی برای بازتولید مشکل ارائه دهید>

اطلاعات تشخیصی

<لیست فایل‌های پیوست شده>

نمونه موردی

این بخش یک نمونه موردی برای Apigee Edge برای فضای ابری خصوصی ارائه می‌دهد.

مشکل:

در حالی که ما در حال نصب سرور مدیریت Apigee روی Node #10 به عنوان بخشی از Edge Private Cloud 4.19.06 در لینوکس 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