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

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

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

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

• 1 घंटा
• समीक्षा में एक दिन का समय लगता है
• 7 दिन
• 15 दिन (सिर्फ़ एपीआई)
• 30 दिन (सिर्फ़ एपीआई)

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

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

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

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

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

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

ट्रैफ़िक अलर्ट और नोटिफ़िकेशन जोड़ें

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

1. Edge यूज़र इंटरफ़ेस (यूआई) में विश्लेषण > चेतावनी के नियम पर क्लिक करें.
2. +सूचना पर क्लिक करें.
3. सूचना के बारे में नीचे दी गई सामान्य जानकारी डालें:

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

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

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

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

   सूचना के बारे में जानकारी	ब्यौरा
   चैनल	आपको जिस सूचना चैनल का इस्तेमाल करना है उसे चुनें और उसका डेस्टिनेशन बताएं: ईमेल, Slack, PagerDuty या वेबहुक.
   डेस्टिनेशन	चुने गए चैनल टाइप के आधार पर डेस्टिनेशन की जानकारी दें: ईमेल - ईमेल पता, जैसे कि 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 यूज़र इंटरफ़ेस (यूआई) में इवेंट डैशबोर्ड में अपने-आप लॉग कर देता है. इवेंट डैशबोर्ड में दिखाए गए इवेंट की सूची में, तय की गई और सर्टिफ़िकेट वाली सभी सूचनाएं शामिल होती हैं.

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

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

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

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

ट्रैफ़िक अलर्ट के साथ अलर्ट एपीआई इस्तेमाल करना

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

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

हालांकि, कुछ एपीआई में ऐसी अतिरिक्त प्रॉपर्टी होती हैं जिनका इस्तेमाल गड़बड़ी की चेतावनियों के लिए किया जाता है, जैसे:

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

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

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

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

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

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

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

• conditions कलेक्शन के dimensions एलिमेंट में:
  • आपको 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 प्रॉपर्टी के साथ ट्रैफ़िक के बारे में सूचनाएं नहीं मिलतीं.

नीचे दिए गए उदाहरण में, उस अलर्ट को सेट अप करने का तरीका बताया गया है जो एक घंटे में किसी संगठन और संगठन के ट्रैफ़िक में 50% की बढ़ोतरी होने पर ट्रिगर होता है. सूचना ट्रिगर होने पर, तय किए गए PagerDuty कोड पर एक सूचना भेजी जाती है.

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 का इस्तेमाल करें देखें.

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

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

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

• enabled - अगर true सिर्फ़ चालू की गई चेतावनियां दिखाता है. डिफ़ॉल्ट वैल्यू false है.
• alertType - बताता है कि किस तरह की चेतावनी दिखाई जानी है. runtime, डिफ़ॉल्ट, और cert वैल्यू का इस्तेमाल किया जा सकता है.
• 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 का इस्तेमाल करें देखें.