การอ้างอิงการดำเนินการและการกำหนดค่าสำหรับ Edge Microgateway

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

Edge Microgateway v. 2.4.x

ภาพรวม

หัวข้อนี้จะอธิบายวิธีจัดการและกำหนดค่า Edge Microgateway รวมถึงการตรวจสอบ การบันทึก และการแก้ไขข้อบกพร่อง

ทำการเปลี่ยนแปลงการกำหนดค่า

ไฟล์การกำหนดค่าที่คุณต้องทราบมีดังนี้

• ไฟล์การกำหนดค่าเริ่มต้นของระบบ
• ไฟล์การกำหนดค่าเริ่มต้นสำหรับอินสแตนซ์ Edge Microgateway ที่เพิ่งเริ่มต้น
• ไฟล์การกำหนดค่าแบบไดนามิกสำหรับอินสแตนซ์ที่ทำงานอยู่

ส่วนนี้จะอธิบายไฟล์เหล่านี้และสิ่งที่คุณจำเป็นต้องทราบเกี่ยวกับการเปลี่ยนแปลงไฟล์ โปรดดูรายละเอียด เกี่ยวกับการตั้งค่าไฟล์การกำหนดค่าที่ข้อมูลอ้างอิงการกำหนดค่า Edge Microgateway

ไฟล์การกำหนดค่าเริ่มต้นของระบบ

เมื่อติดตั้ง Edge Microgateway ระบบจะวางไฟล์การกำหนดค่าเริ่มต้นของระบบไว้ที่ตำแหน่งต่อไปนี้

[prefix]/lib/node_modules/edgemicro/config/default.yaml

โดยที่ [prefix] คือไดเรกทอรีคำนำหน้า npm ดูตำแหน่ง ที่ติดตั้ง Edge Microgateway

หากเปลี่ยนไฟล์การกำหนดค่าระบบ คุณต้องเริ่มต้นใหม่ กำหนดค่าใหม่ และรีสตาร์ท Edge Microgateway โดยทำดังนี้

1. โทรหา edgemicro init
2. โทรหา edgemicro configure [params]
3. โทรหา edgemicro start [params]

ไฟล์การกำหนดค่าเริ่มต้นสำหรับอินสแตนซ์ Edge Microgateway ที่เริ่มต้นใหม่

เมื่อเรียกใช้ edgemicro init ระบบจะวางไฟล์การกำหนดค่าระบบ (อธิบายไว้ข้างต้น) default.yaml ไว้ในไดเรกทอรีนี้ ~/.edgemicro

หากเปลี่ยนไฟล์การกำหนดค่าใน ~/.edgemicro คุณต้องกำหนดค่าใหม่และรีสตาร์ท Edge Microgateway โดยทำดังนี้

1. edgemicro stop
2. edgemicro configure [params]
3. edgemicro start [params]

ไฟล์การกำหนดค่าแบบไดนามิก สำหรับอินสแตนซ์ที่ทำงานอยู่

เมื่อเรียกใช้ edgemicro configure [params] ระบบจะสร้างไฟล์การกำหนดค่าแบบไดนามิกใน ~/.edgemicro โดยไฟล์จะมีชื่อตามรูปแบบ [org]-[env]-config.yaml ซึ่ง org และ env คือชื่อองค์กรและสภาพแวดล้อม Apigee Edge ของคุณ คุณสามารถใช้ไฟล์นี้เพื่อทำการเปลี่ยนแปลงการกำหนดค่า แล้วโหลดซ้ำ โดยไม่มีการหยุดทำงาน ตัวอย่างเช่น หากเพิ่มและกำหนดค่าปลั๊กอิน คุณจะโหลดการกำหนดค่าซ้ำได้โดยไม่ต้องหยุดทำงานตามที่อธิบายไว้ด้านล่าง

หาก Edge Microgateway ทำงานอยู่ (ตัวเลือกแบบไม่มีการหยุดทำงาน) ให้ทำดังนี้

1. โหลดการกำหนดค่า Edge Microgateway ซ้ำ

   edgemicro reload -o [org] -e [env] -k [key] -s [secret]

   สถานที่:

   • org คือชื่อองค์กร Edge ของคุณ (คุณต้องเป็นผู้ดูแลระบบองค์กร)
   • env คือสภาพแวดล้อมในองค์กร (เช่น การทดสอบหรือ การใช้งานจริง)
   • key คือคีย์ที่คำสั่ง configure ส่งคืนก่อนหน้านี้
   • secret คือคีย์ที่คำสั่ง configure ส่งคืนก่อนหน้านี้

   ตัวอย่าง

   edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

หากหยุด Edge Microgateway

1. รีสตาร์ท Edge Microgateway

   edgemicro start -o [org] -e [env] -k [key] -s [secret]

   สถานที่:

   • org คือชื่อองค์กร Edge ของคุณ (คุณต้องเป็นผู้ดูแลระบบองค์กร)
   • env คือสภาพแวดล้อมในองค์กร (เช่น การทดสอบหรือ การใช้งานจริง)
   • key คือคีย์ที่คำสั่ง configure ส่งคืนก่อนหน้านี้
   • secret คือคีย์ที่คำสั่ง configure ส่งคืนก่อนหน้านี้

   ตัวอย่าง

   edgemicro start -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

ตัวอย่างไฟล์การกำหนดค่ามีดังนี้ ดูรายละเอียดเกี่ยวกับการตั้งค่าไฟล์การกำหนดค่าได้ที่ข้อมูลอ้างอิงการกำหนดค่า Edge Microgateway

edge_config:
  bootstrap: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test
  jwt_public_key: 'https://docs-test.apigee.net/edgemicro-auth/publicKey'
  managementUri: 'https://api.enterprise.apigee.com'
  vaultName: microgateway
  authUri: 'https://%s-%s.apigee.net/edgemicro-auth'
  baseUri: >-
    https://edgemicroservices.apigee.net/edgemicro/%s/organization/%s/environment/%s
  bootstrapMessage: Please copy the following property to the edge micro agent config
  keySecretMessage: The following credentials are required to start edge micro
  products: 'https://docs-test.apigee.net/edgemicro-auth/products'
edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
headers:
  x-forwarded-for: true
  x-forwarded-host: true
  x-request-id: true
  x-response-time: true
  via: true
oauth:
  allowNoAuthorization: false
  allowInvalidAuthorization: false
  verify_api_key_url: 'https://docs-test.apigee.net/edgemicro-auth/verifyApiKey'
analytics:
  uri: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/axpublisher/organization/docs/environment/test

การตั้งค่าตัวแปรสภาพแวดล้อม

คำสั่งอินเทอร์เฟซบรรทัดคำสั่งที่ต้องใช้ค่าสำหรับองค์กรและสภาพแวดล้อม Edge รวมถึงคีย์และข้อมูลลับที่จำเป็นสำหรับการเริ่มต้น Edge Microgateway สามารถจัดเก็บไว้ในตัวแปรสภาพแวดล้อมต่อไปนี้ได้

• EDGEMICRO_ORG
• EDGEMICRO_ENV
• EDGEMICRO_KEY
• EDGEMICRO_SECRET

คุณจะตั้งค่าตัวแปรเหล่านี้หรือไม่ก็ได้ หากตั้งค่าไว้ คุณไม่จำเป็นต้องระบุค่า เมื่อใช้อินเทอร์เฟซบรรทัดคำสั่ง (CLI) เพื่อกำหนดค่าและเริ่ม Edge Microgateway

การกำหนดค่า SSL ในเซิร์ฟเวอร์ Edge Microgateway

คุณกำหนดค่าเซิร์ฟเวอร์ Microgateway ให้ใช้ SSL ได้ เช่น เมื่อกำหนดค่า SSL แล้ว คุณจะ เรียกใช้ API ผ่าน Edge Microgateway ด้วยโปรโตคอล "https" ได้ดังนี้

https://localhost:8000/myapi

หากต้องการกำหนดค่า SSL ในเซิร์ฟเวอร์ Microgateway ให้ทำตามขั้นตอนต่อไปนี้

1. สร้างหรือขอรับใบรับรองและคีย์ SSL โดยใช้ยูทิลิตี openssl หรือวิธีที่คุณต้องการ
2. เพิ่มแอตทริบิวต์ edgemicro:ssl ลงในไฟล์การกำหนดค่า Edge Microgateway ดูรายการตัวเลือกทั้งหมดได้ในตารางด้านล่าง โปรดดูรายละเอียดเกี่ยวกับการ แก้ไขการกำหนดค่า Edge Microgateway ที่หัวข้อทำการเปลี่ยนแปลงการกำหนดค่า เช่น
   

    edgemicro:
        ssl:
            key: <absolute path to the SSL key file>
            cert: <absolute path to the SSL cert file>
            passphrase: admin123 #option added in v2.2.2
            rejectUnauthorized: true #option added in v2.2.2
            requestCert: true 

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

ต่อไปนี้คือตัวอย่างส่วน edgemicro ของไฟล์การกำหนดค่าที่มีการกำหนดค่า SSL

edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
  ssl:
    key: /MyHome/SSL/em-ssl-keys/server.key
    cert: /MyHome/SSL/em-ssl-keys/server.crt
    passphrase: admin123 #option added in v2.2.2
    rejectUnauthorized: true #option added in v2.2.2

รายการตัวเลือกเซิร์ฟเวอร์ทั้งหมดที่รองรับมีดังนี้

การใช้ตัวเลือก SSL/TLS ของไคลเอ็นต์

คุณกำหนดค่า Edge Microgateway ให้เป็นไคลเอ็นต์ TLS หรือ SSL ได้เมื่อเชื่อมต่อกับปลายทางเป้าหมาย ในไฟล์การกำหนดค่า Microgateway ให้ใช้องค์ประกอบ targets เพื่อตั้งค่า SSL/TLS

ตัวอย่างนี้แสดงการตั้งค่าที่จะมีผลกับโฮสต์ทั้งหมด

targets:
   ssl:
     client:
       key: /Users/jdoe/nodecellar/twowayssl/ssl/client.key
       cert: /Users/jdoe/nodecellar/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

ในตัวอย่างนี้ การตั้งค่าจะมีผลกับโฮสต์ที่ระบุเท่านั้น

targets:
   host: 'myserver.example.com'
   ssl:
     client:
       key: /Users/myname/twowayssl/ssl/client.key
       cert: /Users/myname/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

ตัวอย่างสำหรับ TLS

targets:
   host: 'myserver.example.com'
   tls:
     client:
       pfx: /Users/myname/twowayssl/ssl/client.pfx
       passphrase: admin123
       rejectUnauthorized: true

รายการตัวเลือกไคลเอ็นต์ทั้งหมดที่รองรับมีดังนี้

การปรับแต่งพร็อกซี edgemicro-auth

โดยค่าเริ่มต้น Edge Microgateway จะใช้พร็อกซีที่ติดตั้งใช้งานใน Apigee Edge สำหรับการตรวจสอบสิทธิ์ OAuth2 ระบบจะติดตั้งใช้งานพร็อกซีนี้เมื่อคุณเรียกใช้ edgemicro configure เป็นครั้งแรก คุณสามารถ เปลี่ยนการกำหนดค่าเริ่มต้นของพร็อกซีนี้เพื่อเพิ่มการรองรับการอ้างสิทธิ์ที่กำหนดเองลงใน JSON Web Token (JWT), กำหนดค่าการหมดอายุของโทเค็น และสร้างโทเค็นการรีเฟรช โปรดดูรายละเอียดที่หน้า edgemicro-auth ใน GitHub

การใช้บริการการตรวจสอบสิทธิ์ที่กำหนดเอง

โดยค่าเริ่มต้น Edge Microgateway จะใช้พร็อกซีที่ติดตั้งใช้งานใน Apigee Edge สำหรับการตรวจสอบสิทธิ์ OAuth2 ระบบจะติดตั้งใช้งานพร็อกซีนี้เมื่อคุณเรียกใช้ edgemicro configure เป็นครั้งแรก โดยค่าเริ่มต้น URL ของพร็อกซีนี้จะระบุไว้ในไฟล์การกำหนดค่า Edge Microgateway ดังนี้

authUri: https://myorg-myenv.apigee.net/edgemicro-auth

หากต้องการใช้บริการที่กำหนดเองเพื่อจัดการการตรวจสอบสิทธิ์ ให้เปลี่ยนค่า authUri ในไฟล์กำหนดค่าเพื่อชี้ไปยังบริการของคุณ เช่น คุณอาจมีบริการที่ใช้ LDAP เพื่อยืนยันตัวตน

การจัดการ ไฟล์บันทึก

Edge Microgateway จะบันทึกข้อมูลเกี่ยวกับคำขอและการตอบกลับแต่ละรายการ ไฟล์บันทึกให้ข้อมูลที่เป็นประโยชน์ สำหรับการแก้ไขข้อบกพร่องและการแก้ปัญหา

ตำแหน่งที่จัดเก็บไฟล์บันทึก

โดยค่าเริ่มต้น ระบบจะจัดเก็บไฟล์บันทึกไว้ใน /var/tmp

วิธีเปลี่ยนไดเรกทอรีไฟล์บันทึกเริ่มต้น

ไดเรกทอรีที่จัดเก็บไฟล์บันทึกจะระบุไว้ในไฟล์การกำหนดค่า Edge Microgateway โปรดดูรายละเอียดเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่าที่หัวข้อทำการเปลี่ยนแปลงการกำหนดค่า

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

เปลี่ยนค่า dir เพื่อระบุไดเรกทอรีไฟล์บันทึกอื่น

ส่งบันทึกไปยังคอนโซล

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

edgemicro:
  logging:
    to_console: true  

การตั้งค่านี้จะส่งบันทึกไปยังเอาต์พุตมาตรฐาน ปัจจุบันคุณไม่สามารถส่งบันทึกไปยังทั้ง stdout และไฟล์บันทึกได้

วิธีตั้งค่าระดับการบันทึก

คุณตั้งค่าระดับบันทึกได้ดังนี้ info, warn และ error แนะนำให้ใช้ระดับ INFO โดยจะบันทึกคำขอและการตอบกลับของ API ทั้งหมด และเป็นค่าเริ่มต้น

วิธีเปลี่ยนช่วงเวลาของบันทึกการเปลี่ยนแปลง

คุณกำหนดค่าช่วงเวลาเหล่านี้ได้ในไฟล์การกำหนดค่า Edge Microgateway โปรดดูรายละเอียดเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่าที่หัวข้อการเปลี่ยนแปลงการกำหนดค่า

แอตทริบิวต์ที่กำหนดค่าได้มีดังนี้

• stats_log_interval: (ค่าเริ่มต้น: 60) ช่วงเวลาเป็นวินาทีเมื่อระบบเขียนบันทึกสถิติ ลงในไฟล์บันทึก API
• rotate_interval: (ค่าเริ่มต้น: 24) ช่วงเวลาเป็นชั่วโมงเมื่อระบบหมุนเวียนไฟล์บันทึก เช่น

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

หมายเหตุ: ระบบจะไม่บีบอัดไฟล์บันทึกที่เก็บถาวร เมื่อช่วงเวลาเริ่มต้น ระบบจะสร้างไฟล์บันทึกใหม่พร้อมการประทับเวลาใหม่

แนวทางปฏิบัติที่ดีในการบำรุงรักษาไฟล์บันทึก

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

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

แบบแผนการตั้งชื่อไฟล์บันทึก

อินสแตนซ์ Edge Microgateway แต่ละรายการจะสร้างไฟล์บันทึก 3 ประเภท ได้แก่

• api - บันทึกคำขอและการตอบกลับทั้งหมดที่ไหลผ่าน Edge Microgateway ระบบจะบันทึกตัวนับ API (สถิติ) และข้อผิดพลาดลงในไฟล์นี้ด้วย
• err - บันทึกทุกอย่างที่ส่งไปยัง stderr
• out - บันทึกทุกอย่างที่ส่งไปยัง stdout

รูปแบบการตั้งชื่อมีดังนี้

edgemicro-<Host Name>-<Instance ID>-<Log Type>.log

เช่น

edgemicro-mymachine-local-MTQzNTgNDMxODAyMQ-api.log
edgemicro-mymachine-local-MTQzNTg1NDMODAyMQ-err.log
edgemicro-mymachine-local-mtqzntgndmxodaymq-out.log

เกี่ยวกับเนื้อหาไฟล์บันทึก

เพิ่มใน: v2.3.3

โดยค่าเริ่มต้น บริการบันทึกจะละเว้น JSON ของพร็อกซี ผลิตภัณฑ์ และโทเค็นเว็บ JSON (JWT) ที่ดาวน์โหลด หากต้องการส่งออกออบเจ็กต์เหล่านี้ไปยังไฟล์บันทึก ให้ตั้งค่า DEBUG=* เมื่อเริ่มต้น Edge Microgateway เช่น

DEBUG=* edgemicro start -o docs -e test -k abc123 -s xyz456

หมายเหตุ: ใน Windows ให้ใช้ SET DEBUG=*

เนื้อหาของไฟล์บันทึก "api"

ไฟล์บันทึก "api" มีข้อมูลโดยละเอียดเกี่ยวกับลำดับการทำงานของคำขอและการตอบกลับ ผ่าน Edge Microgateway ไฟล์บันทึก "api" จะมีชื่อดังนี้

edgemicro-mymachine-local-MTQzNjIxOTk0NzY0Nw-api.log

สำหรับคำขอแต่ละรายการที่ส่งไปยัง Edge Microgateway ระบบจะบันทึกเหตุการณ์ 4 รายการในไฟล์บันทึก "api"

• คำขอขาเข้าจากไคลเอ็นต์
• ส่งคำขอขาออกไปยังเป้าหมาย
• การตอบกลับขาเข้าจากเป้าหมาย
• การตอบกลับขาออกไปยังไคลเอ็นต์

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

(1) 1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
(2) 1436403888665 info treq m=GET, u=/, h=127.0.0.18080, i=0
(3) 1436403888672 info tres s=200, d=7, i=0
(4) 1436403888676 info res s=200, d=11, i=0

มาดูทีละรายการกัน

1. ตัวอย่างคำขอที่เข้ามาจากไคลเอ็นต์

1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0

• 1436403888651 - การประทับวันที่ Unix
• info - ขึ้นอยู่กับบริบท อาจเป็น info, warn หรือ error ขึ้นอยู่กับระดับบันทึก อาจเป็นสถิติสำหรับบันทึกสถิติ คำเตือนสำหรับคำเตือน หรือ ข้อผิดพลาดสำหรับข้อผิดพลาด
• req - ระบุเหตุการณ์ ในกรณีนี้ ให้ส่งคำขอจาก ไคลเอ็นต์
• m - กริยา HTTP ที่ใช้ในคำขอ
• u - ส่วนของ URL ที่อยู่หลัง basepath
• h - หมายเลขโฮสต์และพอร์ตที่ Edge Microgateway กำลังฟังอยู่
• r - โฮสต์และพอร์ตระยะไกลที่คำขอของไคลเอ็นต์ เริ่มต้น
• i - รหัสคำขอ รายการกิจกรรมทั้ง 4 รายการจะใช้รหัสนี้ร่วมกัน ระบบจะกำหนดรหัสคำขอที่ไม่ซ้ำกันให้กับคำขอแต่ละรายการ การเชื่อมโยงบันทึกของบันทึกตามรหัสคำขอจะให้ข้อมูลเชิงลึกที่มีคุณค่าเกี่ยวกับเวลาในการตอบสนองของเป้าหมาย
• d - ระยะเวลาเป็นมิลลิวินาทีตั้งแต่ Edge Microgateway ได้รับคำขอ ในตัวอย่างข้างต้น ระบบได้รับการตอบกลับของเป้าหมายสำหรับคำขอ 0 หลังจากผ่านไป 7 มิลลิวินาที (บรรทัดที่ 3) และส่งการตอบกลับไปยังไคลเอ็นต์หลังจากผ่านไปอีก 4 มิลลิวินาที (บรรทัดที่ 4) กล่าวคือ เวลาในการตอบสนองของคำขอทั้งหมดคือ 11 มิลลิวินาที ซึ่ง เป้าหมายใช้เวลา 7 มิลลิวินาที และ Edge Microgateway ใช้เวลา 4 มิลลิวินาที

2. ตัวอย่างคำขอขาออกที่ส่งไปยังเป้าหมาย

1436403888665 info treq m=GET, u=/, h=127.0.0.1:8080, i=0

• 1436403888651 - การประทับวันที่ Unix
• info - ขึ้นอยู่กับบริบท อาจเป็น info, warn หรือ error ขึ้นอยู่กับระดับบันทึก อาจเป็นสถิติสำหรับบันทึกสถิติ คำเตือนสำหรับคำเตือน หรือ ข้อผิดพลาดสำหรับข้อผิดพลาด
• treq - ระบุเหตุการณ์ ในกรณีนี้ ให้กำหนดคำขอเป้าหมาย
• m - กริยา HTTP ที่ใช้ในคำขอเป้าหมาย
• u - ส่วนของ URL ที่อยู่หลัง basepath
• h - หมายเลขโฮสต์และพอร์ตของเป้าหมายแบ็กเอนด์
• i - รหัสของรายการบันทึก รายการเหตุการณ์ทั้ง 4 รายการจะใช้รหัสนี้ร่วมกัน

3. ตัวอย่างการตอบกลับที่เข้ามาจากเป้าหมาย

1436403888672 info tres s=200, d=7, i=0

1436403888651 - การประทับวันที่ Unix

• info - ขึ้นอยู่กับบริบท อาจเป็น info, warn หรือ error ขึ้นอยู่กับระดับบันทึก อาจเป็นสถิติสำหรับบันทึกสถิติ คำเตือนสำหรับคำเตือน หรือ ข้อผิดพลาดสำหรับข้อผิดพลาด
• tres - ระบุเหตุการณ์ ในกรณีนี้ ให้กำหนดเป้าหมายการตอบกลับ
• s - สถานะการตอบกลับ HTTP
• d - ระยะเวลาเป็นมิลลิวินาที ระยะเวลาที่ใช้ในการเรียก API โดย เป้าหมาย
• i - รหัสของรายการบันทึก รายการเหตุการณ์ทั้ง 4 รายการจะใช้รหัสนี้ร่วมกัน

4. ตัวอย่างการตอบกลับขาออกไปยังไคลเอ็นต์

1436403888676 info res s=200, d=11, i=0

1436403888651 - การประทับวันที่ Unix

• info - ขึ้นอยู่กับบริบท อาจเป็น info, warn หรือ error ขึ้นอยู่กับระดับบันทึก อาจเป็นสถิติสำหรับบันทึกสถิติ คำเตือนสำหรับคำเตือน หรือ ข้อผิดพลาดสำหรับข้อผิดพลาด
• res - ระบุเหตุการณ์ ในกรณีนี้ การตอบกลับ ไคลเอ็นต์
• s - สถานะการตอบกลับ HTTP
• d - ระยะเวลาเป็นมิลลิวินาที เวลาทั้งหมดที่ใช้ โดยการเรียก API รวมถึงเวลาที่ใช้โดย API เป้าหมายและเวลาที่ใช้โดย Edge Microgateway เอง
• i - รหัสของรายการบันทึก รายการเหตุการณ์ทั้ง 4 รายการจะใช้รหัสนี้ร่วมกัน

กำหนดเวลาไฟล์บันทึก

ระบบจะหมุนเวียนไฟล์บันทึกตามช่วงเวลาที่ระบุโดย rotate_interval แอตทริบิวต์การกำหนดค่า ระบบจะเพิ่มรายการไปยังไฟล์บันทึกเดียวกันต่อไปจนกว่าช่วงเวลาการหมุนเวียนจะหมดอายุ อย่างไรก็ตาม ทุกครั้งที่รีสตาร์ท Edge Microgateway ระบบจะกำหนด UID ใหม่และสร้าง ชุดไฟล์บันทึกใหม่ที่มี UID นี้ ดูแนวทางปฏิบัติที่ดีในการบำรุงรักษาไฟล์บันทึกด้วย

ข้อมูลอ้างอิงการกำหนดค่า Edge Microgateway

ตำแหน่งของไฟล์การกำหนดค่า

แอตทริบิวต์การกำหนดค่าที่อธิบายไว้ในส่วนนี้อยู่ในไฟล์การกำหนดค่า Edge Microgateway โปรดดูรายละเอียดเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่าที่หัวข้อทำการเปลี่ยนแปลงการกำหนดค่า

แอตทริบิวต์ edge_config

การตั้งค่าเหล่านี้ใช้เพื่อกำหนดค่าการโต้ตอบระหว่างอินสแตนซ์ Edge Microgateway กับ Apigee Edge

• bootstrap: (ค่าเริ่มต้น: ไม่มี) URL ที่ชี้ไปยังบริการเฉพาะของ Edge Microgateway ที่ทำงานใน Apigee Edge Edge Microgateway ใช้บริการนี้เพื่อ สื่อสารกับ Apigee Edge ระบบจะแสดง URL นี้เมื่อคุณเรียกใช้คำสั่งเพื่อสร้างคู่คีย์สาธารณะ/ส่วนตัว: edgemicro genkeys ดูรายละเอียดได้ที่การตั้งค่า และการกำหนดค่า Edge Microgateway
• jwt_public_key: (ค่าเริ่มต้น: ไม่มี) URL ที่ชี้ไปยังพร็อกซี Edge Microgateway ที่ติดตั้งใช้งานใน Apigee Edge พร็อกซีนี้ทำหน้าที่เป็นปลายทางการตรวจสอบสิทธิ์สำหรับ การออกโทเค็นเพื่อการเข้าถึงที่ลงชื่อแล้วให้กับไคลเอ็นต์ ระบบจะแสดง URL นี้เมื่อคุณเรียกใช้คำสั่งเพื่อ ติดตั้งใช้งานพร็อกซี: edgemicro configure ดูรายละเอียดได้ที่การตั้งค่า และการกำหนดค่า Edge Microgateway

แอตทริบิวต์ edgemicro

การตั้งค่าเหล่านี้จะกำหนดค่ากระบวนการ Edge Microgateway

• port: (ค่าเริ่มต้น: 8000) หมายเลขพอร์ตที่กระบวนการ Edge Microgateway รอรับฟัง
• max_connections: (ค่าเริ่มต้น: -1) ระบุจำนวนสูงสุดของ การเชื่อมต่อขาเข้าพร้อมกันที่ Edge Microgateway รับได้ หากจำนวนนี้ เกิน ระบบจะแสดงสถานะต่อไปนี้
  
  res.statusCode = 429; // Too many requests
  
• max_connections_hard: (ค่าเริ่มต้น: -1) จำนวนคำขอพร้อมกันสูงสุดที่ Edge Microgateway รับได้ก่อนที่จะปิดการเชื่อมต่อ การตั้งค่านี้ มีไว้เพื่อป้องกันการโจมตีแบบปฏิเสธการให้บริการ โดยปกติแล้ว ให้ตั้งค่าเป็นตัวเลขที่มากกว่า max_connections
• การบันทึก
  • level: (ค่าเริ่มต้น: error)
    • info - บันทึกคำขอและการตอบกลับทั้งหมดที่ไหลผ่านอินสแตนซ์ Edge Microgateway
    • warn - บันทึกเฉพาะข้อความเตือน
    • ข้อผิดพลาด - บันทึกเฉพาะข้อความแสดงข้อผิดพลาด
  • dir: (ค่าเริ่มต้น: /var/tmp) ไดเรกทอรีที่จัดเก็บไฟล์บันทึก
  • stats_log_interval: (ค่าเริ่มต้น: 60) ช่วงเวลาเป็นวินาทีเมื่อระบบเขียนบันทึกสถิติ ลงในไฟล์บันทึก API
  • rotate_interval: (ค่าเริ่มต้น: 24) ช่วงเวลาเป็นชั่วโมงเมื่อมีการหมุนเวียนไฟล์บันทึก

• ปลั๊กอิน: ปลั๊กอินจะเพิ่มฟังก์ชันการทำงานให้กับ Edge Microgateway ดูรายละเอียด เกี่ยวกับการพัฒนาปลั๊กอินได้ที่การพัฒนาปลั๊กอิน ที่กำหนดเอง

• dir: เส้นทางแบบสัมพัทธ์จากไดเรกทอรี ./gateway ไปยัง ไดเรกทอรี ./plugins หรือเส้นทางแบบสัมบูรณ์
• ลำดับ: รายการโมดูลปลั๊กอินที่จะเพิ่มลงในอินสแตนซ์ Edge Microgateway โมดูลจะทำงานตามลำดับที่ระบุไว้ที่นี่

• debug: เพิ่มการแก้ไขข้อบกพร่องจากระยะไกลลงในกระบวนการ Edge Microgateway
  • port: หมายเลขพอร์ตที่จะใช้รับฟัง เช่น ตั้งค่าดีบักเกอร์ IDE ให้รับฟังในพอร์ตนี้
  • args: อาร์กิวเมนต์ของกระบวนการแก้ไขข้อบกพร่อง เช่น args --nolazy
    
• config_change_poll_interval: (ค่าเริ่มต้น: 600 วินาที) Edge Microgateway จะโหลดการกำหนดค่าใหม่เป็นระยะๆ และดำเนินการโหลดซ้ำหากมีการเปลี่ยนแปลง การสำรวจ จะตรวจหาการเปลี่ยนแปลงที่เกิดขึ้นใน Edge (การเปลี่ยนแปลงผลิตภัณฑ์, พร็อกซีที่รับรู้ Microgateway ฯลฯ) รวมถึง การเปลี่ยนแปลงที่เกิดขึ้นกับไฟล์กำหนดค่าในเครื่อง
  
• disable_config_poll_interval: (ค่าเริ่มต้น: false) ตั้งค่า เป็น true เพื่อปิดการสำรวจการเปลี่ยนแปลงอัตโนมัติ
• request_timeout: ตั้งค่าการหมดเวลาสำหรับคำขอเป้าหมาย ระยะหมดเวลาจะตั้งค่าเป็นวินาที หากเกิดการหมดเวลา Edge Microgateway จะตอบกลับด้วยรหัสสถานะ 504 (เพิ่มใน v2.4.x)

แอตทริบิวต์ส่วนหัว

การตั้งค่าเหล่านี้จะกำหนดวิธีจัดการส่วนหัว HTTP บางรายการ

• x-forwarded-for: (ค่าเริ่มต้น: จริง) ตั้งค่าเป็นเท็จเพื่อป้องกัน ไม่ให้ส่งต่อส่วนหัว x-forwarded-for ไปยังเป้าหมาย โปรดทราบว่าหากมีส่วนหัว x-forwarded-for ในคำขอ ระบบจะตั้งค่าเป็นค่า client-ip ใน Edge Analytics
• x-forwarded-host: (ค่าเริ่มต้น: จริง) ตั้งค่าเป็นเท็จเพื่อป้องกันไม่ให้ ส่งส่วนหัว x-forwarded-host ไปยังเป้าหมาย
• x-request-id: (ค่าเริ่มต้น: จริง) ตั้งค่าเป็นเท็จเพื่อป้องกันไม่ให้ ส่งส่วนหัว x-request-id ไปยังเป้าหมาย
• x-response-time: (ค่าเริ่มต้น: จริง) ตั้งค่าเป็นเท็จเพื่อป้องกันไม่ให้ ส่งส่วนหัว x-response-time ไปยังเป้าหมาย
• via: (ค่าเริ่มต้น: จริง) ตั้งค่าเป็นเท็จเพื่อป้องกันไม่ให้ส่งส่วนหัว via ไปยังเป้าหมาย

แอตทริบิวต์ OAuth

การตั้งค่าเหล่านี้จะกำหนดวิธีที่ Edge Microgateway บังคับใช้การตรวจสอบสิทธิ์ไคลเอ็นต์

• allowNoAuthorization: (ค่าเริ่มต้น: false) หากตั้งค่าเป็น true ระบบจะอนุญาตให้การเรียก API ผ่าน Edge Microgateway โดยไม่มีส่วนหัวการให้สิทธิ์เลย ตั้งค่าเป็น false เพื่อกำหนดให้ต้องมีส่วนหัวการให้สิทธิ์ (ค่าเริ่มต้น)
• allowInvalidAuthorization: (ค่าเริ่มต้น: false) หากตั้งค่าเป็น true ระบบจะอนุญาตให้ส่งการเรียก API หากโทเค็นที่ส่งในส่วนหัวการให้สิทธิ์ไม่ถูกต้องหรือหมดอายุ ตั้งค่านี้ เป็น "เท็จ" เพื่อกำหนดให้ต้องใช้โทเค็นที่ถูกต้อง (ค่าเริ่มต้น)
• authorization-header: (ค่าเริ่มต้น: Authorization: Bearer) ส่วนหัวที่ใช้เพื่อ ส่งโทเค็นเพื่อการเข้าถึงไปยัง Edge Microgateway คุณอาจต้องการเปลี่ยนค่าเริ่มต้นในกรณีต่อไปนี้ เป้าหมายต้องใช้ส่วนหัวการให้สิทธิ์เพื่อวัตถุประสงค์อื่น
• api-key-header: (ค่าเริ่มต้น: x-api-key) ชื่อของส่วนหัวหรือพารามิเตอร์การค้นหา ที่ใช้เพื่อส่งคีย์ API ไปยัง Edge Microgateway ดูการใช้คีย์ API ด้วย
• keepAuthHeader: (ค่าเริ่มต้น: เท็จ) หากตั้งค่าเป็นจริง ระบบจะส่งต่อส่วนหัวการให้สิทธิ์ ที่ส่งในคำขอไปยังเป้าหมาย (ระบบจะเก็บไว้)
• allowOAuthOnly -- หากตั้งค่าเป็น true ทุก API ต้องมี ส่วนหัวการให้สิทธิ์พร้อมโทเค็นเพื่อการเข้าถึงแบบ Bearer ช่วยให้คุณอนุญาตเฉพาะโมเดลความปลอดภัย OAuth (ในขณะที่ยังคงความเข้ากันได้แบบย้อนหลัง) (เพิ่มใน 4.2.x)
• allowAPIKeyOnly -- หากตั้งค่าเป็น true ทุก API ต้องมี ส่วนหัว x-api-key (หรือตำแหน่งที่กำหนดเอง) พร้อมด้วยคีย์ API ซึ่งจะช่วยให้ คุณอนุญาตเฉพาะรูปแบบความปลอดภัยของคีย์ API (ในขณะที่ยังคงความเข้ากันได้แบบย้อนหลัง) (เพิ่มใน 4.2.x)

แอตทริบิวต์เฉพาะปลั๊กอิน

ดูรายละเอียดเกี่ยวกับแอตทริบิวต์ที่กำหนดค่าได้สำหรับปลั๊กอินแต่ละรายการได้ที่การใช้ปลั๊กอิน

พร็อกซีการกรอง

คุณสามารถกรองพร็อกซีที่รับรู้ Microgateway ซึ่งอินสแตนซ์ Edge Microgateway จะประมวลผลได้ เมื่อ Edge Microgateway เริ่มทำงาน ระบบจะดาวน์โหลดพร็อกซีที่รับรู้ Microgateway ทั้งหมดในองค์กรที่เชื่อมโยงอยู่ ใช้การกำหนดค่าต่อไปนี้เพื่อจำกัดพร็อกซีที่ Microgateway จะประมวลผล ตัวอย่างเช่น การกำหนดค่านี้จะจำกัดพร็อกซีที่ Microgateway จะประมวลผลไว้ที่ 3 รายการ ได้แก่ edgemicro_proxy-1, edgemicro_proxy-2 และ edgemicro_proxy-3

proxies:
  - edgemicro_proxy-1
  - edgemicro_proxy-2
  - edgemicro_proxy-3

การมาสก์ข้อมูลวิเคราะห์

การกำหนดค่าต่อไปนี้จะป้องกันไม่ให้ข้อมูลเส้นทางคำขอแสดงในข้อมูลวิเคราะห์ของ Edge เพิ่มข้อมูลต่อไปนี้ลงในการกำหนดค่า Microgateway เพื่อมาสก์ URI ของคำขอและ/หรือเส้นทางของคำขอ โปรดทราบว่า URI ประกอบด้วยชื่อโฮสต์และส่วนเส้นทางของคำขอ

analytics:
  mask_request_uri: 'string_to_mask'
  mask_request_path: 'string_to_mask'

การตั้งค่า Edge Microgateway ที่อยู่หลังไฟร์วอลล์ของบริษัท

รองรับ v4.2.x

หากติดตั้ง Edge Microgateway ไว้หลังไฟร์วอลล์ เกตเวย์อาจสื่อสารกับ Apigee Edge ไม่ได้ ในกรณีนี้ คุณมี 2 ตัวเลือกให้พิจารณา ดังนี้

ตัวเลือก 1

ตัวเลือกแรกคือการตั้งค่าตัวเลือก edgemicro: proxy_tunnel เป็น true ใน ไฟล์การกำหนดค่า Microgateway โดยทำดังนี้

edge_config:

    proxy: http://10.224.16.85:3128
    proxy_tunnel: true

เมื่อ proxy_tunnel เป็น true, Edge Microgateway จะใช้วิธีการ CONNECT ของ HTTP เพื่อส่งคำขอ HTTP ผ่าน การเชื่อมต่อ TCP รายการเดียว (ซึ่งเป็นไปในทำนองเดียวกันหากตัวแปรสภาพแวดล้อมสำหรับการกำหนดค่าพร็อกซี เปิดใช้ TLS)

ตัวเลือก 2:

ตัวเลือกที่ 2 คือการระบุพร็อกซีและตั้งค่า proxy_tunnel เป็น false ใน ไฟล์กำหนดค่า Microgateway เช่น

edge_config:
     proxy: http://10.224.16.85:3128
     proxy_tunnel: false

ในกรณีนี้ คุณสามารถตั้งค่าตัวแปรต่อไปนี้เพื่อควบคุมโฮสต์สำหรับพร็อกซี HTTP แต่ละรายการที่ต้องการใช้ หรือโฮสต์ที่ไม่ควรจัดการพร็อกซี Edge Microgateway ได้ HTTP_PROXY, HTTPS_PROXY และ NO_PROXY

คุณตั้งค่า NO_PROXY เป็นรายการโดเมนที่คั่นด้วยคอมมาได้ ซึ่ง Edge Microgateway ไม่ควรพร็อกซี เช่น

export NO_PROXY='localhost,localhost:8080'

ตั้งค่า HTTP_PROXY และ HTTPS_PROXY เป็นปลายทางพร็อกซี HTTP เพื่อให้ Edge Microgateway ส่งข้อความไปยังปลายทางดังกล่าวได้ เช่น

export HTTP_PROXY='http://localhost:3786'

export HTTPS_PROXY='https://localhost:3786'

ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวแปรเหล่านี้ได้ที่

https://www.npmjs.com/package/request#controlling-proxy-behaviour-using-environment-variables

ดูเพิ่มเติม

วิธีตั้งค่า Edge Microgateway หลังไฟร์วอลล์ของบริษัทในชุมชน Apigee

การใช้ไวลด์การ์ดในพร็อกซีที่รับรู้ Microgateway

คุณสามารถใช้ไวลด์การ์ด "*" อย่างน้อย 1 รายการในเส้นทางฐานของพร็อกซี edgemicro_* (Microgateway-aware) ตัวอย่างเช่น เส้นทางฐาน /team/*/members ช่วยให้ไคลเอ็นต์เรียก https://[host]/team/blue/members และ https://[host]/team/green/members ได้โดยที่คุณไม่ต้องสร้างพร็อกซี API ใหม่เพื่อรองรับทีมใหม่ โปรดทราบว่าระบบไม่รองรับ /**/

สำคัญ: Apigee ไม่รองรับการใช้ไวลด์การ์ด "*" เป็น องค์ประกอบแรกของเส้นทางฐาน เช่น ระบบไม่รองรับการค้นหา /*/

การแก้ไขข้อบกพร่องและ การแก้ปัญหา

การเชื่อมต่อกับโปรแกรมแก้ไขข้อบกพร่อง

คุณเรียกใช้ Edge Microgateway ด้วยโปรแกรมแก้ไขข้อบกพร่องได้ เช่น node-inspector ซึ่งจะเป็นประโยชน์สำหรับการแก้ปัญหาและการแก้ไขข้อบกพร่องของปลั๊กอินที่กำหนดเอง

1. รีสตาร์ท Edge Microgateway ในโหมดแก้ไขข้อบกพร่อง โดยให้เพิ่ม DEBUG=* ที่จุดเริ่มต้นของคำสั่งเริ่ม ตัวอย่างเช่น
   
   DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed
   

   หมายเหตุ: ใน Windows ให้ใช้ SET DEBUG=*

2. เริ่มโปรแกรมแก้ไขข้อบกพร่องและตั้งค่าให้รับฟังหมายเลขพอร์ตสำหรับกระบวนการแก้ไขข้อบกพร่อง
3. ตอนนี้คุณสามารถดูโค้ด Edge Microgateway ทีละขั้นตอน ตั้งค่าเบรกพอยต์ ดูนิพจน์ และอื่นๆ ได้แล้ว

คุณระบุแฟล็กมาตรฐานของ Node.js ที่เกี่ยวข้องกับโหมดแก้ไขข้อบกพร่องได้ เช่น --nolazy ช่วยในการแก้ไขข้อบกพร่องของโค้ดแบบอะซิงโครนัส

การตรวจสอบไฟล์บันทึก

หากพบปัญหา โปรดตรวจสอบไฟล์บันทึกเพื่อดูรายละเอียดการดำเนินการและข้อมูลข้อผิดพลาด โปรดดูรายละเอียดที่หัวข้อการจัดการไฟล์บันทึก

การใช้ความปลอดภัยของคีย์ API

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

การแคชคีย์

ระบบจะแลกเปลี่ยนคีย์ API เป็นโทเค็น Bearer ซึ่งจะแคชไว้ คุณปิดใช้การแคชได้โดยตั้งค่า ส่วนหัว Cache-Control: no-cache ในคำขอขาเข้าที่ส่งไปยัง Edge Microgateway

การใช้ความปลอดภัยของโทเค็น OAuth2

ดูรายละเอียดเกี่ยวกับการใช้โทเค็น OAuth กับคำขอพร็อกซีได้ที่ Secure Edge Microgateway

การใช้ คีย์ API

ดูรายละเอียดเกี่ยวกับการใช้คีย์ API กับคำขอพร็อกซีได้ที่Secure Edge Microgateway

การกำหนดค่าชื่อคีย์ API

โดยค่าเริ่มต้น x-api-key คือชื่อที่ใช้สำหรับส่วนหัวคีย์ API หรือพารามิเตอร์การค้นหา คุณเปลี่ยนค่าเริ่มต้นนี้ได้ในไฟล์การกำหนดค่าตามที่อธิบายไว้ในการเปลี่ยนแปลงการกำหนดค่า ตัวอย่างเช่น หากต้องการเปลี่ยนชื่อเป็น apiKey ให้ทำดังนี้

oauth:
 allowNoAuthorization: false
 allowInvalidAuthorization: false
 api-key-header: apiKey