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

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

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

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

تشریح موضوع

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

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

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

محصول

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

جدول زیر نمونه هایی را ارائه می دهد که اطلاعات کامل را در ستون DOs و اطلاعات ناقص را در ستون DON'Ts نشان می دهد:

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

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

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

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

نصب در راه‌اندازی Private Cloud ما انجام نشد.

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

جزئیات مشکل

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

جدول زیر نمونه هایی را ارائه می دهد که اطلاعات کامل را در ستون DOs و اطلاعات ناقص را در ستون DON'Ts نشان می دهد:

DOs نباید

پروکسی جدید 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 برای مهر تاریخ و زمان استفاده کنید تا اطلاعات دقیق زمانی در مورد زمان مشاهده مشکل ارائه شود.

جدول زیر چند نمونه را نشان می دهد که زمان و مدت زمان دقیق رخ دادن مشکل در ستون DOs و اطلاعات مبهم یا مبهم در مورد زمان وقوع مشکل در ستون DON'Ts را نشان می دهد:

DOs نباید
تعداد زیادی 503s دیروز بین 2020-11-06 17:30 PDT و 2020-11-06 17:35 PDT مشاهده شد.

تعداد زیادی 503s دیروز در ساعت 5:30 بعد از ظهر به مدت 5 دقیقه مشاهده شد.

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

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

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

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

راه اندازی

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

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

جدول زیر نمونه هایی را ارائه می دهد که اطلاعات کامل را در ستون DOs و اطلاعات ناقص را در ستون DON'Ts نشان می دهد:

DOs نباید

401 خطا در Edge Public Cloud از 06/11/2020 09:30 CST افزایش یافته است.

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

جزئیات 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 نسخه 4.19.06 راه اندازی نمی شود.

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

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

پس از افزودن گره های دروازه اضافی ، پردازشگر پیام در Edge Private Cloud نسخه 4.19.06 راه اندازی نمی شود.

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

مصنوعات مفید

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

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

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

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

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

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

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

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

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

زباله های انبوه Heap dumps یک عکس فوری از فرآیند حافظه جاوا است. اگر استفاده از حافظه زیاد یا خطاهای OutOfMemory در برخی از اجزای Edge مشاهده شود، مفید است.
تخلیه نخ یک thread dump یک عکس فوری از تمام رشته‌های یک فرآیند جاوا در حال اجرا است.

اگر CPU یا Load بالا در برخی از اجزای Edge مشاهده شود، مفید است.

قالب های مورد و نمونه موارد

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

Apigee Edge در Public Cloud

الگو

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

مشکل:

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

پیغام خطا:

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

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

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

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

مراحل تکثیر:

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

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

<لیست فایل های پیوست>

مورد نمونه

این بخش نمونه‌ای برای Apigee Cloud (Apigee در Google Cloud/Apigee Edge در Public Cloud) ارائه می‌کند.

مشکل:

ما شاهد تعداد زیادی خطای 503 سرویس غیرقابل دسترس در سازمان عمومی ابر هستیم. آیا می توانید مشکل را بررسی کنید و آن را حل کنید یا به ما راهنمایی کنید که چگونه آن را حل کنیم؟

پیغام خطا:

{"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 برای Private Cloud

الگو

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

مشکل:

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

پیغام خطا:

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

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

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

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

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

مراحل تکثیر:

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

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

<لیست فایل های پیوست>

مورد نمونه

این بخش نمونه موردی برای Apigee Edge برای Private Cloud ارائه می دهد.

مشکل:

هنگامی که ما در حال نصب سرور مدیریت Apigee در Node #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