ใช้ปลั๊กอิน

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X info

Edge Microgateway v. 3.0.x

กลุ่มเป้าหมาย

หัวข้อนี้มีไว้สำหรับผู้ปฏิบัติงาน Edge Microgateway ที่ต้องการใช้ปลั๊กอินที่มีอยู่ซึ่ง ติดตั้งไว้กับ Microgateway นอกจากนี้ยังกล่าวถึงปลั๊กอินการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วและปลั๊กอินโควต้าโดยละเอียด (ทั้ง 2 ปลั๊กอินรวมอยู่ในการติดตั้ง) หากคุณเป็นนักพัฒนาแอปที่ต้องการพัฒนาปลั๊กอินใหม่ โปรดดูหัวข้อพัฒนา ปลั๊กอินที่กำหนดเอง

ปลั๊กอิน 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. หยุด Edge Microgateway
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. กำหนดค่าปลั๊กอิน ปลั๊กอินบางรายการมีพารามิเตอร์ที่ไม่บังคับซึ่งคุณกำหนดค่าได้ใน ไฟล์การกำหนดค่า ตัวอย่างเช่น คุณสามารถเพิ่ม stanza ต่อไปนี้เพื่อกำหนดค่าปลั๊กอินการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็ว ดูข้อมูลเพิ่มเติมได้ที่ การใช้ปลั๊กอินการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็ว

   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

ตัวเลือกการกำหนดค่าสำหรับการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็ว

• timeUnit: ความถี่ที่หน้าต่างการดำเนินการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วจะรีเซ็ต ค่าที่ถูกต้อง คือ "second" หรือ "minute"
• allow: จำนวนคำขอสูงสุดที่อนุญาตในระหว่าง timeUnit ดูเพิ่มเติมที่ ที่ หากคุณเรียกใช้กระบวนการ Edge Micro หลายรายการ
• bufferSize: (ไม่บังคับ ค่าเริ่มต้น = 0) หาก bufferSize > 0 การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็ว จะจัดเก็บคำขอจำนวนนี้ไว้ในบัฟเฟอร์ เมื่อหน้าต่างการดำเนินการถัดไปเกิดขึ้น คำขอที่บัฟเฟอร์ไว้จะได้รับการประมวลผลก่อน ดูเพิ่มเติมที่การเพิ่ม บัฟเฟอร์

การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วทำงานอย่างไร

ให้มองว่าการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วเป็นวิธีป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วโดยทั่วไป ไม่ใช่วิธีจำกัดการรับส่งข้อมูลให้อยู่ในจำนวนคำขอที่เฉพาะเจาะจง API และแบ็กเอนด์ของคุณสามารถจัดการการรับส่งข้อมูลได้ในระดับหนึ่ง และนโยบายการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วจะช่วยให้การรับส่งข้อมูลเป็นไปอย่างราบรื่นในระดับที่คุณต้องการ

ลักษณะการทำงานของการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วในรันไทม์จะแตกต่างจากสิ่งที่คุณคาดว่าจะเห็นจากค่า ต่อนาทีหรือต่อวินาทีที่คุณป้อน

ตัวอย่างเช่น สมมติว่าคุณระบุอัตรา 30 คำขอต่อนาที ดังนี้

spikearrest:
   timeUnit: minute
   allow: 30

ในการทดสอบ คุณอาจคิดว่าคุณสามารถส่งคำขอ 30 รายการใน 1 วินาทีได้ ตราบใดที่คำขอเหล่านั้นอยู่ในช่วง 1 นาที แต่ไม่ใช่ลักษณะที่นโยบายบังคับใช้การตั้งค่า ลองพิจารณาดูว่าคำขอ 30 รายการภายในระยะเวลา 1 วินาทีอาจถือเป็นการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วในสภาพแวดล้อมบางอย่าง

แล้วเกิดอะไรขึ้น เพื่อป้องกันลักษณะการทำงานที่คล้ายกับช่วงที่เพิ่มขึ้น การป้องกันช่วงที่เพิ่มขึ้นจะทำให้การรับส่งข้อมูลที่อนุญาต เป็นไปอย่างราบรื่นโดยแบ่งการตั้งค่าออกเป็นช่วงเวลาที่เล็กลง ดังนี้

อัตราต่อนาที

อัตราต่อนาทีจะถูกทำให้ราบรื่นเป็นช่วงเวลาที่อนุญาตคำขอเป็นวินาที ตัวอย่างเช่น คำขอ 30 รายการต่อนาทีจะถูกทำให้ราบรื่นดังนี้

60 วินาที (1 นาที) / 30 = ช่วงเวลา 2 วินาที หรืออนุญาตคำขอประมาณ 1 รายการทุกๆ 2 วินาที คำขอที่ 2 ภายใน 2 วินาทีจะล้มเหลว นอกจากนี้ คำขอที่ 31 ภายใน 1 นาทีจะล้มเหลว

อัตราต่อวินาที

อัตราต่อวินาทีจะถูกทำให้ราบรื่นเป็นช่วงเวลาที่อนุญาตคำขอเป็นมิลลิวินาที ตัวอย่างเช่น คำขอ 10 รายการ/วินาทีจะถูกทำให้ราบรื่นดังนี้

1, 000 มิลลิวินาที (1 วินาที) / 10 = ช่วงเวลา 100 มิลลิวินาที หรืออนุญาตคำขอประมาณ 1 รายการ ทุกๆ 100 มิลลิวินาที คำขอที่ 2 ภายใน 100 มิลลิวินาทีจะล้มเหลว นอกจากนี้ คำขอที่ 11 ภายใน 1 วินาทีจะล้มเหลว

เมื่อเกินขีดจำกัด

หากจำนวนคำขอเกินขีดจำกัดภายในช่วงเวลาที่ระบุ การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็ว จะแสดงข้อความแสดงข้อผิดพลาดนี้พร้อมสถานะ HTTP 503

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

การเพิ่มบัฟเฟอร์

คุณมีตัวเลือกในการเพิ่มบัฟเฟอร์ลงในนโยบาย สมมติว่าคุณตั้งค่าบัฟเฟอร์เป็น 10 คุณจะเห็นว่า API ไม่แสดงข้อผิดพลาดทันทีเมื่อคุณเกินขีดจำกัดการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็ว แต่ระบบจะบัฟเฟอร์คำขอ (สูงสุดตามจำนวนที่ระบุ) และประมวลผลคำขอที่บัฟเฟอร์ไว้ทันทีที่หน้าต่างการดำเนินการที่เหมาะสมถัดไปพร้อมใช้งาน ค่าเริ่มต้น bufferSize คือ 0

หากคุณเรียกใช้กระบวนการ Edge Micro หลายรายการ

จำนวนคำขอที่อนุญาตจะขึ้นอยู่กับจำนวนกระบวนการ Worker ของ Edge Micro ที่กำลังทำงานอยู่ การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วจะคำนวณจำนวนคำขอที่อนุญาตต่อกระบวนการ Worker โดยค่าเริ่มต้น จำนวนกระบวนการ Edge Micro จะเท่ากับจำนวน CPU ในเครื่องที่ติดตั้ง Edge Micro อย่างไรก็ตาม คุณสามารถกำหนดค่าจำนวนกระบวนการ Worker ได้เมื่อเริ่ม Edge Micro โดยใช้ตัวเลือก --processes ในคำสั่ง start ตัวอย่างเช่น หากต้องการให้การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วเริ่มทำงานที่คำขอ 100 รายการในช่วงเวลาที่กำหนด และหากคุณเริ่ม Edge Microgateway ด้วยตัวเลือก --processes 4 ให้ตั้งค่า allow: 25 ในการกำหนดค่าการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็ว โดยสรุป กฎง่ายๆ คือให้ตั้งค่าพารามิเตอร์การกำหนดค่า allow config เป็นค่า "จำนวนการป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วที่ต้องการ / จำนวนกระบวนการ"

การใช้ปลั๊กอินโควต้า

โควต้าจะระบุจำนวนข้อความคำขอที่แอปได้รับอนุญาตให้ส่งไปยัง API ในช่วงเวลา 1 ชั่วโมง 1 วัน 1 สัปดาห์ หรือ 1 เดือน เมื่อแอปถึงขีดจำกัดโควต้า ระบบจะปฏิเสธการเรียก API ครั้งต่อๆ ไป ดูเพิ่มเติมที่การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วและโควต้าแตกต่างกันอย่างไร

การเพิ่มปลั๊กอินโควต้า

ดูหัวข้อ การเพิ่มและการกำหนดค่าปลั๊กอิน

การกำหนดค่าผลิตภัณฑ์ใน Apigee Edge

คุณกำหนดค่าโควต้าใน UI ของ Apigee Edge ซึ่งเป็นที่ที่คุณกำหนดค่าผลิตภัณฑ์ API คุณต้องทราบ ว่าผลิตภัณฑ์ใดมีพร็อกซีที่รับรู้ถึง Microgateway ซึ่งคุณต้องการจำกัดด้วยโควต้า คุณต้องเพิ่มผลิตภัณฑ์นี้ลงในแอปของนักพัฒนาแอป เมื่อคุณเรียก API ที่มีการตรวจสอบสิทธิ์โดยใช้ คีย์ในแอปของนักพัฒนาแอป ระบบจะใช้โควต้ากับการเรียก API เหล่านั้น

1. เข้าสู่ระบบบัญชีขององค์กร Apigee Edge
2. ใน UI ของ Edge ให้เปิดผลิตภัณฑ์ที่เชื่อมโยงกับพร็อกซีที่รับรู้ถึง Microgateway ซึ่ง คุณต้องการใช้โควต้า
   1. ใน UI ให้เลือกผลิตภัณฑ์ จากเมนู "เผยแพร่"
   2. เปิดผลิตภัณฑ์ที่มี API ซึ่งคุณต้องการใช้โควต้า
   3. คลิกแก้ไข
   4. ในช่อง "โควต้า" ให้ระบุช่วงเวลาโควต้า เช่น คำขอ 100 รายการทุกๆ 1 นาที หรือคำขอ 50,000 รายการทุกๆ 2 ชั่วโมง
      
      

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 ในช่วงเวลา 1 ชั่วโมง 1 วัน 1 สัปดาห์ หรือ 1 เดือน นโยบายโควต้าจะบังคับใช้ขีดจำกัดการใช้แอปไคลเอ็นต์โดย การรักษาตัวนับแบบกระจายที่นับคำขอขาเข้า

ใช้นโยบายโควต้าเพื่อบังคับใช้สัญญาทางธุรกิจหรือ SLA กับนักพัฒนาแอปและพาร์ทเนอร์ ไม่ใช่เพื่อการจัดการการรับส่งข้อมูลในการดำเนินงาน ตัวอย่างเช่น คุณอาจใช้โควต้าเพื่อจำกัดการรับส่งข้อมูลสำหรับ บริการฟรี ขณะเดียวกันก็อนุญาตให้ลูกค้าที่ชำระเงินเข้าถึงได้อย่างเต็มที่

ใช้การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วเพื่อป้องกันการรับส่งข้อมูล API ที่เพิ่มขึ้นอย่างฉับพลัน โดยปกติแล้ว การป้องกันการรับส่งข้อมูลที่เพิ่มขึ้นอย่างรวดเร็วจะ ใช้เพื่อป้องกันการโจมตีแบบ DDoS หรือการโจมตีที่เป็นอันตรายอื่นๆ ที่อาจเกิดขึ้น