از افزونه ها استفاده کنید

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

میکروگیت‌وی اج نسخه ۳.۰.x

مخاطب

این مبحث برای اپراتورهای Edge Microgateway در نظر گرفته شده است که مایل به استفاده از افزونه‌های موجود نصب شده با microgateway هستند. همچنین در مورد افزونه‌های spike arrest و quota (هر دو در نصب گنجانده شده‌اند) به تفصیل بحث می‌شود. اگر شما توسعه‌دهنده‌ای هستید که می‌خواهید افزونه‌های جدیدی توسعه دهید، به بخش توسعه افزونه‌های سفارشی مراجعه کنید.

افزونه Edge Microgateway چیست؟

یک افزونه، یک ماژول Node.js است که قابلیتی را به Edge Microgateway اضافه می‌کند. ماژول‌های افزونه از یک الگوی ثابت پیروی می‌کنند و در مکانی که برای Edge Microgateway شناخته شده است، ذخیره می‌شوند و به این ترتیب، Microgateway می‌تواند آنها را به طور خودکار کشف و بارگذاری کند. Edge Microgateway شامل چندین افزونه موجود است و شما همچنین می‌توانید افزونه‌های سفارشی ایجاد کنید، همانطور که در بخش «توسعه افزونه‌های سفارشی» توضیح داده شده است.

افزونه‌های موجود همراه با Edge Microgateway

چندین افزونه موجود در هنگام نصب Edge Microgateway ارائه می‌شوند. این افزونه‌ها عبارتند از:

افزونه‌های موجود را از کجا پیدا کنیم

افزونه‌های موجود همراه با Edge Microgateway در اینجا قرار دارند، که [prefix] دایرکتوری پیشوند npm است. اگر نمی‌توانید این دایرکتوری را پیدا کنید ، به «محل نصب Edge Microgateway» مراجعه کنید.

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins

افزودن و پیکربندی افزونه‌ها

برای افزودن و پیکربندی افزونه‌ها، از این الگو پیروی کنید:

1. میکروگیت‌وی اج را متوقف کنید.
2. یک فایل پیکربندی Edge Microgateway را باز کنید. برای جزئیات بیشتر، به «ایجاد تغییرات پیکربندی» برای گزینه‌ها مراجعه کنید.
3. افزونه را به عنصر plugins:sequence فایل پیکربندی، به صورت زیر اضافه کنید. افزونه‌ها به ترتیبی که در این لیست ظاهر می‌شوند، اجرا می‌شوند.

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
     level: info
     dir: /var/tmp
     stats_log_interval: 60
  plugins:
     dir: ../plugins
     sequence:   
     - oauth
     - plugin-name

4. افزونه را پیکربندی کنید. برخی از افزونه‌ها پارامترهای اختیاری دارند که می‌توانید آنها را در فایل پیکربندی پیکربندی کنید. برای مثال، می‌توانید عبارت زیر را برای پیکربندی افزونه‌ی spike arrest اضافه کنید. برای اطلاعات بیشتر به بخش «استفاده از افزونه‌ی spike arrest» مراجعه کنید.

   edgemicro:
     home: ../gateway
     port: 8000
     max_connections: -1
     max_connections_hard: -1
     logging:
       level: info
       dir: /var/tmp
       stats_log_interval: 60
     plugins:
       dir: ../plugins
       sequence:
         - oauth
         - spikearrest
   spikearrest:
      timeUnit: minute
      allow: 10

5. فایل را ذخیره کنید.
6. بسته به اینکه کدام فایل پیکربندی را ویرایش کرده‌اید، Edge Microgateway را مجدداً راه‌اندازی یا بارگذاری کنید.

پیکربندی مخصوص افزونه

شما می‌توانید پارامترهای افزونه مشخص شده در فایل پیکربندی را با ایجاد یک پیکربندی مخصوص افزونه در این دایرکتوری، لغو کنید:

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins/config

که در آن [prefix] دایرکتوری پیشوند npm است. اگر نمی‌توانید این دایرکتوری را پیدا کنید ، به «محل نصب Edge Microgateway» مراجعه کنید.

plugins/<plugin_name>/config/default.yaml . برای مثال، می‌توانید این بلوک را در plugins/spikearrest/config/default.yaml قرار دهید و آنها سایر تنظیمات پیکربندی را نادیده می‌گیرند.

spikearrest:
   timeUnit: hour   
   allow: 10000   
   buffersize: 0

استفاده از افزونه‌ی مهار اسپایک

افزونه‌ی جلوگیری از افزایش ناگهانی ترافیک، از افزایش ناگهانی ترافیک جلوگیری می‌کند. این افزونه تعداد درخواست‌های پردازش‌شده توسط یک نمونه‌ی Edge Microgateway را کاهش می‌دهد.

اضافه کردن افزونه‌ی مهار اسپایک

به افزودن و پیکربندی افزونه‌ها مراجعه کنید.

پیکربندی نمونه برای مهار اسپایک

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
    sequence:
      - oauth
      - spikearrest
spikearrest:
   timeUnit: minute
   allow: 10
   bufferSize: 5

گزینه‌های پیکربندی برای جلوگیری از اسپایک

• واحد زمان : پنجره اجرای توقف اسپایک هر چند وقت یکبار ریست می‌شود. مقادیر معتبر ثانیه یا دقیقه هستند.
• allow : حداکثر تعداد درخواست‌هایی که در طول timeUnit مجاز هستند. همچنین ببینید اگر چندین فرآیند Edge Micro را اجرا می‌کنید .
• bufferSize : (اختیاری، پیش‌فرض = 0) اگر bufferSize > 0 باشد، spike arrest این تعداد درخواست را در یک بافر ذخیره می‌کند. به محض اینکه "پنجره" اجرای بعدی رخ دهد، ابتدا درخواست‌های بافر شده پردازش می‌شوند. همچنین به افزودن یک بافر مراجعه کنید.

مهار اسپایک چگونه کار می‌کند؟

به جای اینکه به عنوان راهی برای محدود کردن ترافیک به تعداد مشخصی از درخواست‌ها، به مهار اسپایک فکر کنید، آن را به عنوان راهی برای محافظت کلی در برابر اسپایک‌های ترافیکی در نظر بگیرید. APIها و backend شما می‌توانند مقدار مشخصی از ترافیک را مدیریت کنند و سیاست مهار اسپایک به شما کمک می‌کند تا ترافیک را به مقادیر کلی مورد نظر خود هدایت کنید.

رفتار توقف اسپایک در زمان اجرا با آنچه که ممکن است انتظار داشته باشید از مقادیر وارد شده بر حسب دقیقه یا ثانیه ببینید، متفاوت است.

برای مثال، فرض کنید نرخ ۳۰ درخواست در دقیقه را به صورت زیر تعیین می‌کنید:

spikearrest:
   timeUnit: minute
   allow: 30

در آزمایش، ممکن است فکر کنید که می‌توانید 30 درخواست را در 1 ثانیه ارسال کنید، البته تا زمانی که ظرف یک دقیقه برسند. اما این نحوه‌ی اعمال تنظیمات توسط این سیاست نیست. اگر در مورد آن فکر کنید، 30 درخواست در یک دوره 1 ثانیه‌ای می‌تواند در برخی محیط‌ها یک جهش کوچک در نظر گرفته شود.

پس واقعاً چه اتفاقی می‌افتد؟ برای جلوگیری از رفتار شبیه به spike، سیستم spike arrest با تقسیم تنظیمات شما به فواصل کوچکتر، ترافیک مجاز را به صورت زیر روان می‌کند:

نرخ‌های دقیقه‌ای

نرخ‌های هر دقیقه به درخواست‌های مجاز بر حسب ثانیه تبدیل می‌شوند. برای مثال، 30 درخواست در دقیقه به صورت زیر تبدیل می‌شود:

۶۰ ثانیه (۱ دقیقه) / ۳۰ = فواصل ۲ ثانیه‌ای، یا حدود ۱ درخواست مجاز در هر ۲ ثانیه. درخواست دوم در عرض ۲ ثانیه با شکست مواجه خواهد شد. همچنین، درخواست سی و یکم در عرض یک دقیقه با شکست مواجه خواهد شد.

نرخ‌های ثانیه‌ای

نرخ‌های بر ثانیه به درخواست‌های مجاز در فواصل میلی‌ثانیه تبدیل می‌شوند. برای مثال، 10 درخواست در ثانیه به صورت زیر تبدیل می‌شود:

۱۰۰۰ میلی‌ثانیه (۱ ثانیه) / ۱۰ = فواصل ۱۰۰ میلی‌ثانیه‌ای، یا حدود ۱ درخواست مجاز در هر ۱۰۰ میلی‌ثانیه. درخواست دوم در فاصله ۱۰۰ میلی‌ثانیه با شکست مواجه خواهد شد. همچنین، درخواست یازدهم در عرض یک ثانیه با شکست مواجه خواهد شد.

وقتی از حد مجاز فراتر می‌رود

اگر تعداد درخواست‌ها در بازه زمانی مشخص شده از حد مجاز فراتر رود، spike arrest این پیام خطا را با وضعیت HTTP 503 برمی‌گرداند:

{"error": "spike arrest policy violated"}

اضافه کردن بافر

شما می‌توانید یک بافر به این سیاست اضافه کنید. فرض کنید بافر را روی ۱۰ تنظیم کرده‌اید. خواهید دید که API وقتی از حد مجاز توقف spike تجاوز می‌کنید، بلافاصله خطایی برنمی‌گرداند. در عوض، درخواست‌ها بافر می‌شوند (تا تعداد مشخص شده) و درخواست‌های بافر شده به محض اینکه پنجره اجرای مناسب بعدی در دسترس باشد، پردازش می‌شوند. مقدار پیش‌فرض bufferSize برابر با ۰ است.

اگر چندین فرآیند Edge Micro را اجرا می‌کنید

تعداد درخواست‌های مجاز به تعداد فرآیندهای کارگر Edge Micro که در حال اجرا هستند بستگی دارد. Spike arrest تعداد مجاز درخواست‌ها به ازای هر فرآیند کارگر را محاسبه می‌کند. به طور پیش‌فرض، تعداد فرآیندهای Edge Micro برابر با تعداد CPUهای روی دستگاهی است که Edge Micro در آن نصب شده است. با این حال، می‌توانید تعداد فرآیندهای کارگر را هنگام شروع Edge Micro با استفاده از گزینه --processes در دستور start پیکربندی کنید. به عنوان مثال، اگر می‌خواهید spike arrest در 100 درخواست در یک دوره زمانی معین فعال شود، و اگر Edge Microgateway را با گزینه --processes 4 شروع می‌کنید، allow: 25 در پیکربندی spike arrest تنظیم کنید. به طور خلاصه، قاعده کلی این است که پارامتر allow config را روی مقدار "تعداد مورد نظر spike arrest / تعداد فرآیندها" تنظیم کنید.

استفاده از افزونه سهمیه‌بندی

سهمیه تعداد پیام‌های درخواستی را که یک برنامه مجاز است در طول یک ساعت، روز، هفته یا ماه به یک API ارسال کند، مشخص می‌کند. هنگامی که یک برنامه به حد سهمیه خود می‌رسد، فراخوانی‌های API بعدی رد می‌شوند. همچنین ببینید تفاوت بین spike arrest و سهمیه چیست ؟

اضافه کردن افزونه سهمیه‌بندی

به افزودن و پیکربندی افزونه‌ها مراجعه کنید.

پیکربندی محصول در Apigee Edge

شما سهمیه‌ها را در رابط کاربری Apigee Edge پیکربندی می‌کنید، جایی که محصولات API را پیکربندی می‌کنید. باید بدانید کدام محصول حاوی پروکسی microgateway-aware است که می‌خواهید با سهمیه محدود کنید. این محصول باید به یک برنامه توسعه‌دهنده اضافه شود. وقتی فراخوانی‌های API را که با استفاده از کلیدها در برنامه توسعه‌دهنده تأیید می‌شوند، انجام می‌دهید، سهمیه به آن فراخوانی‌های API اعمال می‌شود.

1. وارد حساب کاربری خود در سازمان Apigee Edge شوید.
2. در رابط کاربری Edge، محصول مرتبط با پروکسی microgateway-aware که می‌خواهید سهمیه را به آن اعمال کنید، باز کنید.
   1. در رابط کاربری، از منوی انتشار، گزینه محصولات (Products) را انتخاب کنید.
   2. محصولی که حاوی API است و می‌خواهید سهمیه را به آن اعمال کنید، باز کنید.
   3. روی ویرایش کلیک کنید.
   4. در فیلد سهمیه، بازه سهمیه را مشخص کنید. برای مثال، ۱۰۰ درخواست در هر یک دقیقه. یا ۵۰۰۰۰ درخواست در هر ۲ ساعت.
      
      

3. روی ذخیره کلیک کنید.
4. مطمئن شوید که محصول به یک برنامه توسعه‌دهنده اضافه شده است. برای برقراری تماس‌های API احراز هویت شده، به کلیدهای این برنامه نیاز خواهید داشت.

پیکربندی نمونه برای سهمیه

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
    sequence:
      - oauth
      - quota

گزینه‌های پیکربندی برای سهمیه‌بندی

برای پیکربندی افزونه سهمیه‌بندی، عنصر quotas را به فایل پیکربندی خود اضافه کنید، همانطور که در مثال زیر نشان داده شده است:

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
    sequence:
      - oauth
      - quota
quotas:
  bufferSize:
    hour: 20000
    minute: 500
    month: 1
    default: 10000
  useDebugMpId: true
  failOpen: true
  useRedis: true
  redisHost: localhost
  redisPort: 6379
  redisDb: 1
...

edgemicro:
...
quotas:
  failOpen: true

edgemicro:
...
quotas:
  useDebugMpId: true
...

{
    "allowed": 20,
    "used": 3,
    "exceeded": 0,
    "available": 17,
    "expiryTime": 1570748640000,
    "timestamp": 1570748580323,
    "debugMpId": "6a12dd72-5c8a-4d39-b51d-2c64f953de6a"
}

درک محدوده سهمیه

تعداد سهمیه به یک محصول API محدود می‌شود. اگر یک برنامه توسعه‌دهنده چندین محصول داشته باشد، سهمیه به صورت جداگانه به هر یک از آنها محدود می‌شود. برای دستیابی به این محدوده، Edge Microgateway یک شناسه سهمیه ایجاد می‌کند که ترکیبی از "appName + productName" است.

تست افزونه سهمیه‌بندی

وقتی سهمیه از حد مجاز فراتر رود، وضعیت HTTP 403 به همراه پیام زیر به کلاینت بازگردانده می‌شود:

{"error": "exceeded quota"}

تفاوت بین دستگیری اسپایک و سهمیه چیست؟

انتخاب ابزار مناسب برای کار مورد نظر بسیار مهم است. سیاست‌های سهمیه‌بندی، تعداد پیام‌های درخواستی را که یک برنامه کلاینت مجاز است در طول یک ساعت، روز، هفته یا ماه به یک API ارسال کند، پیکربندی می‌کنند. سیاست سهمیه‌بندی با حفظ یک شمارنده توزیع‌شده که درخواست‌های ورودی را شمارش می‌کند، محدودیت‌های مصرف را برای برنامه‌های کلاینت اعمال می‌کند.

از سیاست سهمیه‌بندی برای اجرای قراردادهای تجاری یا SLA با توسعه‌دهندگان و شرکا استفاده کنید، نه برای مدیریت ترافیک عملیاتی. به عنوان مثال، سهمیه‌بندی ممکن است برای محدود کردن ترافیک برای یک سرویس رایگان استفاده شود، در حالی که دسترسی کامل را برای مشتریان پولی فراهم می‌کند.

برای محافظت در برابر افزایش ناگهانی ترافیک API از spike arrest استفاده کنید. معمولاً از spike arrest برای جلوگیری از حملات DDoS یا سایر حملات مخرب احتمالی استفاده می‌شود.