روال‌های مطلوب برای موارد پشتیبانی 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 در «ابر عمومی» و Apigee Edge در «ابر خصوصی»، بنابراین به اطلاعات خاصی درباره اینکه کدام محصول خاص مشکل دارد نیاز داریم.

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

DOs نبایدها
استقرار کارگزار نیابتی API OAuth2 در سازمان Public Cloud ما ناموفق بود ...

استقرار پراکسی میانای برنامه‌سازی کاربردی ناموفق بود

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

نصب با خطای زیر در نسخه 4.50.00 «ابر خصوصی Edge» ناموفق بود ...

نصب در راه‌اندازی «ابر خصوصی» ما ناموفق بود.

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

جزئیات مشکل

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

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

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"}}}

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

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

زمان

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

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

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

DOs نبایدها
تعداد زیادی 503s دیروز بین ۲۰۲۰-۱۱-۰۶ ۱۷:۳۰ به‌وقت تابستانی غرب امریکا و ۲۰۲۰-۱۱-۰۶ ۱۷:۳۵ به‌وقت تابستانی غرب امریکا مشاهده شد…

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

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

تأخیرهای بالایی در «پراکسی‌های میانای برنامه‌سازی کاربردی» زیر از ۹ نوامبر ۲۰۲۰ ۱۵:۳۰ به وقت رسمی هند تا ۹ نوامبر ۲۰۲۰ ۱۸:۱۰ به وقت رسمی هند مشاهده شد ...

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

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

راه‌اندازی

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

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

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

DOs نبایدها

از ۲۰۲۰-۱۱-۰۶ ۰۹:۳۰ به وقت CST، تعداد خطاهای 401 در Edge Public Cloud افزایش یافته است.

جزئیات راه‌اندازی 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 نسخه ۴.۱۹.۰۶ راه‌اندازی نشد.

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

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

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

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

آرتیفکت‌های مفید

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

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

داده‌های جلسه مشترک برای همه محصولات Apigee

آرتیفکت‌های زیر برای همه محصولات Apigee مفید هستند: Apigee Edge در «ابر عمومی» و Apigee Edge در «ابر خصوصی»:

آرتیفکت شرح
برونداد ابزار ردیابی برونداد ابزار «ردیابی» حاوی اطلاعات دقیق درباره درخواست‌های API است که ازطریق محصولات Apigee جریان می‌یابد. این برای هرگونه خطای زمان اجرا مانند 4XX، 5XX، و مشکلات تأخیر مفید است.
نماگرفت‌ها نماگرفت‌ها به انتقال زمینه رفتار یا خطای واقعی مشاهده‌شده کمک می‌کنند. این برای هرگونه خطا یا مشکل مشاهده‌شده، مانند در رابط کاربری یا Analytics، مفید است.
HAR (Http ARchive) ‫HAR فایلی است که توسط ابزارهای جلسه HTTP برای اشکال‌زدایی مشکلات مربوط به رابط کاربری ضبط می‌شود. این اطلاعات را می‌توان بااستفاده از مرورگرهایی مثل Chrome،‏ Firefox، یا Internet Explorer ضبط کرد.
tcpdumps ابزار tcpdump بسته‌های TCP/IP را که ازطریق شبکه منتقل یا دریافت می‌شوند ضبط می‌کند. این برای هرگونه مشکل مربوط به شبکه مانند خطاهای دست دادن TLS، خطاهای 502، و مشکلات تأخیر و غیره مفید است.

آرتیفکت‌های اضافی برای Apigee Edge برای «ابر خصوصی»

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

آرتیفکت شرح
توپولوژی شبکه نمودار توپولوژی نصب Edge که تنظیمات «ابر خصوصی» شما را شامل همه مراکز داده، گره‌ها، و عناصر نصب‌شده در هر گره توصیف می‌کند.
گزارش‌های تشخیص خرابی مؤلفه Edge گزارش‌های تشخیص خرابی مربوط به عنصر خاص Apigee Edge مثل «پردازنده پیام»، «مسیریاب»، یا Cassandra.
فایل پیکربندی نصب فایل پیکربندی بی‌صدا که هنگام نصب یا ارتقا دادن Apigee Edge استفاده می‌شود.

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

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

اگر در برخی‌از عناصر Edge از CPU یا «بار» بالا استفاده شود، این کار مفید است.

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

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

‫Apigee Edge در «ابر عمومی»

الگو

این بخش الگوی نمونه‌ای برای Apigee Edge در «ابر عمومی» ارائه می‌دهد.

مشکل:

<Provide detailed description of the problem or the behaviour being observed at your end. درصورت لزوم، نام و نسخه محصول را ذکر کنید.>

پیام خطا:

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

زمان شروع مشکل (قالب ISO 8601):

زمان پایان مشکل (قالب ISO 8601):

جزئیات راه‌اندازی Apigee:
  نام‌های سازمان:
  نام‌های محیط:
  نام‌های پراکسی API:
  شماره‌های بازبینی:

مراحل بازتولید:

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

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

<List of files attached>

پرونده نمونه

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

مشکل:

تعداد زیادی خطای «۵۰۳ سرویس دردسترس نیست» در 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
  نام‌های پراکسی API: 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 ارائه می‌دهد.

مشکل:

<Provide detailed description of the problem or the behaviour being observed at your end. درصورت لزوم، نام و نسخه محصول را ذکر کنید.>

پیام خطا:

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

زمان شروع مشکل (قالب ISO 8601):

زمان پایان مشکل (قالب ISO 8601):

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

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

مراحل بازتولید:

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

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

<List of files attached>

پرونده نمونه

این بخش نمونه‌ای از Apigee Edge برای «ابر خصوصی» را ارائه می‌دهد.

مشکل:

درحالی‌که درحال نصب «سرور مدیریت Apigee» در «گره #۱۰» به‌عنوان بخشی از 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