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

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

Edge Microgateway เวอร์ชัน 2.4.x

ภาพรวม

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 คือสภาพแวดล้อมในองค์กร (เช่น การทดสอบหรือ Prod)
   • key คือคีย์ที่การกําหนดค่าก่อนหน้านี้แสดงผล คำสั่ง
   • secret คือคีย์ที่แสดงผลก่อนหน้านี้โดย กำหนดค่าคำสั่ง

   ตัวอย่าง

   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 คือสภาพแวดล้อมในองค์กร (เช่น การทดสอบหรือ Prod)
   • key คือคีย์ที่การกําหนดค่าก่อนหน้านี้แสดงผล คำสั่ง
   • secret คือคีย์ที่แสดงผลก่อนหน้านี้โดย กำหนดค่าคำสั่ง

   ตัวอย่าง

   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

โดยจะตั้งค่าตัวแปรเหล่านี้หรือไม่ก็ได้ หากตั้งค่าไว้ คุณไม่จำเป็นต้องระบุค่า เมื่อคุณใช้ Command-Line Interface (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 ให้ใช้องค์ประกอบเป้าหมายเพื่อตั้งค่า 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

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

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

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

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 เป็น "จริง" ดังนี้

edgemicro:
  logging:
    to_console: true  

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

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

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

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

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

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

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

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

1436403888651 - การประทับเวลา Unix

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

4. ตัวอย่างข้อความตอบกลับไปยังลูกค้า

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

1436403888651 - การประทับเวลา Unix

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

กำหนดการของไฟล์บันทึก

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

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

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

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

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

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

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

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

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

• port: (ค่าเริ่มต้น: 8000) หมายเลขพอร์ตที่ Edge Microgateway ประมวลผล Listener
• max_connections: (ค่าเริ่มต้น: -1) ระบุจำนวนสูงสุดของ การเชื่อมต่อขาเข้าพร้อมกันที่ Edge Microgateway รับได้ หากหมายเลขนี้คือ เกินกำหนด ระบบจะแสดงผลสถานะต่อไปนี้
  
  
  res.statusCode = 429; // Too many requests
• max_connections_hard: (ค่าเริ่มต้น: -1) จำนวนการเชื่อมต่อพร้อมกันสูงสุด ที่ Edge Microgateway จะได้รับก่อนปิดการเชื่อมต่อ การตั้งค่านี้ ที่มีเจตนาป้องกันการโจมตีแบบปฏิเสธการให้บริการ โดยปกติ ให้ตั้งตัวเลขที่มากกว่า max_connections.
• logging:
  • level: (ค่าเริ่มต้น: ข้อผิดพลาด)
    • info - บันทึกคำขอและการตอบกลับทั้งหมดที่ไหลผ่าน อินสแตนซ์ Edge Microgateway
    • warn - บันทึกข้อความเตือนเท่านั้น
    • error - บันทึกข้อความแสดงข้อผิดพลาดเท่านั้น
  • 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: (ค่าเริ่มต้น: true) ให้ตั้งค่าเป็น false เพื่อป้องกัน ส่วนหัว x-Forwarded-for ที่จะส่งไปยังเป้าหมาย โปรดทราบว่าหากส่วนหัว x-Forwarded-for อยู่ในคําขอ ระบบจะตั้งค่าเป็นค่า IP ของไคลเอ็นต์ใน Edge Analytics
• x-Forwarded-host: (ค่าเริ่มต้น: true) ให้ตั้งค่าเป็น false เพื่อป้องกัน ส่วนหัว x-Forwarded-host ที่จะส่งไปยังเป้าหมาย
• x-request-id: (ค่าเริ่มต้น: true) ตั้งค่าเป็น false เพื่อป้องกัน ส่วนหัว x-request-id ที่จะส่งไปยังเป้าหมาย
• x-response-time: (ค่าเริ่มต้น: true) ตั้งค่าเป็น false เพื่อป้องกัน ส่วนหัว x-response-time ที่จะส่งไปยังเป้าหมาย
• via: (ค่าเริ่มต้น: true) ตั้งเป็น false เพื่อป้องกันการส่งผ่านส่วนหัวเป็น ที่ส่งไปยังเป้าหมาย

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

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

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

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

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

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

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

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

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

รองรับเวอร์ชัน 4.2.x

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

ตัวเลือก 1

ตัวเลือกแรกคือตั้งค่าตัวเลือก edgemicro: session_tunnel เป็น "จริง" ใน ไฟล์การกำหนดค่า Microgateway

edge_config:

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

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

ตัวเลือก 2:

ตัวเลือกที่ 2 คือการระบุพร็อกซีและตั้งค่าพร็อกซี_tunnel ใน ผ่านไฟล์การกำหนดค่า 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=* ไปยัง ส่วนต้นของคำสั่ง start ตัวอย่างเช่น
   
   
   DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed

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

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

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

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

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

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

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

การแคชคีย์

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

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

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

การใช้ คีย์ API

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

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

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

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