การใช้เครื่องมือการติดตาม

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

เครื่องมือการติดตามคืออะไร

Trace เป็นเครื่องมือสำหรับแก้ปัญหาและตรวจสอบพร็อกซี API ที่ทำงานบน Apigee Edge ติดตาม จะช่วยให้คุณตรวจสอบรายละเอียดของแต่ละขั้นตอนผ่านขั้นตอนพร็อกซี API ได้

วิธีใช้ Trace

Trace ใช้งานง่าย คุณเริ่มเซสชันการติดตาม แล้วเรียก API ไปยังแพลตฟอร์ม Edge และอ่านผลลัพธ์

1. เข้าถึงหน้าพร็อกซี API ดังที่อธิบายด้านล่าง
   

   Edge

   วิธีเข้าถึงหน้าพร็อกซี API โดยใช้ Edge UI

   1. ลงชื่อเข้าใช้ apigee.com/edge
   2. เลือก Develop > พร็อกซี API ในแถบนำทางด้านซ้าย

   คลาสสิก Edge (Private Cloud)

   วิธีเข้าถึงหน้าพร็อกซี API โดยใช้ Edge UI แบบคลาสสิก

   1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือ ที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
   2. เลือก API > พร็อกซี API ในแถบนำทางด้านบน
2. เลือกพร็อกซี API จากหน้าพร็อกซี API
3. ตรวจสอบว่าได้ทำให้ API ที่ต้องการติดตามใช้งานได้แล้ว
4. คลิกTraceเพื่อไปที่มุมมองเครื่องมือการติดตาม
5. ใช้เมนูแบบเลื่อนลงการทำให้ใช้งานได้เพื่อติดตามเพื่อเลือก สภาพแวดล้อมการทำให้ใช้งานได้และการแก้ไขพร็อกซีที่คุณต้องการติดตาม
6. คลิกเริ่มเซสชันการติดตาม เมื่อเซสชันการติดตามทำงานอยู่ พร็อกซี API จะบันทึกรายละเอียดของแต่ละขั้นตอนในไปป์ไลน์การประมวลผล ขณะที่เซสชัน Trace ทำงานอยู่ ข้อความและข้อมูลบริบทจะได้รับการบันทึกจากการเข้าชมแบบสด
   

   

7. หากไม่มีการเข้าชมแบบสดไหลผ่านพร็อกซี ให้ส่งคำขอ กับ API คุณสามารถใช้เครื่องมือใดก็ได้ที่ต้องการส่งคำขอ เช่น curl, Postman หรือ เครื่องมือที่คุ้นเคย หรือคุณจะส่งคำขอจากเครื่องมือการติดตามโดยตรงก็ได้ เพียงป้อน URL แล้วคลิกส่ง หมายเหตุ: คุณสามารถส่งคำขอ GET ได้เฉพาะจาก เครื่องมือการติดตาม แต่ไม่ใช่คำขอ POST
   
   หมายเหตุ: เซสชันการติดตาม 1 เซสชันรองรับธุรกรรมคำขอ/การตอบกลับ 10 รายการต่อ ผู้ประมวลผลข้อความผ่านพร็อกซี API ที่เลือก ระบบคลาวด์ Edge ที่มีผู้ประมวลผลข้อมูล 2 ข้อความ รองรับการรับส่งข้อมูล รองรับธุรกรรมคำขอ/ตอบกลับ 20 รายการ เซสชันการติดตามโดยอัตโนมัติ จะหยุดหลังจาก 10 นาทีหากคุณไม่ได้หยุดด้วยตนเอง
   
8. เมื่อคุณบันทึกคำขอได้เป็นจำนวนที่เพียงพอแล้ว ให้คลิกหยุดติดตาม เซสชัน
9. รายการธุรกรรมคำขอ/การตอบกลับที่บันทึกไว้จะแสดงในเมนูด้านซ้าย คลิกที่รายการใดก็ได้ ธุรกรรมเพื่อดูผลลัพธ์โดยละเอียด

วิธีอ่านการติดตาม

เครื่องมือติดตามประกอบด้วย 2 ส่วนหลัก ได้แก่ แผนที่ธุรกรรมและรายละเอียดของเฟส

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

ต่อไปนี้เป็นตัวอย่างการแมปเครื่องมือติดตามที่มีกลุ่มการประมวลผลพร็อกซีหลักที่มีป้ายกำกับ

แผนที่ธุรกรรมของเครื่องมือติดตาม

แผนที่ธุรกรรม คำอธิบาย

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

ไอคอนแผนที่ธุรกรรม

	แอปไคลเอ็นต์ที่ส่งคำขอไปยัง ProxyEndpoint ของพร็อกซี API
	วงกลมจะทำเครื่องหมายปลายทางการเปลี่ยนในโฟลว์พร็อกซี โซลูชันเหล่านี้อยู่ใน คำขอมาจากไคลเอ็นต์ เมื่อคำขอไปยังเป้าหมาย และเมื่อการตอบกลับ กลับมาจากเป้าหมาย และเมื่อการตอบสนองกลับไปยังไคลเอ็นต์
	แท่งสูงแสดงถึงจุดเริ่มต้นของส่วนโฟลว์ในขั้นตอนของพร็อกซี API โฟลว์ ได้แก่ คำขอ ProxyEndpoint, คำขอ TargetEndpoint, การตอบกลับ TargetEndpoint และ การตอบกลับ ProxyEndpoint กลุ่มประกอบด้วย PreFlow, โฟลว์แบบมีเงื่อนไข และ PostFlow ดูการกำหนดค่าขั้นตอน เพื่อดูข้อมูลเพิ่มเติม
	บ่งบอกว่าการดําเนินการของ Analytics เกิดขึ้นในเบื้องหลัง
	โฟลว์แบบมีเงื่อนไขที่ประเมินค่าเป็นจริง สำหรับข้อมูลเบื้องต้นเกี่ยวกับขั้นตอนแบบมีเงื่อนไข ดูการกำหนดค่าขั้นตอน โปรดทราบว่าบางเงื่อนไขสร้างขึ้นจาก Edge ขึ้น ตัวอย่างเช่น ต่อไปนี้คือ ที่ Edge ใช้เพื่อตรวจสอบว่าเกิดข้อผิดพลาดใน ProxyEndpoint: ((error.state equals PROXY_REQ_FLOW) or (error.state equals PROXY_RESP_FLOW))
	โฟลว์แบบมีเงื่อนไขที่ประเมินว่าเป็นเท็จ หากต้องการดูข้อมูลเบื้องต้นเกี่ยวกับเงื่อนไข โปรดดูการกำหนดค่าขั้นตอน โปรดทราบว่าบางเงื่อนไขสร้างขึ้นจาก Edge ขึ้น ตัวอย่างเช่น ต่อไปนี้คือ ที่ Edge ใช้เพื่อตรวจสอบว่าเกิดข้อผิดพลาดใน ปลายทางเป้าหมาย: (((error.state equals TARGET_REQ_FLOW) or (error.state equals TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals RESP_START)))
	นโยบาย นโยบายแต่ละประเภทจะมีไอคอนไม่ซ้ำกัน ข้อความนี้มีไว้สำหรับ AssignMessage ไอคอนเหล่านี้ช่วยให้คุณเห็นว่ามีการบังคับใช้นโยบายในตำแหน่งใดตามลำดับที่เหมาะสม และ ประสบความสำเร็จหรือไม่ คุณสามารถคลิกไอคอนนโยบายเพื่อดูผลลัพธ์ของนโยบาย และเป็นไปตามที่คาดไว้หรือไม่ เช่น ดูได้ว่าข้อความ มีรูปแบบที่ถูกต้องหรือหากมีการแคชไว้ มีการระบุนโยบายการปฏิบัติอย่างเหมาะสมไว้อย่างชัดเจนโดย เครื่องหมายถูก ในกรณีที่เกิดข้อผิดพลาด เครื่องหมายอัศเจรีย์สีแดงจะแสดงบน ไอคอน เคล็ดลับ: ให้ความสำคัญกับเคล็ดลับเครื่องมือหรือช่วงเวลาเพื่อดูว่ามีนโยบาย ซึ่งใช้เวลานานกว่าที่คาดไว้
	ปรากฏเมื่อเป้าหมายแบ็กเอนด์เป็นแอปพลิเคชัน Node.js โปรดดู ภาพรวมของ Node.js บน Apigee Edge
	เป้าหมายแบ็กเอนด์ที่พร็อกซี API เรียกใช้
	เส้นเวลาจะระบุระยะเวลา (เป็นมิลลิวินาที) ที่ใช้ในการประมวลผล เสร็จสมบูรณ์ การเปรียบเทียบกลุ่มเวลาที่ผ่านไปจะช่วยให้คุณเห็นนโยบายที่ ที่ใช้เวลาดำเนินการนานที่สุด ซึ่งทำให้การเรียก API ช้าลง
	Epsilon ระบุระยะเวลาที่น้อยกว่า 1 มิลลิวินาที
	ปิดใช้อยู่ ปรากฏบนไอคอนนโยบายเมื่อปิดใช้นโยบาย ปิดใช้นโยบายได้ ด้วย API สาธารณะ โปรดดูหัวข้อข้อมูลอ้างอิงการกำหนดค่าพร็อกซี API
	เกิดข้อผิดพลาด ปรากฏบนไอคอนนโยบายเมื่อเงื่อนไขขั้นตอนนโยบายประเมินว่าเป็นเท็จ (ดู ตัวแปรและเงื่อนไขโฟลว์) หรือในไอคอนนโยบาย RaiseFault เมื่อใดก็ตามที่นโยบาย RaiseFault ทํางาน
	ข้าม ปรากฏบนไอคอนนโยบายเมื่อไม่มีการใช้นโยบายเนื่องจากขั้นตอน ประเมินสภาพสินค้าเป็น "เท็จ" ดูตัวแปรและเงื่อนไขสำหรับโฟลว์ เพื่อดูข้อมูลเพิ่มเติม

การทำความเข้าใจ รายละเอียดของเฟส

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

การปรับแต่งการบันทึกข้อความโดยใช้ตัวกรอง

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

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

สิ่งที่คุณต้องทราบเกี่ยวกับฟีเจอร์ตัวกรอง

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

วิธีสร้างการติดตาม ตัวกรอง

1. ถ้าเซสชันการติดตามกำลังทำงานอยู่ ให้หยุดเซสชันด้วยการคลิก หยุดการติดตาม เซสชัน
2. คลิกตัวกรองที่มุมซ้ายบนของเครื่องมือติดตามเพื่อขยาย ตัวกรอง
   
   
   
3. ในช่องตัวกรอง ให้ระบุพารามิเตอร์การค้นหาและ/หรือค่าส่วนหัวที่คุณต้องการกรอง เปิดอยู่ ในตัวอย่างนี้ เราจะระบุพารามิเตอร์การค้นหา 2 พารามิเตอร์เพื่อกรอง พารามิเตอร์ทั้ง 2 แบบต้องเป็น ที่แสดงในคำขอสำหรับการจับคู่ที่สำเร็จ
   
   
   
4. เริ่มเซสชันการติดตาม
5. เรียกใช้ API เฉพาะคำขอที่มีส่วนหัวและ/หรือคำค้นหาที่ระบุทั้งหมดเท่านั้น พารามิเตอร์ที่สร้างการจับคู่ที่ประสบความสำเร็จ

ในตัวอย่างข้างต้น การเรียก API นี้จะแสดงใน Trace

http://docs-test.apigee.net/cats?name=Penny&breed=Calico

แต่การดำเนินการนี้จะไม่ส่งผลดังต่อไปนี้

http://docs-test.apigee.net/cats?name=Penny

การแก้ไขข้อบกพร่องด้วยการติดตาม

Trace ช่วยให้คุณดูรายละเอียดภายในได้มากมายเกี่ยวกับพร็อกซี API เช่น

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

การเลือกดูตัวเลือกมุมมอง

เลือกตัวเลือกมุมมองสำหรับเซสชันการติดตาม

กำลังดาวน์โหลดผลการค้นหาการติดตาม

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

หากต้องการดาวน์โหลด ให้คลิกดาวน์โหลดเซสชันการติดตาม

กำลังแสดงคำขอเป็น curl

หลังจากติดตามการเรียก API ในเซิร์ฟเวอร์เป้าหมายแล้ว คุณจะดูคำขอในรูปแบบ curl ได้ คำสั่ง วิธีนี้มีประโยชน์อย่างยิ่งสำหรับการแก้ไขข้อบกพร่องด้วยเหตุผล 2 ประการดังนี้

• พร็อกซี API อาจแก้ไขคำขอ ดังนั้น จะเป็นประโยชน์ในการดูว่าคำขอจากพร็อกซี เซิร์ฟเวอร์เป้าหมายแตกต่างจากคำขอเดิม คำสั่ง curl จะแสดงคำสั่งที่แก้ไข อีกครั้ง
• สำหรับเพย์โหลดข้อความขนาดใหญ่ขึ้น Curl จะช่วยให้คุณเห็นส่วนหัว HTTP และข้อความ เนื้อหาได้ในที่เดียว (ขณะนี้มีขีดจำกัดอยู่ที่ประมาณ 1,000 อักขระ สำหรับเคล็ดลับเกี่ยวกับ เกินขีดจำกัดนี้แล้ว โปรดดู โพสต์ชุมชนนี้)

เพื่อความปลอดภัย ฟีเจอร์ curl จะมาสก์ส่วนหัว Authorization ของ HTTP

หากต้องการดูคำขอเป็น curl หลังจากการเรียก API เข้ามาในการติดตาม ให้เลือก "ส่งคำขอไปยัง เซิร์ฟเวอร์เป้าหมาย" ในแผนภาพแผนที่ธุรกรรม จากนั้นคลิกแสดง Curl บนปุ่ม "ส่งคำขอไปยังเซิร์ฟเวอร์เป้าหมายแล้ว" ในแผงรายละเอียดเฟส

การใช้ Trace ของการสนับสนุน Apigee

โดยค่าเริ่มต้น Apigee Edge จะอนุญาตให้ทีมสนับสนุนของ Apigee ใช้เครื่องมือ Trace ในพร็อกซี API เพื่อให้การสนับสนุนได้ คุณสามารถปิดใช้ตัวเลือกนี้ได้ทุกเมื่อ แต่การปิดใช้ตัวเลือกนี้อาจจํากัดความสามารถในการสนับสนุนคุณของ Apigee

หากต้องการปิดใช้งานการสนับสนุน Apigee ไม่ให้ใช้เครื่องมือติดตาม:

1. ลงชื่อเข้าใช้ https://apigee.com/edge
2. เลือกผู้ดูแลระบบ > ความเป็นส่วนตัวและความปลอดภัย ในแถบนําทางด้านซ้าย
3. คลิก Enable Apigee Support to Trace เพื่อปิดใช้เครื่องมือการติดตามโดยทีมสนับสนุนของ Apigee