SpikeArest की नीति

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

स्पाइक अररेस्ट नीति <Rate> एलिमेंट के साथ ट्रैफ़िक में होने वाली बढ़ोतरी से बचाती है. यह एलिमेंट, एपीआई प्रॉक्सी से प्रोसेस किए गए और बैकएंड को भेजे जाने वाले अनुरोधों की संख्या को थ्रॉटल करता है. इससे परफ़ॉर्मेंस लैग और डाउनटाइम से सुरक्षा मिलती है.

<SpikeArrest> एलिमेंट

यह वीडियो, स्पाइक अरेस्ट के लिए बनी नीति के बारे में बताता है.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <DisplayName>display_name</DisplayName>
  <Properties/>
  <Identifier ref="flow_variable"/>
  <MessageWeight ref="flow_variable"/>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest-1">
  <DisplayName>Spike Arrest-1</DisplayName>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

इस एलिमेंट में ये एट्रिब्यूट शामिल होते हैं, जो सभी नीतियों में शामिल हैं:

उदाहरण

यहां दिए गए उदाहरणों में, स्पाइक अरेस्ट नीति को इस्तेमाल करने के कुछ तरीके बताए गए हैं:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate ref="request.header.runtime_rate" />
</SpikeArrest>

curl http://myorg-myenv.apigee.net/price -H 'runtime_rate:30ps'

चाइल्ड एलिमेंट का रेफ़रंस

इस सेक्शन में <SpikeArrest> के चाइल्ड एलिमेंट के बारे में बताया गया है.

<DisplayName>

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

<DisplayName> एलिमेंट सभी नीतियों के लिए समान है.

<DisplayName> एलिमेंट इस सिंटैक्स का इस्तेमाल करता है:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

<DisplayName> एलिमेंट में कोई एट्रिब्यूट या चाइल्ड एलिमेंट नहीं है.

<Identifier>

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

अनुरोध की थ्रॉटलिंग को बेहतर तरीके से कंट्रोल करने के लिए, <MessageWeight> एलिमेंट के साथ इसका इस्तेमाल करें.

अगर <Identifier> एलिमेंट को खाली छोड़ा जाता है, तो उस एपीआई प्रॉक्सी में सभी अनुरोधों के लिए एक दर की सीमा लागू की जाती है.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Identifier ref="flow_variable"/>
</SpikeArrest>
        

<SpikeArrest name="Spike-Arrest-1">
  <Identifier ref="developer.id"/>
  <Rate>42pm</Rate/>
</SpikeArrest>

यहां दी गई टेबल में <Identifier> के एट्रिब्यूट के बारे में बताया गया है:

इस एलिमेंट के बारे में Apigee कम्यूनिटी पोस्ट में भी बताया गया है: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

इससे हर मैसेज के लिए तय किए गए महत्व की जानकारी मिलती है. मैसेज के वज़न से, स्पाइक अरेस्ट रेट के हिसाब से किसी एक अनुरोध के असर में बदलाव होता है. मैसेज का वज़न, फ़्लो वैरिएबल हो सकता है. जैसे, एचटीटीपी हेडर, क्वेरी पैरामीटर, फ़ॉर्म पैरामीटर या मैसेज के मुख्य हिस्से का कॉन्टेंट. JavaScript नीति या AssignmentMessage नीति में जाकर भी कस्टम वैरिएबल का इस्तेमाल किया जा सकता है.

खास क्लाइंट या ऐप्लिकेशन के अनुरोधों को और कम करने के लिए, <Identifier> के साथ इस्तेमाल करें.

उदाहरण के लिए, अगर स्पाइक अरेस्ट <Rate> 10pm है और कोई ऐप्लिकेशन, 2 के वज़न के साथ अनुरोध सबमिट करता है, तो उस क्लाइंट को हर मिनट सिर्फ़ पांच मैसेज भेजने की अनुमति होगी. ऐसा इसलिए, क्योंकि हर अनुरोध को दो मैसेज के तौर पर गिना जाता है.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <MessageWeight ref="flow_variable"/>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

यहां दी गई टेबल में <MessageWeight> के एट्रिब्यूट के बारे में बताया गया है:

<Rate>

यह हर मिनट या प्रति सेकंड के अंतराल में मंज़ूर किए जाने वाले अनुरोधों की संख्या तय करके, ट्रैफ़िक में बढ़ोतरी (या बर्स्ट) की दर तय करता है. इस एलिमेंट को <Identifier> और <MessageWeight> के साथ भी इस्तेमाल किया जा सकता है. इससे, क्लाइंट से वैल्यू स्वीकार करके, रनटाइम के दौरान ट्रैफ़िक को आसानी से थ्रॉटल किया जा सकता है.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

यहां दी गई टेबल में <Rate> के एट्रिब्यूट के बारे में बताया गया है:

<Rate ref="request.header.custom_rate">1pm</Rate>

<UseEffectiveCount>

ऑटो-स्केलिंग ग्रुप का इस्तेमाल करते समय, मैसेज प्रोसेसर (एमपी) में आपकी स्पाइक अरेस्ट संख्या को डिस्ट्रिब्यूट करता है.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name='Spike-Arrest-1'>
  <Rate>40ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

<UseEffectiveCount> एलिमेंट ज़रूरी नहीं है. अगर स्पाइक अरेस्ट नीति से किसी एलिमेंट को हटा दिया जाता है, तो डिफ़ॉल्ट वैल्यू false होती है.

यहां दी गई टेबल में <UseEffectiveCount> एलिमेंट के एट्रिब्यूट के बारे में बताया गया है:

<UseEffectiveCount> का असर, इसकी वैल्यू पर निर्भर करता है:

• true: किसी एमपी की बढ़ोतरी की दर की सीमा, <Rate> को उसी पॉड में एमपी की मौजूदा संख्या से भाग देने पर मिलती है. कुल सीमा, <Rate> की वैल्यू है. जब एमपी को डाइनैमिक तौर पर जोड़ा (या हटाया जाता है), तो उनकी खास बढ़ोतरी की दर बढ़ या घट जाएगी. हालांकि, कुल सीमा में कोई बदलाव नहीं होगा.
• false (अगर वीडियो में कोई बदलाव नहीं किया गया है, तो यह डिफ़ॉल्ट वैल्यू होती है): हर एमपी की बढ़ोतरी की दर की सीमा बस उसकी <Rate> की वैल्यू है. कुल सीमा, सभी एमपी की दरों का कुल योग होती है. जब एमपी को जोड़ा या हटाया जाता है, तो उनकी अलग-अलग बढ़ोतरी की दर की सीमाएं पहले जैसी ही रहेंगी. हालांकि, कुल सीमा बढ़ी या घट जाएगी.

इस टेबल में दिखाया गया है कि हर एमपी के लिए तय की गई, दर की तय सीमा पर <UseEffectiveCount> का क्या असर होता है:

इस उदाहरण में, ध्यान दें कि जब एमपी की संख्या 4 से घटकर 2 हो जाती है और <UseEffectiveCount> false हो जाती है, तो हर एमपी के हिसाब से लागू होने की दर पहले जैसी ही रहती है (10 पर). हालांकि, जब <UseEffectiveCount>, true हो जाता है, तो हर एमपी के हिसाब से सदस्यता की दर 10 से घटकर 20 हो जाती है. ऐसा तब होता है, जब एमपी की संख्या 4 से घटकर 2 हो जाती है.

फ़्लो वैरिएबल

स्पाइक अरेस्ट नीति के लागू होने पर, यह फ़्लो वैरिएबल अपने-आप भर जाता है:

ज़्यादा जानकारी के लिए, फ़्लो वैरिएबल का रेफ़रंस देखें.

गड़बड़ी का रेफ़रंस

इस सेक्शन में गड़बड़ी के कोड और दिखाए गए गड़बड़ी के मैसेज के बारे में बताया गया है. साथ ही, इस नीति के ट्रिगर होने पर Edge की मदद से सेट किए गए गड़बड़ी वाले वैरिएबल के बारे में बताया गया है. यह जानकारी जानना ज़रूरी है कि क्या गड़बड़ियों को ठीक करने के लिए, गड़बड़ी से जुड़े नियम बनाए जा रहे हैं. ज़्यादा जानने के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपको क्या जानने की ज़रूरत है और गड़बड़ियां ठीक करना देखें.

रनटाइम से जुड़ी गड़बड़ियां

नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं.

डिप्लॉयमेंट से जुड़ी गड़बड़ियां

ये गड़बड़ियां तब हो सकती हैं, जब इस नीति वाले किसी प्रॉक्सी को डिप्लॉय किया जाता है.

गड़बड़ी वाले वैरिएबल

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

गड़बड़ी के जवाब का उदाहरण

गड़बड़ी ठीक करने का एक उदाहरण नीचे दिया गया है:

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

गड़बड़ी के नियम का उदाहरण

SpikeArrestViolation गड़बड़ी को ठीक करने के लिए, गड़बड़ी से जुड़े नियम का एक उदाहरण नीचे दिखाया गया है:

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

कोटा या स्पाइक अरेस्ट नीति के तहत सेट की गई दर की सीमा को पार करने के लिए, मौजूदा एचटीटीपी स्टेटस कोड 429 है. इसमें बहुत ज़्यादा अनुरोध किए जा सकते हैं. एचटीटीपी स्टेटस कोड को 500 (इंटरनल सर्वर गड़बड़ी) में बदलने के लिए, संगठन की प्रॉपर्टी अपडेट करें एपीआई का इस्तेमाल करके, features.isHTTPStatusTooManyRequestEnabled प्रॉपर्टी को false पर सेट करें.

उदाहरण के लिए:

curl -u email:password -X POST -H "Content-type:application/xml" http://api.enterprise.apigee.com/v1/organizations/myorg -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isHTTPStatusTooManyRequestEnabled">true</Property>
        . . .
    </Properties>
</Organization>"

स्कीमा

हर तरह की नीति को एक्सएमएल स्कीमा (.xsd) से तय किया जाता है. रेफ़रंस के लिए, नीति के स्कीमा GitHub पर उपलब्ध हैं.

मिलते-जुलते विषय

• कोटा नीति: अलग-अलग क्लाइंट पर ट्रैफ़िक को सीमित करने के लिए कोटा नीति
• दर सीमित करने से जुड़ी खास जानकारी के लिए, दर की सीमा तय करना
• कोटा और SpikeArrest नीतियों की तुलना करना
• एपीआई प्रॉक्सी के काम करने वाले सैंपल