Google Cloud Apigee से जुड़े सहायता मामलों के लिए सबसे सही तरीके

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

Apigee X का दस्तावेज़ देखा जा रहा है.
Apigee Edge का दस्तावेज़ देखें.

सहायता केस में पूरी और ज़रूरी जानकारी देने पर, Google Cloud Apigee की सहायता टीम को आपके सवाल का जवाब जल्दी और बेहतर तरीके से देने में मदद मिलती है. अगर सहायता के लिए सबमिट किए गए आपके मामले में ज़रूरी जानकारी मौजूद नहीं है, तो हमें आपसे ज़्यादा जानकारी मांगनी होगी. इसके लिए, आपको कई बार संपर्क करना पड़ सकता है. इसमें ज़्यादा समय लगता है और समस्याओं को हल करने में देरी हो सकती है. इस सबसे सही तरीकों की गाइड से आपको पता चलता है कि तकनीकी सहायता से जुड़े आपके केस को जल्द से जल्द हल करने के लिए, हमें कौनसी जानकारी चाहिए.

समस्या के बारे में बताना

किसी समस्या की जानकारी में यह बताया जाना चाहिए कि क्या हुआ और क्या होने की उम्मीद थी. साथ ही, यह भी बताया जाना चाहिए कि समस्या कब और कैसे हुई. Apigee सहायता टीम को भेजे गए किसी अच्छे मामले में, Apigee के हर प्रॉडक्ट के लिए यह ज़रूरी जानकारी होनी चाहिए:

अहम जानकारी ब्यौरा पब्लिक क्लाउड के लिए Apigee Edge प्राइवेट क्लाउड के लिए Apigee Edge
प्रॉडक्ट Apigee का वह प्रॉडक्ट जिसमें समस्या आ रही है. इसमें वर्शन की जानकारी भी शामिल होनी चाहिए.
  • वर्शन
समस्या की जानकारी समस्या के बारे में साफ़ तौर पर और पूरी जानकारी दें. इसमें, गड़बड़ी का पूरा मैसेज भी शामिल करें.
  • गड़बड़ी का मैसेज
  • ट्रेस टूल का आउटपुट
  • समस्या की जानकारी फिर से मुहैया कराने का तरीका
  • एपीआई अनुरोध/कमांड पूरा करना
  • गड़बड़ी का मैसेज
  • ट्रेस टूल का आउटपुट
  • समस्या की जानकारी फिर से मुहैया कराने का तरीका
  • एपीआई अनुरोध/कमांड पूरा करना
  • कंपोनेंट के डाइग्नोस्टिक लॉग
समय समस्या शुरू होने का टाइमस्टैंप और यह कि समस्या कितनी देर तक रही.
  • समस्या होने की तारीख, समय, और टाइमज़ोन
  • समस्या कितने समय से है
  • समस्या होने की तारीख, समय, और टाइमज़ोन
  • समस्या कितने समय से है
सेटअप समस्या के बारे में पूरी जानकारी.
  • संगठन का नाम
  • Env का नाम
  • एपीआई प्रॉक्सी का नाम
  • पुनरीक्षण
  • नेटवर्क टोपोलॉजी
  • Edge कॉम्पोनेंट काम नहीं कर रहा है

इन सेक्शन में, इन कॉन्सेप्ट के बारे में ज़्यादा जानकारी दी गई है.

प्रॉडक्ट

Apigee के अलग-अलग प्रॉडक्ट हैं, जैसे कि Public Cloud पर Apigee Edge और Private Cloud पर Apigee Edge. इसलिए, हमें इस बारे में खास जानकारी चाहिए कि किस प्रॉडक्ट में समस्या आ रही है.

नीचे दी गई टेबल में कुछ उदाहरण दिए गए हैं. इनमें क्या करें कॉलम में पूरी जानकारी और क्या न करें कॉलम में अधूरी जानकारी दी गई है:

ये काम करें ऐसा न करें
हमारे Public Cloud संगठन में, एपीआई प्रॉक्सी OAuth2 को डिप्लॉय नहीं किया जा सका ...

एपीआई प्रॉक्सी को डिप्लॉय नहीं किया जा सका

(हमें यह जानना होगा कि आपको Apigee के किस प्रॉडक्ट में समस्या आ रही है.)

Edge Private Cloud के 4.50.00 वर्शन पर, इंस्टॉलेशन इस गड़बड़ी की वजह से पूरा नहीं हो सका ...

हमारे निजी क्लाउड सेटअप पर इंस्टॉल नहीं हो सका.

(वर्शन की जानकारी मौजूद नहीं है)

समस्या की जानकारी

जिस समस्या का पता चला है उसके बारे में पूरी जानकारी दें. इसमें गड़बड़ी का मैसेज (अगर कोई है) और उम्मीद के मुताबिक और असल में दिखने वाले व्यवहार की जानकारी शामिल करें.

नीचे दी गई टेबल में कुछ उदाहरण दिए गए हैं. इनमें क्या करें कॉलम में पूरी जानकारी दी गई है और क्या न करें कॉलम में अधूरी जानकारी दी गई है:

ये काम करें ऐसा न करें

नया 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 फ़ॉर्मैट का इस्तेमाल करें. इससे, समस्या का पता चलने के समय की सटीक जानकारी मिलती है.

यहां दी गई टेबल में कुछ उदाहरण दिए गए हैं. इनमें क्या करें कॉलम में, समस्या के होने का सटीक समय और अवधि दी गई है. वहीं, क्या न करें कॉलम में, समस्या के होने का समय अस्पष्ट या साफ़ तौर पर नहीं बताया गया है:

ये काम करें ऐसा न करें
कल 2020-11-06 17:30 पीडीटी और 2020-11-06 17:35 पीडीटी के बीच, 503s की बड़ी संख्या देखी गई...

कल शाम 5:30 बजे, 503s की बड़ी संख्या 5 मिनट के लिए देखी गई.

(हमें अनुमानित तारीख का इस्तेमाल करना पड़ रहा है. साथ ही, यह भी साफ़ नहीं है कि यह समस्या किस टाइमज़ोन में देखी गई थी.)

09-11-2020 को दोपहर 15:30 बजे आईएसटी से 09-11-2020 को शाम 18:10 बजे आईएसटी तक, इन एपीआई प्रॉक्सी पर इंतज़ार का समय ज़्यादा देखा गया ...

पिछले हफ़्ते, कुछ एपीआई प्रॉक्सी पर ज़्यादा इंतज़ार का समय देखा गया था.

(यह साफ़ तौर पर नहीं पता कि पिछले हफ़्ते यह समस्या किस दिन और कितनी देर तक हुई थी.)

सेटअप

हमें यह जानकारी चाहिए कि आपको समस्या कहां दिख रही है. इस्तेमाल किए जा रहे प्रॉडक्ट के आधार पर, हमें यह जानकारी चाहिए:

  • अगर Apigee Cloud का इस्तेमाल किया जा रहा है, तो हो सकता है कि आपके पास एक से ज़्यादा संगठन हों. इसलिए, हमें उस संगठन और अन्य जानकारी के बारे में पता होना चाहिए जहां आपको समस्या आ रही है:
    • संगठन और एनवायरमेंट के नाम
    • एपीआई प्रॉक्सी का नाम और बदलाव के नंबर (एपीआई अनुरोध पूरा न होने पर)
  • अगर निजी क्लाउड का इस्तेमाल किया जा रहा है, तो हो सकता है कि आपने काम करने वाले कई इंस्टॉलेशन टोपोलॉजी में से किसी एक का इस्तेमाल किया हो. इसलिए, हमें यह जानना होगा कि आपने किस टोपोलॉजी का इस्तेमाल किया है. इसमें, डेटा सेंटर और नोड की संख्या जैसी जानकारी शामिल है.

नीचे दी गई टेबल में कुछ उदाहरण दिए गए हैं. इनमें क्या करें कॉलम में पूरी जानकारी दी गई है और क्या न करें कॉलम में अधूरी जानकारी दी गई है:

ये काम करें ऐसा न करें

401 06-11-2020 09:30 सीएसटी से, Edge Public Cloud पर गड़बड़ियों की संख्या बढ़ गई है.

एज सेटअप की जानकारी:

काम न करने वाले एपीआई की जानकारी यहां दी गई है:
  संगठन के नाम: 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 के सभी प्रॉडक्ट के लिए काम के हैं: Public Cloud पर Apigee Edge और Private Cloud पर Apigee Edge:

सह-प्रॉडक्ट ब्यौरा
ट्रेस टूल का आउटपुट ट्रेस टूल के आउटपुट में, Apigee प्रॉडक्ट के ज़रिए भेजे गए एपीआई अनुरोधों के बारे में पूरी जानकारी होती है. यह 4XX, 5XX, और इंतज़ार के समय से जुड़ी समस्याओं जैसी किसी भी रनटाइम गड़बड़ी के लिए मददगार है.
स्क्रीनशॉट स्क्रीनशॉट की मदद से, असल व्यवहार या गड़बड़ी के बारे में जानकारी दी जा सकती है. यह यूज़र इंटरफ़ेस (यूआई) या Analytics जैसी किसी भी गड़बड़ी या समस्या के लिए मददगार है.
HAR (Http ARchive) एचएआर एक ऐसी फ़ाइल है जिसे एचटीटीपी सेशन टूल, यूज़र इंटरफ़ेस से जुड़ी किसी भी समस्या को डीबग करने के लिए कैप्चर करते हैं. इसे Chrome, Firefox या Internet Explorer जैसे ब्राउज़र का इस्तेमाल करके कैप्चर किया जा सकता है.
tcpdumps tcpdump टूल, नेटवर्क पर ट्रांसफ़र किए गए या पाए गए टीसीपी/आईपी पैकेट को कैप्चर करता है. यह नेटवर्क से जुड़ी किसी भी समस्या के लिए काम का है. जैसे, TLS हैंडशेक की गड़बड़ियां, 502 गड़बड़ियां, और इंतज़ार का समय वगैरह.

Apigee Edge for Private Cloud के लिए अतिरिक्त आर्टफ़ैक्ट

Private Cloud के लिए Apigee Edge के लिए, हमें कुछ और आर्टफ़ैक्ट की ज़रूरत पड़ सकती है. इससे, समस्याओं का जल्दी पता चल पाएगा.

सह-प्रॉडक्ट ब्यौरा
नेटवर्क टोपोलॉजी Edge इंस्टॉलेशन टॉपोलॉजी डायग्राम, जिसमें आपके निजी क्लाउड सेटअप के बारे में बताया गया है. इसमें, हर नोड में इंस्टॉल किए गए सभी डेटा सेंटर, नोड, और कॉम्पोनेंट शामिल हैं.
Edge कॉम्पोनेंट के डाइग्नोस्टिक्स लॉग Apigee Edge के किसी खास कॉम्पोनेंट से जुड़े डाइग्नोस्टिक्स लॉग, जैसे कि मैसेज प्रोसेसर, राऊटर या Cassandra.
इंस्टॉलेशन कॉन्फ़िगरेशन फ़ाइल साइलेंट कॉन्फ़िगरेशन फ़ाइल, जिसका इस्तेमाल Apigee Edge को इंस्टॉल या अपग्रेड करते समय किया जाता है.

यह फ़ाइल, इंस्टॉलेशन या माइग्रेशन से जुड़ी समस्याओं के मामलों में, यह पुष्टि करने के लिए काम की है कि सभी सेटिंग सही हैं या नहीं.

हीप डंप हीप डंप, Java मेमोरी प्रोसेस का स्नैपशॉट होता है. यह तब मददगार होता है, जब कुछ Edge कॉम्पोनेंट पर ज़्यादा मेमोरी का इस्तेमाल हो रहा हो या OutOfMemory गड़बड़ियां दिख रही हों.
थ्रेड डंप थ्रेड डंप, चल रही Java प्रोसेस की सभी थ्रेड का स्नैपशॉट होता है.

यह तब मददगार होता है, जब कुछ Edge कॉम्पोनेंट पर सीपीयू या लोड का इस्तेमाल ज़्यादा हो.

केस टेंप्लेट और सैंपल केस

इस सेक्शन में, इस दस्तावेज़ में बताए गए सबसे सही तरीकों के आधार पर, अलग-अलग प्रॉडक्ट के लिए केस टेंप्लेट और सैंपल केस दिए गए हैं:

पब्लिक क्लाउड पर Apigee Edge

टेंप्लेट

इस सेक्शन में, Public Cloud पर Apigee Edge के लिए सैंपल टेंप्लेट दिया गया है.

समस्या:

<Provide detailed description of the problem or the behaviour being observed at your end. जहां लागू हो वहां प्रॉडक्ट का नाम और वर्शन शामिल करें.>

गड़बड़ी का मैसेज:

<Include the complete error message observed (if any)>

समस्या शुरू होने का समय (ISO 8601 फ़ॉर्मैट):

समस्या खत्म होने का समय (ISO 8601 फ़ॉर्मैट):

Apigee सेटअप की जानकारी:
  संगठन के नाम:
  एनवायरमेंट के नाम:
  एपीआई प्रॉक्सी के नाम:
  बदलाव के नंबर:

समस्या को दोहराने का तरीका:

<Provide steps to reproduce the issue where possible>

गड़बड़ी की जानकारी:

<List of files attached>

सैंपल केस

इस सेक्शन में, Apigee Cloud (Google Cloud पर Apigee/सार्वजनिक क्लाउड पर 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
  एनवायरमेंट के नाम: dev
  एपीआई प्रॉक्सी के नाम: myproxy
  बदलाव के नंबर: 3

समस्या को दोहराने का तरीका:

समस्या को दोबारा देखने के लिए, यह curl कमांड चलाएं:

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

गड़बड़ी की जानकारी:

ट्रेस टूल का आउटपुट (trace-503.xml)

प्राइवेट क्लाउड के लिए Apigee Edge

टेंप्लेट

इस सेक्शन में, Apigee Edge for Private Cloud के लिए सैंपल टेंप्लेट दिया गया है.

समस्या:

<Provide detailed description of the problem or the behaviour being observed at your end. जहां लागू हो वहां प्रॉडक्ट का नाम और वर्शन शामिल करें.>

गड़बड़ी का मैसेज:

<Include the complete error message observed (if any)>

समस्या शुरू होने का समय (ISO 8601 फ़ॉर्मैट):

समस्या खत्म होने का समय (ISO 8601 फ़ॉर्मैट):

Edge Private Cloud के सेटअप की जानकारी:

<अपने निजी क्लाउड के सेटअप के बारे में बताने वाली नेटवर्क टोपोलॉजी अटैच करें. इसमें, डेटा सेंटर और नोड शामिल हों>

समस्या को दोहराने का तरीका:

<Provide steps to reproduce the issue where possible>

गड़बड़ी की जानकारी

<List of files attached>

सैंपल केस

इस सेक्शन में, Private Cloud के लिए Apigee Edge का सैंपल केस दिया गया है.

समस्या:

Linux RHEL 7.6 पर Edge Private Cloud 4.19.06 के हिस्से के तौर पर, नोड #10 पर Apigee मैनेजमेंट सर्वर इंस्टॉल करते समय, हमें यह गड़बड़ी आ रही है.

गड़बड़ी का मैसेज:

<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