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 का वह प्रॉडक्ट जिसमें समस्या आ रही है. साथ ही, अगर लागू हो, तो वर्शन की जानकारी भी शामिल करें.
  • वर्शन
समस्या की जानकारी समस्या के बारे में साफ़ तौर पर और पूरी जानकारी दें. इसमें समस्या के बारे में बताएं. साथ ही, अगर कोई गड़बड़ी का मैसेज मिला है, तो उसे भी शामिल करें.
  • गड़बड़ी का मैसेज
  • ट्रेस टूल का आउटपुट
  • समस्या की जानकारी फिर से मुहैया कराने के तरीके
  • पूरा एपीआई अनुरोध/कमांड
  • गड़बड़ी का मैसेज
  • ट्रेस टूल का आउटपुट
  • समस्या की जानकारी फिर से मुहैया कराने के तरीके
  • पूरा एपीआई अनुरोध/कमांड
  • कॉम्पोनेंट की गड़बड़ी की जानकारी देने वाले लॉग
Time समस्या शुरू होने का सटीक टाइमस्टैंप और यह समस्या कितनी देर तक रही.
  • समस्या होने की तारीख, समय, और टाइमज़ोन
  • समस्या की अवधि
  • समस्या होने की तारीख, समय, और टाइमज़ोन
  • समस्या की अवधि
सेटअप उस जगह की पूरी जानकारी जहां समस्या दिख रही है.
  • संगठन का नाम
  • Env name
  • एपीआई प्रॉक्सी का नाम
  • पुनरीक्षण
  • नेटवर्क टोपोलॉजी
  • Edge कॉम्पोनेंट काम नहीं कर रहा है

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

प्रॉडक्ट

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

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

यह करें क्या न करें
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 गड़बड़ियों के बारे में बताने से, हमें समस्या की जांच करने के लिए ज़रूरी जानकारी नहीं मिलती. हमें गड़बड़ी का वह मैसेज और कोड चाहिए जो आपको दिख रहा है.)

समय

समय एक बहुत ही ज़रूरी जानकारी है. सहायता इंजीनियर के लिए यह जानना ज़रूरी है कि आपको इस समस्या के बारे में सबसे पहले कब पता चला, यह समस्या कितने समय तक रही, और क्या यह समस्या अब भी जारी है.

समस्या को हल करने वाला सहायता इंजीनियर, आपके टाइमज़ोन में नहीं हो सकता. इसलिए, समय के बारे में जानकारी देने वाले स्टेटमेंट से समस्या का पता लगाना मुश्किल हो जाता है. इसलिए, तारीख और समय के लिए आईएसओ 8601 फ़ॉर्मैट का इस्तेमाल करने का सुझाव दिया जाता है. इससे यह सटीक जानकारी दी जा सकती है कि समस्या कब हुई.

यहां दी गई टेबल में कुछ उदाहरण दिए गए हैं. इनमें DOs कॉलम में, समस्या होने का सही समय और अवधि दिखाई गई है. वहीं, DON'Ts कॉलम में, समस्या होने के समय के बारे में अस्पष्ट जानकारी दी गई है:

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

कल शाम 5:30 बजे, पांच मिनट के लिए 503s की संख्या में काफ़ी बढ़ोतरी देखी गई.

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

9 नवंबर, 2020 को दोपहर 3:30 बजे आईएसटी से 9 नवंबर, 2020 को शाम 6:10 बजे आईएसटी तक, इन एपीआई प्रॉक्सी में इंतज़ार का समय ज़्यादा था ...

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

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

सेटअप

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

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

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

यह करें क्या न करें

401 Edge Public Cloud पर गड़बड़ियों की संख्या 2020-11-06 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 on Public Cloud और Apigee Edge on Private Cloud:

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

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

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

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

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

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

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

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

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

Apigee Edge on Public Cloud

टेंप्लेट

इस सेक्शन में, Apigee Edge on Public 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 फ़ॉर्मैट):

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

समस्या को दोहराने के लिए:

<Provide steps to reproduce the issue where possible>

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

<अटैच की गई फ़ाइलों की सूची>

उदाहरण

इस सेक्शन में, Apigee Cloud (Apigee on Google Cloud/Apigee Edge on Public Cloud) का एक सैंपल केस दिया गया है.

समस्या:

हमें अपने सार्वजनिक क्लाउड संगठन में, सेवा उपलब्ध नहीं होने से जुड़ी 503 गड़बड़ियां बहुत ज़्यादा दिख रही हैं. कृपया इस समस्या को देखें और इसे हल करें. इसके अलावा, हमें इसे हल करने का तरीका बताएं?

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

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

समस्या शुरू होने का समय (ISO 8601 फ़ॉर्मैट): 2020-10-04 06:30 IST

समस्या खत्म होने का समय (आईएसओ 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 के लिए एक सैंपल टेंप्लेट दिया गया है.

समस्या:

<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 के सेटअप की जानकारी:

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

समस्या को दोहराने के लिए:

<जहां हो सके वहां समस्या को दोहराने के तरीके बताएं>

डाइग्नोस्टिक की जानकारी

<अटैच की गई फ़ाइलों की सूची>

उदाहरण

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

समस्या:

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

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

<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