ट्रैफ़िक से जुड़ी सूचनाएं सेट अप करना

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

किसी एनवायरमेंट, प्रॉक्सी या इलाके के ट्रैफ़िक में तय किए गए प्रतिशत के हिसाब से बदलाव होने पर सूचना पाने के लिए, ट्रैफ़िक सूचना का इस्तेमाल करें.

आपने समयसीमा को इस पर सेट किया है:

• 1 घंटा
• 1 दिन
• 7 दिन
• 15 दिन (सिर्फ़ एपीआई के लिए)
• 30 दिन (सिर्फ़ एपीआई)

यह सूचना, मौजूदा समयावधि के ट्रैफ़िक की तुलना पिछली समयावधि के ट्रैफ़िक से करके काम करती है. उदाहरण के लिए, आपने एक घंटे की समयसीमा तय की है. इसके बाद, सूचना में पिछले घंटे के ट्रैफ़िक की तुलना, मौजूदा घंटे के ट्रैफ़िक से की जाती है. इससे ट्रैफ़िक में हुए बदलाव का प्रतिशत पता चलता है:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

पॉज़िटिव वैल्यू का मतलब है कि ट्रैफ़िक बढ़ा है. वहीं, नेगेटिव वैल्यू का मतलब है कि ट्रैफ़िक कम हुआ है.

इसके बाद, थ्रेशोल्ड सेट किया जाता है. इससे, तय की गई समयावधि के लिए एपीआई ट्रैफ़िक में हुई बढ़ोतरी या कमी के प्रतिशत के आधार पर, ट्रैफ़िक से जुड़ी सूचना ट्रिगर होती है.

उस प्रतिशत को सेट करने से पहले, पक्का करें कि वह आपके सामान्य ट्रैफ़िक पैटर्न के मुताबिक हो. उदाहरण के लिए, अगर आपके एपीआई ट्रैफ़िक में दिन भर उतार-चढ़ाव होता रहता है और कुछ व्यस्त समय के दौरान, हर घंटे के हिसाब से ट्रैफ़िक में 100% तक की बढ़ोतरी होती है, तो यह बढ़ोतरी सामान्य है. इससे कोई सूचना ट्रिगर नहीं होनी चाहिए. हालांकि, अगर आपने हर घंटे के ट्रैफ़िक में 50% की बढ़ोतरी होने पर सूचना पाने की सुविधा कॉन्फ़िगर की है, तो आपको सामान्य ट्रैफ़िक के लिए भी गैर-ज़रूरी सूचनाएं मिलेंगी.

अलर्ट के बारे में ज़्यादा जानने के लिए, अलर्ट और सूचनाएं सेट अप करना लेख पढ़ें.

ट्रैफ़िक की सूचनाएं और अलर्ट जोड़ना

1. Edge UI में, विश्लेषण करें > सूचना के नियम पर क्लिक करें.
2. +सूचना पर क्लिक करें.
3. सूचना के बारे में यह सामान्य जानकारी डालें:

   फ़ील्ड	ब्यौरा
   सूचना का नाम	सूचना का नाम. ऐसा नाम इस्तेमाल करें जो ट्रिगर के बारे में बताता हो और आपके लिए काम का हो. नाम में 128 से ज़्यादा वर्ण नहीं होने चाहिए.
   ब्यौरा	सूचना का ब्यौरा.
   अलर्ट प्रकार	कुल ट्रैफ़िक चुनें. ज़्यादा जानकारी के लिए, सूचनाओं के टाइप के बारे में जानकारी देखें.
   परिवेश	ड्रॉप-डाउन सूची से एनवायरमेंट चुनें.
   स्थिति	सूचना पाने की सुविधा को चालू या बंद करने के लिए, टॉगल करें.

4. उस शर्त के लिए थ्रेशोल्ड और डाइमेंशन तय करें जिससे सूचना ट्रिगर होगी.

   शर्त वाला फ़ील्ड	ब्यौरा
   थ्रेशोल्ड	यह तय करें कि पिछले समय के इंटरवल की तुलना में, ट्रैफ़िक में किसी तय प्रतिशत की बढ़ोतरी होने पर या कमी होने पर सूचना मिले. कीमत में बढ़ोतरी के प्रतिशत को 0% से ज़्यादा या उसके बराबर पर सेट करें. कीमत में इतने प्रतिशत की कमी हुई एट्रिब्यूट की वैल्यू को 0% से ज़्यादा या उसके बराबर और 100% से कम या उसके बराबर पर सेट करें. इनमें से कोई एक समयावधि चुनी जा सकती है: 1 घंटा 1 दिन एक हफ़्ता
   डाइमेंशन	+डाइमेंशन जोड़ें पर क्लिक करें. इसके बाद, उस डाइमेंशन की जानकारी दें जिसके लिए नतीजे दिखाने हैं. इसमें एपीआई प्रॉक्सी और क्षेत्र शामिल हैं. किसी डाइमेंशन को इस पर सेट करें: प्रॉक्सी - इसे किसी खास प्रॉक्सी या सभी प्रॉक्सी पर सेट करें. प्रॉक्सी के लिए, "कोई भी" वैल्यू का इस्तेमाल नहीं किया जा सकता. इसके बजाय, आपको जिस प्रॉक्सी में दिलचस्पी है उसके लिए अलग से सूचना जोड़ी जा सकती है. क्षेत्र - इसे किसी खास क्षेत्र या सभी क्षेत्रों पर सेट करें. क्षेत्र एट्रिब्यूट के लिए, "कोई भी" वैल्यू का इस्तेमाल नहीं किया जा सकता. इसके बजाय, आपको जिस इलाके के लिए सूचना चाहिए उसके लिए अलग से सूचना जोड़ी जा सकती है.

5. सूचना जोड़ने के लिए, + सूचना पर क्लिक करें.

   सूचना की जानकारी	ब्यौरा
   चैनल	सूचना पाने के लिए, अपनी पसंद का चैनल चुनें. इसके बाद, सूचना पाने का तरीका चुनें: ईमेल, Slack, PagerDuty या Webhook.
   मंज़िल	चुने गए चैनल टाइप के हिसाब से डेस्टिनेशन तय करें: ईमेल - ईमेल पता, जैसे कि joe@company.com Slack - Slack चैनल का यूआरएल, जैसे कि https://hooks.slack.com/services/T00000000/B00000000/XXXXX PagerDuty - PagerDuty कोड, जैसे कि abcd1234efgh56789 वेबहुक - वेबहुक यूआरएल, जैसे कि https://apigee.com/test-webhook ध्यान दें: हर सूचना के लिए, सिर्फ़ एक डेस्टिनेशन तय किया जा सकता है. एक ही तरह के चैनल के लिए एक से ज़्यादा डेस्टिनेशन तय करने के लिए, सूचनाएं पाने के अन्य तरीके जोड़ें.

6. अन्य सूचनाएं जोड़ने के लिए, पिछला चरण दोहराएं.
7. अगर आपने सूचना जोड़ी है, तो इन फ़ील्ड की वैल्यू सेट करें:

   फ़ील्ड	ब्यौरा
   प्लेबुक	(ज़रूरी नहीं) फ़्री-फ़ॉर्म टेक्स्ट फ़ील्ड. इसमें, सूचनाएं मिलने पर उन्हें ठीक करने के लिए सुझाई गई कार्रवाइयों के बारे में कम शब्दों में जानकारी दी जाती है. आपके पास अपनी इंटरनल विकी या कम्यूनिटी पेज का लिंक देने का विकल्प भी है. इस पेज पर, सबसे सही तरीकों के बारे में बताया गया हो. इस फ़ील्ड में दी गई जानकारी को सूचना में शामिल किया जाएगा. इस फ़ील्ड में मौजूद कॉन्टेंट में 1,500 से ज़्यादा वर्ण नहीं होने चाहिए.
   थ्रॉटल करें	सूचनाएं भेजने की फ़्रीक्वेंसी. ड्रॉप-डाउन सूची से कोई वैल्यू चुनें.

8. सेव करें पर क्लिक करें.

इवेंट डैशबोर्ड में चेतावनियां देखना

जब Edge को किसी सूचना की स्थिति का पता चलता है, तो वह उस स्थिति को Edge के यूज़र इंटरफ़ेस (यूआई) में मौजूद Events डैशबोर्ड में अपने-आप लॉग कर देता है. इवेंट डैशबोर्ड में दिखने वाले इवेंट की सूची में, सभी सूचनाएं शामिल होती हैं. इनमें तय की गई और सर्टिफ़िकेट वाली, दोनों तरह की सूचनाएं शामिल होती हैं.

किसी सूचना को देखने के लिए:

1. Edge के यूज़र इंटरफ़ेस (यूआई) में, विश्लेषण करें > इवेंट पर क्लिक करें. आपको नया इवेंट डैशबोर्ड दिखेगा:

2. इवेंट डैशबोर्ड को इनके हिसाब से फ़िल्टर करें:

   • परिवेश
   • क्षेत्र
   • समयावधि
3. इवेंट डैशबोर्ड में कोई लाइन चुनें, ताकि उस कीस्टोर को दिखाया जा सके जिसमें खत्म हो रहा सर्टिफ़िकेट है. इससे चेतावनी की ज़्यादा जांच की जा सकेगी. कीस्टोर पेज पर जाकर, नया सर्टिफ़िकेट अपलोड किया जा सकता है. साथ ही, खत्म होने वाला सर्टिफ़िकेट मिटाया जा सकता है.

ट्रैफ़िक से जुड़े अलर्ट के साथ, सूचना देने वाले एपीआई का इस्तेमाल करना

ट्रैफ़िक की सूचनाएं बनाने और मैनेज करने के लिए इस्तेमाल किए जाने वाले ज़्यादातर एपीआई, अन्य तरह की सूचनाओं के लिए इस्तेमाल किए जाने वाले एपीआई के जैसे ही होते हैं:

• सूचना पाना - तय की गई सीमा या गड़बड़ी की सूचना की परिभाषा पाएं.
• सूचनाओं का इतिहास पाएं - सूचनाओं के इतिहास की मेट्रिक पाएं.
• सूचना मिटाना - तय की गई सीमा या अनियमितता से जुड़ी सूचना की परिभाषा मिटाएं.
• Get alert instance - इससे ट्रिगर की गई सूचना के बारे में जानकारी मिलती है.
• Get alert count - इससे आपको सूचनाओं की कुल संख्या मिलती है.

हालांकि, कुछ एपीआई में ऐसी अतिरिक्त प्रॉपर्टी होती हैं जिनका इस्तेमाल, अनियमितता की सूचनाओं को दिखाने के लिए किया जाता है. इनमें ये शामिल हैं:

• सूचनाएं पाएं - सभी सूचनाएं पाएं. इनमें ठीक की गई और अनियमितता से जुड़ी सूचनाएं शामिल हैं.
• सूचना बनाना - तय की गई सीमा या अनियमितता के बारे में सूचना बनाएं.
• सूचना अपडेट करना - तय की गई या गड़बड़ी की सूचना की परिभाषा अपडेट करें.

ट्रैफ़िक की सूचना बनाना या उसे अपडेट करना

ट्रैफ़िक की सूचना बनाने या अपडेट करने के लिए, उन्हीं एपीआई का इस्तेमाल करें जिनका इस्तेमाल फ़िलहाल अन्य सूचनाओं के लिए किया जाता है. ट्रैफ़िक की सूचना बनाने या अपडेट करने के लिए, एपीआई कॉल का मुख्य हिस्सा वही होता है जो अन्य सूचनाओं के लिए इस्तेमाल किया जाता है. हालांकि, इसमें ये बदलाव किए जाते हैं:

• यह बताने के लिए कि सूचना, ट्रैफ़िक की सूचना है, ये नई प्रॉपर्टी जोड़ें:

  "alertType": "runtime"
  "alertSubType": "trafficfixed"

  इन प्रॉपर्टी की डिफ़ॉल्ट वैल्यू ये हैं:

  "alertType": "runtime"
  "alertSubType": "fixed"

• dimensions ऐरे के conditions एलिमेंट में:
  • आपको org, env, proxy, और region प्रॉपर्टी की वैल्यू सेट करनी होंगी. सिर्फ़ इन प्रॉपर्टी के साथ काम किया जा सकता है. proxy और region को ALL पर सेट किया जा सकता है.
  • आपको traffic प्रॉपर्टी की वैल्यू को total पर सेट करना होगा.

• conditions ऐरे में:

  • metrics प्रॉपर्टी की वैल्यू trafficChange होनी चाहिए.
  • comparator प्रॉपर्टी को increasedBy या decreasedBy पर सेट किया जाना चाहिए.
  • threshold प्रॉपर्टी में पॉज़िटिव वैल्यू होती है. इससे ट्रैफ़िक में हुई बढ़ोतरी या गिरावट का प्रतिशत पता चलता है. 1.0 की वैल्यू 100% के बराबर होती है. increasedBy के लिए वैल्यू, 0.0 (0%) से ज़्यादा या इसके बराबर होनी चाहिए. decreasedBy के लिए, वैल्यू 0.0 (0%) के बराबर या इससे ज़्यादा और 1.0 (100%) के बराबर या इससे कम होनी चाहिए.
  • durationSeconds प्रॉपर्टी को इनमें से किसी एक वैल्यू पर सेट किया जाना चाहिए: 3600 (1 घंटा), 86400 (1 दिन), 604800 (7 दिन), 1296000 (15 दिन), 2592000 (30 दिन) .
• ट्रैफ़िक की सूचनाओं के लिए, reportEnabled प्रॉपर्टी का इस्तेमाल नहीं किया जा सकता.

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें. इसके बारे में OAuth 2.0 ऐक्सेस टोकन हासिल करना लेख में बताया गया है. इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

इस एपीआई को इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, इवेंट देखना लेख पढ़ें.

ट्रैफ़िक की सूचनाएं पाना

डिफ़ॉल्ट रूप से, Get Alerts एपीआई, तय की गई सभी सूचनाओं के बारे में जानकारी दिखाता है. यह एपीआई अब क्वेरी पैरामीटर लेता है, ताकि नतीजों को फ़िल्टर किया जा सके:

• enabled - अगर true से सिर्फ़ चालू की गई सूचनाएं दिखाने के लिए कहा गया है. डिफ़ॉल्ट वैल्यू false है.
• alertType - इससे यह तय होता है कि किस तरह की सूचनाएं दिखानी हैं. runtime और cert को वैल्यू के तौर पर इस्तेमाल किया जा सकता है. runtime डिफ़ॉल्ट वैल्यू है.
• alertSubType - इससे यह तय होता है कि किस तरह की सूचना दिखाई जाएगी. डिफ़ॉल्ट वैल्यू सेट नहीं है. इसका मतलब है कि सभी सूचना उप-टाइप दिखाएं.

उदाहरण के लिए, myorg नाम के संगठन के लिए, सिर्फ़ सूचनाएं चालू करने की सुविधा वापस पाने के लिए, इस एपीआई कॉल का इस्तेमाल करें:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

नीचे दिए गए कॉल से, सिर्फ़ ट्रैफ़िक अलर्ट मिलते हैं. इनमें वे अलर्ट भी शामिल हैं जिन्हें चालू और बंद किया गया है:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें. इसके बारे में OAuth 2.0 ऐक्सेस टोकन हासिल करना लेख में बताया गया है. इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.