คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
หัวข้อนี้เป็นข้อมูลอ้างอิงสำหรับเมตริก Analytics, มิติข้อมูล และตัวกรอง ดูบริบทเพิ่มเติมเกี่ยวกับการใช้เมตริกเหล่านี้ได้ที่ภาพรวมของ API Analytics
หัวข้อนี้แสดงชื่อของเมตริกและมิติข้อมูลตามที่ปรากฏใน UI ตามที่คุณจำเป็นต้องใช้ในการเรียก API
- คุณจะเห็นชื่อ UI เมื่อสร้างรายงานที่กำหนดเอง
- ใช้ชื่อเฉพาะ API เมื่อรับเมตริก สร้าง รายงาน หรืออัปเดตคำจำกัดความรายงาน
เมตริก
ต่อไปนี้เป็นเมตริก API ที่คุณสามารถดึงข้อมูลได้ในรายงานที่กำหนดเองและการเรียก API การจัดการ
ชื่อรายงานที่กำหนดเอง | ชื่อที่จะใช้ใน Management API | ฟังก์ชัน | คำอธิบาย |
---|---|---|---|
จำนวนธุรกรรมเฉลี่ยต่อวินาที | TTS | ไม่มี |
จำนวนธุรกรรมโดยเฉลี่ยต่อวินาที ซึ่งหมายถึงคำขอพร็อกซี API โปรดทราบว่าหากคุณมีจำนวนธุรกรรมค่อนข้างต่ำในช่วงเวลาหนึ่ง จำนวนการทำธุรกรรมโดยเฉลี่ยต่อวินาทีในรายงานที่กำหนดเองของ UI อาจดูเหมือนเป็น 0 หากตัวเลขมีค่าน้อยกว่า 2 หลัก ไวยากรณ์ API: |
พบแคช | cache_hit | ผลรวม |
จำนวนคำขอ API ที่สำเร็จซึ่งใช้แคชการตอบกลับแทนการตอบกลับจากบริการเป้าหมาย ไวยากรณ์ API: |
จำนวนองค์ประกอบแคช L1 | ax_cache_l1_count | เฉลี่ย, นาที, สูงสุด |
แสดงจำนวนองค์ประกอบในแคช L1 (ในหน่วยความจำ) ต่อธุรกรรมในระยะเวลาที่กำหนด ตัวอย่างเช่น หากคุณเลือก ไวยากรณ์ API: |
ข้อผิดพลาดเกี่ยวกับนโยบาย | policy_error | ผลรวม |
จำนวนข้อผิดพลาดด้านนโยบายทั้งหมดในระยะเวลาที่ระบุ ข้อผิดพลาดของนโยบายมักจะเกิดขึ้นจากการออกแบบ เช่น นโยบาย "ยืนยันคีย์ API" จะแสดงข้อผิดพลาดเมื่อมีการส่งคีย์ API ที่ไม่ถูกต้องในคำขอ และนโยบาย Spike Arrest จะแสดงข้อผิดพลาดหากจำนวนการเรียก API เกินขีดจำกัดที่ระบุไว้ในนโยบาย เมตริกนี้จึงมีประโยชน์ในการหาจุดที่เป็นปัญหาที่อาจเกิดขึ้นใน API เช่น เมตริก policy_error ที่จัดกลุ่มตามมิติข้อมูล developer_app อาจช่วยให้คุณค้นพบว่าคีย์ API หรือโทเค็น OAuth ของแอปหมดอายุแล้ว คุณอาจพบว่าพร็อกซี API ที่ทำให้เกิดข้อผิดพลาดการจับกุมการเพิ่มขึ้นจำนวนมาก ทำให้คุณพบว่าขีดจำกัดการจับกุมที่เพิ่มขึ้นอย่างฉับพลันของพร็อกซีไม่ได้คำนึงถึงการเข้าชมที่เพิ่มขึ้นในวันหยุด ระบบจะบันทึกข้อผิดพลาดด้านนโยบายไว้ใน Analytics ก็ต่อเมื่อข้อผิดพลาดดังกล่าวส่งผลให้พร็อกซี API ทำงานไม่สำเร็จ
เช่น หากตั้งค่าแอตทริบิวต์ มิติข้อมูลชื่อนโยบายเกี่ยวกับข้อผิดพลาด (ax_execution_fault_policy_name) มีประโยชน์ในการจัดกลุ่มข้อผิดพลาดของนโยบายตามชื่อนโยบาย เป้าหมายที่ล้มเหลว (เช่น 404 หรือ 503) จะไม่นับเป็นความล้มเหลวของนโยบาย การดำเนินการดังกล่าวนับเป็นความล้มเหลวของพร็อกซี API (is_error) ไวยากรณ์ API: |
ข้อผิดพลาดเกี่ยวกับพร็อกซี | is_error | ผลรวม |
จำนวนครั้งทั้งหมดที่พร็อกซี API ดำเนินการไม่สำเร็จในระยะเวลาที่กำหนด พร็อกซีที่ไม่สำเร็จอาจเกิดขึ้นเมื่อนโยบายล้มเหลวหรือเมื่อรันไทม์ล้มเหลว เช่น 404 หรือ 503 จากบริการเป้าหมาย มิติข้อมูลพร็อกซี (apiproxy) มีประโยชน์ในการจัดกลุ่มความล้มเหลวของพร็อกซี API ตามพร็อกซี ไวยากรณ์ API: |
เวลาในการตอบสนองคำขอในการประมวลผล | request_processing_latency | เฉลี่ย, นาที, สูงสุด |
ระยะเวลา (เฉลี่ย ต่ำสุด หรือสูงสุด) หน่วยเป็นมิลลิวินาทีที่ Edge จะประมวลผลคำขอที่เข้ามาใหม่ เวลาจะเริ่มต้นเมื่อคำขอมาถึง Edge และสิ้นสุดเมื่อ Edge ส่งต่อคำขอไปยังบริการเป้าหมาย เมื่อใช้มิติข้อมูลที่แตกต่างกัน คุณสามารถตรวจสอบเวลาในการตอบสนองของการดำเนินการตามคำขอโดยใช้พร็อกซี API, แอปของนักพัฒนาซอฟต์แวร์, ภูมิภาค และอื่นๆ ไวยากรณ์ API: |
ขนาดคำขอ | request_size | ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด |
ขนาดของเพย์โหลดคำขอที่ Edge ได้รับเป็นไบต์ ไวยากรณ์ API: |
ใช้งานแคชการตอบกลับแล้ว | ax_cache_executed | ผลรวม |
จำนวนครั้งทั้งหมดที่มีการใช้นโยบายแคชการตอบกลับในระยะเวลาที่กำหนด เนื่องจากนโยบายแคชการตอบกลับจะแนบไว้ใน 2 ตำแหน่งในพร็อกซี API (1 ครั้งในคำขอและ 1 ครั้งในการตอบสนอง) จึงมักเรียกใช้ 2 ครั้งในการเรียก API แคช "get" และ "put" แคชจะนับเป็นการดำเนินการ 1 รายการ อย่างไรก็ตาม การดำเนินการแคชการตอบกลับจะเป็น 0 หากองค์ประกอบ ในเครื่องมือติดตาม คุณสามารถคลิกไอคอนแคชการตอบกลับในการเรียก API ที่ดำเนินการ และดูตัวแปรโฟลว์ ไวยากรณ์ API: |
เวลาในการตอบสนองในการประมวลผลการตอบกลับ | response_processing_latency | เฉลี่ย, นาที, สูงสุด |
ระยะเวลา (เฉลี่ย ต่ำสุด หรือสูงสุด) หน่วยเป็นมิลลิวินาทีที่ใช้ Edge ในการประมวลผลการตอบกลับจาก API เวลาจะเริ่มต้นเมื่อพร็อกซี API ได้รับการตอบสนองของบริการเป้าหมายและสิ้นสุดเมื่อ Apigee ส่งต่อการตอบกลับไปยังผู้เรียกใช้เดิม เมื่อใช้มิติข้อมูลที่แตกต่างกัน คุณสามารถตรวจสอบเวลาในการตอบสนองของการประมวลผลการตอบกลับตามพร็อกซี API, ภูมิภาค และอื่นๆ ไวยากรณ์ API: |
ขนาดการตอบสนอง | response_size | ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด |
ขนาดของเปย์โหลดการตอบกลับที่ส่งคืนไปยังไคลเอ็นต์เป็นไบต์ ไวยากรณ์ API: |
ข้อผิดพลาดเป้าหมาย | target_error | ผลรวม |
จำนวนการตอบกลับทั้งหมด 5xx รายการจากบริการเป้าหมาย ข้อผิดพลาดเหล่านี้เป็นข้อผิดพลาดของบริการเป้าหมายที่ไม่ได้เกิดจาก Apigee ไวยากรณ์ API: |
เวลาตอบสนองเป้าหมาย | target_response_time | ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด |
ระยะเวลา (ผลรวม เฉลี่ย ต่ำสุด หรือสูงสุด) หน่วยเป็นมิลลิวินาทีที่เซิร์ฟเวอร์เป้าหมายจะตอบกลับการโทร เมตริกนี้จะบอกให้ทราบถึงประสิทธิภาพการทำงานของเซิร์ฟเวอร์เป้าหมาย เวลาจะเริ่มต้นเมื่อ Edge ส่งต่อคำขอไปยังบริการเป้าหมาย และจะสิ้นสุดเมื่อ Edge ได้รับการตอบกลับ โปรดทราบว่าหากการเรียก API ส่งการตอบกลับจากแคช (เช่น ใช้นโยบายแคชการตอบกลับ) การเรียกจะไม่ส่งถึงบริการเป้าหมาย และจะไม่มีการบันทึกเมตริกเวลาตอบสนองเป้าหมาย ไวยากรณ์ API: |
เวลาในการตอบกลับทั้งหมด | total_response_time | ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด |
ระยะเวลา (ผลรวม ค่าเฉลี่ย ต่ำสุด หรือสูงสุด) หน่วยเป็นมิลลิวินาทีนับตั้งแต่ที่ Edge ได้รับคำขอจากไคลเอ็นต์จนถึงตอนที่ Edge ส่งการตอบกลับกลับไปยังไคลเอ็นต์ เวลาจะรวมค่าใช้จ่ายของเครือข่าย (เช่น เวลาที่ตัวจัดสรรภาระงานและเราเตอร์ใช้ในการทำงาน) เวลาในการตอบสนองการประมวลผลคำขอ เวลาในการตอบสนองในการประมวลผลการตอบกลับ และเวลาตอบสนองเป้าหมาย (หากการตอบสนองได้รับมาจากบริการเป้าหมายแทนที่จะเป็นแคช) เมื่อใช้มิติข้อมูลที่แตกต่างกัน คุณสามารถตรวจสอบเวลาในการตอบสนองในการประมวลผลตามพร็อกซี API, แอปของนักพัฒนาซอฟต์แวร์, ภูมิภาค และอื่นๆ ไวยากรณ์ API: |
การจราจร | message_count | ผลรวม |
จำนวนการเรียก API ทั้งหมดที่ประมวลผลโดย Edge ในระยะเวลาที่ระบุ ใช้มิติข้อมูลเพื่อจัดกลุ่มจำนวนการเข้าชมในวิธีที่มีความหมายกับคุณมากที่สุด ไวยากรณ์ API: |
ขนาด
มิติข้อมูลช่วยให้คุณดูเมตริกต่างๆ ในการจัดกลุ่มที่มีความหมาย ตัวอย่างเช่น การดูจํานวนการเข้าชมทั้งหมด จะมีประสิทธิภาพมากขึ้นเมื่อคุณดูจํานวนดังกล่าวสําหรับแอปนักพัฒนาแอปหรือพร็อกซี API แต่ละรายการ
ต่อไปนี้เป็นมิติข้อมูลที่ Apigee ของ Apigee นอกจากนี้ คุณยังสร้างมิติข้อมูลของคุณเองได้ตามที่อธิบายไว้ในวิเคราะห์เนื้อหาข้อความ API โดยใช้การวิเคราะห์ที่กำหนดเอง
ชื่อรายงานที่กำหนดเอง | ชื่อที่จะใช้ใน Management API | คำอธิบาย |
---|---|---|
เอนทิตี Apigee | ||
โทเค็นเพื่อการเข้าถึง | access_token | โทเค็นการเข้าถึง OAuth ของผู้ใช้ปลายทางในแอป |
ผลิตภัณฑ์ API | api_product |
ชื่อผลิตภัณฑ์ API ที่มีพร็อกซี API ที่กำลังเรียกใช้ หากต้องการรับมิติข้อมูลนี้ แอปของนักพัฒนาซอฟต์แวร์ที่เรียกใช้จะต้องเชื่อมโยงกับผลิตภัณฑ์ API อย่างน้อย 1 รายการที่มีพร็อกซี API และพร็อกซีที่มีการเรียกใช้ต้องตรวจสอบคีย์ API หรือโทเค็น OAuth ที่ส่งไปพร้อมกับการเรียก API คีย์หรือโทเค็นเชื่อมโยงกับผลิตภัณฑ์ API แล้ว หากต้องการข้อมูลเพิ่มเติม โปรดดูสิ่งที่ต้องทำก่อน: วิธีสร้างข้อมูลวิเคราะห์ที่สมบูรณ์ หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูเพิ่มเติมที่ ค่าเอนทิตีการวิเคราะห์ "(not set)" หมายถึงอะไร |
คีย์แคช | ax_cache_key |
คีย์ที่มีค่าแคชการตอบกลับที่มีการเข้าถึง ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีสร้างคีย์สำหรับแคชการตอบกลับได้ที่นโยบายแคชการตอบกลับ ในเครื่องมือติดตาม เมื่อคุณเลือกนโยบายแคชการตอบกลับที่อ่านหรือเขียนข้อมูลลงในแคช คุณจะเห็นค่านี้ในตัวแปรโฟลว์ |
ชื่อแคช | ax_cache_name |
ชื่อของแคชที่มีคีย์/ค่าที่นโยบายแคชการตอบกลับใช้ ซึ่งนำหน้าด้วย orgName__envName__ ตัวอย่างเช่น หากองค์กรคือ "foo" สภาพแวดล้อมจะเป็น "test" และชื่อแคชคือ "myCache" ax_cache_name จะเป็น foo__test__myCache ในเครื่องมือติดตาม เมื่อเลือกนโยบายแคชการตอบกลับ คุณจะเห็นค่านี้ในตัวแปรโฟลว์ |
แหล่งที่มาของแคช | ax_cache_source |
ระดับแคช (ในหน่วยความจำ "L1" หรือฐานข้อมูล "L2") ที่มีการดึงข้อมูลแคชการตอบกลับ มิติข้อมูลนี้จะแสดง "CACHE_MISS" ด้วยเมื่อมีการส่งการตอบกลับจากเป้าหมายแทนที่จะเป็นแคช (และรีเฟรชแคชการตอบกลับด้วยการตอบกลับเป้าหมาย) หรือเมื่อคีย์แคชในคำขอไม่ถูกต้อง คีย์แคชต้องมีขนาดไม่เกิน 2 KB ในเครื่องมือติดตาม เมื่อคุณเลือกนโยบายแคชการตอบกลับ คุณจะเห็นค่านี้ในตัวแปรโฟลว์ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับระดับแคชที่หัวข้อแคชภายใน |
Client-ID | client_id |
คีย์ผู้ใช้ (คีย์ API) ของแอปนักพัฒนาซอฟต์แวร์ที่ทำการเรียก API ไม่ว่าจะผ่านในคำขอเป็นคีย์ API หรือรวมอยู่ในโทเค็น OAuth หากต้องการรับมิติข้อมูลนี้ ต้องมีการกำหนดค่าพร็อกซีที่รับการเรียกเพื่อตรวจสอบคีย์ API หรือโทเค็น OAuth ที่ถูกต้อง แอปของนักพัฒนาซอฟต์แวร์จะได้รับคีย์ API ซึ่งใช้สร้างโทเค็น OAuth เมื่อลงทะเบียนแอปใน Edge ได้ หากต้องการข้อมูลเพิ่มเติม โปรดดูสิ่งที่ต้องทำก่อน: วิธีสร้างข้อมูลวิเคราะห์ที่สมบูรณ์ หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมได้ในค่าเอนทิตีการวิเคราะห์ "(not set)" หมายถึงอะไร |
แอปนักพัฒนาซอฟต์แวร์ | developer_app |
แอปของนักพัฒนาแอปที่ลงทะเบียน Edge ซึ่งเรียกใช้ API หากต้องการรับมิติข้อมูลนี้ แอปต้องเชื่อมโยงกับผลิตภัณฑ์ API อย่างน้อย 1 รายการซึ่งมีพร็อกซี API ที่กำลังเรียกใช้ และพร็อกซีต้องตรวจหาคีย์ API หรือโทเค็น OAuth ที่ส่งไปพร้อมกับการเรียก API คีย์หรือโทเค็นจะระบุแอปของนักพัฒนาซอฟต์แวร์ สำหรับข้อมูลเพิ่มเติม โปรดดูสิ่งที่ต้องทำก่อน: วิธีสร้างข้อมูลการวิเคราะห์ที่สมบูรณ์ หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมได้ในค่าเอนทิตีการวิเคราะห์ "(not set)" หมายถึงอะไร |
อีเมลของนักพัฒนาซอฟต์แวร์ | developer_email |
อีเมลของนักพัฒนาซอฟต์แวร์ที่ลงทะเบียน Edge ซึ่งแอปได้เรียก API นักพัฒนาซอฟต์แวร์ต้องมีแอปที่เชื่อมโยงกับผลิตภัณฑ์ API อย่างน้อย 1 รายการซึ่งมีพร็อกซี API ที่กำลังเรียกใช้ และพร็อกซีต้องตรวจสอบคีย์ API หรือโทเค็น OAuth ที่ส่งไปพร้อมกับการเรียก API เพื่อให้ได้รับมิติข้อมูลนี้ คีย์หรือโทเค็นจะระบุแอปของนักพัฒนาซอฟต์แวร์ สำหรับข้อมูลเพิ่มเติม โปรดดูสิ่งที่ต้องทำก่อน: วิธีสร้างข้อมูลการวิเคราะห์ที่สมบูรณ์ หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมได้ในค่าเอนทิตีการวิเคราะห์ "(not set)" หมายถึงอะไร |
รหัสนักพัฒนาซอฟต์แวร์ | นักพัฒนาซอฟต์แวร์ |
รหัสนักพัฒนาซอฟต์แวร์ Edge ที่ไม่ซ้ำกันซึ่งสร้างในรูปแบบ org_name@@@unique_id นักพัฒนาซอฟต์แวร์ต้องมีแอปที่เชื่อมโยงกับผลิตภัณฑ์ API อย่างน้อย 1 รายการที่มีพร็อกซี API ที่กำลังเรียกใช้อยู่ และพร็อกซีต้องตรวจหาคีย์ API หรือโทเค็น OAuth ที่ส่งไปพร้อมกับการเรียก API เพื่อให้ได้รับมิติข้อมูลนี้ คีย์หรือโทเค็นจะระบุนักพัฒนาแอป หากต้องการทราบข้อมูลเพิ่มเติม โปรดดูสิ่งที่ต้องทำก่อน: วิธีสร้างข้อมูลวิเคราะห์ที่สมบูรณ์ หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมได้ในค่าเอนทิตีการวิเคราะห์ "(not set)" หมายถึงอะไร |
สภาพแวดล้อม | สภาพแวดล้อม | สภาพแวดล้อม Edge ที่มีการทำให้พร็อกซี API ใช้งานได้ เช่น "test" หรือ "prod" |
รหัสข้อผิดพลาดเกี่ยวกับข้อผิดพลาด | ax_edge_execution_fault_code |
รหัสข้อผิดพลาดของข้อผิดพลาด ตัวอย่างเช่น
|
ชื่อโฟลว์ของข้อผิดพลาด | ax_execution_fault _flow_name |
flow ที่มีชื่อในพร็อกซี API ที่ทำให้เกิดข้อผิดพลาด เช่น "PreFlow" "PostFlow" หรือชื่อของโฟลว์แบบมีเงื่อนไขที่คุณสร้างขึ้น โปรดทราบว่าชื่อเต็มที่จะใช้ใน API การจัดการคือ ax_execution_fault_flow_name โดยไม่มีการขึ้นบรรทัดใหม่ คุณจะเห็นค่า "(not set)" ในตำแหน่งที่ไม่มีข้อผิดพลาด |
ทรัพยากรโฟลว์ | flow_resource | สำหรับ Apigee เท่านั้น ดูโพสต์ชุมชนนี้หากอยากรู้ |
สถานะโฟลว์เมื่อมีข้อผิดพลาด | ax_execution_fault _flow_state |
ชื่อของโฟลว์พร็อกซี API จะทำให้เกิดข้อผิดพลาด เช่น "PROXY_REQ_FLOW" หรือ "TARGET_RESP_FLOW" โปรดทราบว่าชื่อเต็มที่จะใช้ใน API การจัดการคือ ax_execution_fault_flow_state โดยไม่มีตัวแบ่งบรรทัด |
รหัสโฟลว์เกตเวย์ | gateway_flow_id | เมื่อการเรียก API เคลื่อนที่ผ่าน Edge การเรียกแต่ละรายการจะได้รับรหัสโฟลว์เกตเวย์ของตัวเอง ตัวอย่างเช่น rrt329ea-12575-114653952-1 รหัสโฟลว์เกตเวย์มีประโยชน์ในการแยกแยะเมตริกในสถานการณ์ที่มี TPS สูงซึ่งมิติข้อมูลอื่นๆ เช่น องค์กร สภาพแวดล้อม และการประทับเวลา เหมือนกันในทุกการเรียกใช้ |
องค์กร | องค์กร | องค์กร Edge ที่มีการทำให้พร็อกซี API ใช้งานได้ |
ชื่อนโยบายเกี่ยวกับข้อผิดพลาด | ax_execution_fault _policy_name |
ชื่อของนโยบายที่เกิดข้อผิดพลาดและทำให้เรียก API ไม่สำเร็จ โปรดทราบว่าชื่อเต็มที่จะใช้ใน API การจัดการคือ ax_execution_fault_policy_name โดยไม่มีการขึ้นบรรทัดใหม่ หากนโยบายแสดงข้อผิดพลาด แต่มีการตั้งค่าแอตทริบิวต์รูทของนโยบาย |
พร็อกซี | apiproxy | ชื่อเครื่อง (ไม่ใช่ชื่อที่แสดง) ของพร็อกซี API |
เส้นทางฐานพร็อกซี | proxy_basepath |
BasePath ที่กำหนดค่าบนพร็อกซี API ProxyEndpoint เส้นทางฐานไม่รวมโดเมนและส่วนพอร์ตของ URL พร็อกซี API ตัวอย่างเช่น หาก URL หลักของพร็อกซี API คือ https://apigeedocs-test.apigee.net/releasenotes/ เส้นทางฐานจะเป็น /releasenotes ค่านี้ยังจัดเก็บอยู่ใน ตัวแปรโฟลว์ |
คำต่อท้ายเส้นทางพร็อกซี | proxy_pathsuffix |
เส้นทางทรัพยากรที่เพิ่มลงในเส้นทางฐานพร็อกซี API ตัวอย่างเช่น หาก URL พื้นฐานของพร็อกซี API คือ หากไม่มีการใช้เส้นทางต่อท้าย ค่าจะว่างเปล่า ค่านี้ยังจัดเก็บอยู่ใน ตัวแปรโฟลว์ |
การแก้ไขพร็อกซี | apiproxy_revision | หมายเลขการแก้ไขของพร็อกซี API ที่จัดการการเรียก API ซึ่งไม่ได้หมายถึงการแก้ไขล่าสุดของพร็อกซี API เสมอไป หากพร็อกซี API มีการแก้ไข 10 รายการ ระบบอาจทำให้การแก้ไขครั้งที่ 8 ใช้งานได้ในปัจจุบัน นอกจากนี้ API อาจมีการทำให้การแก้ไขใช้งานได้หลายรายการ ตราบใดที่การแก้ไขมีเส้นทางฐานแตกต่างกัน ตามที่อธิบายไว้ในการทำให้พร็อกซีใช้งานได้ใน UI |
IP ไคลเอ็นต์ที่แก้ไขแล้ว | ax_resolved_client_ip |
มีที่อยู่ IP ของไคลเอ็นต์ต้นทาง ค่าของมิติข้อมูล โปรดทราบว่าเมื่อใช้การกำหนดเส้นทางผลิตภัณฑ์ เช่น Akamai เพื่อบันทึกที่อยู่ IP ที่แท้จริงของไคลเอ็นต์ ระบบจะส่ง IP ของไคลเอ็นต์ไปยัง Edge ในส่วนหัว HTTP ค่าของมิติข้อมูล
|
รหัสสถานะการตอบกลับ | response_status_code | รหัสสถานะการตอบกลับ HTTP ที่ส่งต่อจาก Apigee ไปยังไคลเอ็นต์ เช่น 200, 404, 503 เป็นต้น ใน Edge รหัสสถานะการตอบสนองจากเป้าหมายจะเขียนทับได้ด้วยนโยบาย เช่น Assign Message และ Raise Fault มิติข้อมูลนี้จึงอาจแตกต่างจากโค้ดตอบกลับเป้าหมาย (target_response_code) |
โฮสต์เสมือน | virtual_host | ชื่อของโฮสต์เสมือนที่มีการเรียก API ตัวอย่างเช่น องค์กรมีโฮสต์เสมือน 2 รายการโดยค่าเริ่มต้น ได้แก่ default (http) และ secure (https) |
ขาเข้า/ไคลเอ็นต์ | ||
ที่อยู่ IP ของไคลเอ็นต์ | client_ip | ที่อยู่ IP ของระบบที่เข้าถึงเราเตอร์ เช่น ไคลเอ็นต์เดิม (proxy_client_ip) หรือตัวจัดสรรภาระงาน เมื่อมี IP หลายรายการในส่วนหัว X-Forwarded-For นี่คือ IP สุดท้ายที่แสดง |
หมวดหมู่อุปกรณ์ | ax_ua_device_category | ประเภทอุปกรณ์ที่มีการเรียก API เช่น "แท็บเล็ต" หรือ "สมาร์ทโฟน" |
ตระกูลระบบปฏิบัติการ | ax_ua_os_family | กลุ่มระบบปฏิบัติการของอุปกรณ์ที่โทรออก เช่น "Android" หรือ "iOS" |
เวอร์ชันระบบปฏิบัติการ | ax_ua_os_version |
เวอร์ชันระบบปฏิบัติการของอุปกรณ์ที่โทรออก การใช้รายการนี้เป็นมิติข้อมูล "เจาะลึก" รายการที่ 2 กับ OS Family (ax_ua_os_family) เพื่อดูเวอร์ชันของระบบปฏิบัติการ |
IP ไคลเอ็นต์พร็อกซี | proxy_client_ip |
ที่อยู่ IP ของไคลเอ็นต์ที่เรียกใช้ ซึ่งจัดเก็บไว้ในตัวแปรโฟลว์ |
IP ไคลเอ็นต์ที่อ้างอิง | ax_true_client_ip | เมื่อใช้การกำหนดเส้นทางผลิตภัณฑ์ เช่น Akamai เพื่อบันทึกที่อยู่ IP ที่แท้จริงของไคลเอ็นต์ ระบบจะส่ง IP ของไคลเอ็นต์ไปยัง Edge ในส่วนหัว HTTP Edge จะใช้มิติข้อมูล |
เส้นทางคำขอ | request_path |
เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย โดยไม่รวมพารามิเตอร์การค้นหา ตัวอย่างเช่น เป้าหมายตัวอย่างของ Apigee คือ |
URI คำขอ | request_uri |
เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย รวมถึงพารามิเตอร์การค้นหา ตัวอย่างเช่น เป้าหมายตัวอย่าง Apigee ของ |
ขอคำกริยา | request_verb | คำกริยาของคำขอ HTTP ในคำขอ API เช่น GET, POST, PUT, DELETE |
User Agent | User Agent |
ชื่อของ User Agent หรือ Software Agent ที่ใช้เรียก API ตัวอย่าง
|
กลุ่ม User Agent | ax_ua_agent_family | กลุ่มของ useragent เช่น "Chrome Mobile" หรือ "cURL" |
ประเภท User Agent | ax_ua_agent_type | ประเภท useragent เช่น "เบราว์เซอร์" "เบราว์เซอร์ในอุปกรณ์เคลื่อนที่" "คลัง" และอื่นๆ |
เวอร์ชันของ User Agent | ax_ua_agent_version |
เวอร์ชันของ Useragent การใช้รายการนี้เป็นมิติข้อมูล "เจาะลึก" รายการที่ 2 กับกลุ่ม User Agent (ax_ua_agent_family) เพื่อรับเวอร์ชันของกลุ่ม Agent |
ขาออก/เป้าหมาย | ||
เส้นทางฐานเป้าหมาย | target_basepath |
เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย (ไม่รวมพารามิเตอร์การค้นหา) ที่กำหนดไว้ใน ตัวอย่างเช่น สมมติว่าพร็อกซี API เรียกเป้าหมายต่อไปนี้ <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> ในตัวอย่างนี้ target_basepath คือ หากเป้าหมายคือ: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> target_basepath จะเป็น Null ในเครื่องมือติดตาม เมื่อคุณเลือกไอคอน AX ที่ท้ายแผนภาพโฟลว์แล้ว ตัวแปรโฟลว์ |
โฮสต์เป้าหมาย | target_host | โฮสต์ของบริการเป้าหมาย เช่น หากพร็อกซี API เรียกใช้ http://mocktarget.apigee.net/help แล้ว target_host จะเป็น mocktarget.apigee.net |
ที่อยู่ IP เป้าหมาย | target_ip | ที่อยู่ IP ของบริการเป้าหมายที่ส่งคืนการตอบกลับไปยังพร็อกซี API |
โค้ดตอบกลับเป้าหมาย | target_response_code |
รหัสสถานะการตอบกลับ HTTP ที่บริการเป้าหมายส่งคืนไปยังพร็อกซี API เช่น 200, 404, 503 และอื่นๆ ค่า "null" หมายความว่าคำขอไม่เคยไปถึงบริการเป้าหมาย ข้อผิดพลาดนี้เกิดขึ้นเมื่อระบบแสดงการตอบกลับโดยนโยบายแคชการตอบกลับหรือเมื่อการประมวลผลคำขอล้มเหลว ซึ่งแตกต่างจากมิติข้อมูลรหัสสถานะการตอบกลับ (response_status_code) |
URL เป้าหมาย | target_url |
URL แบบเต็มของบริการเป้าหมายที่กำหนดไว้ใน TargetEndpoint ของพร็อกซี API <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> ในตัวอย่างนี้ target_url คือ โปรดทราบว่าคุณยังลบล้าง URL ได้ในระหว่างการประมวลผลพร็อกซี API ด้วยตัวแปรโฟลว์ ในเชนพร็อกซีและเมื่อใช้เป้าหมายสคริปต์ (Node.js) target_url ในพร็อกซีการเรียกใช้จะเป็นค่าว่าง |
ส่งต่อ X สำหรับ | x_forwarded_for_ip | รายการที่อยู่ IP ในส่วนหัว Edge จะใช้มิติข้อมูล |
เวลา | ||
วันในสัปดาห์ | ax_day_of_week | ตัวย่อของวัน 3 ตัวอักษรของสัปดาห์ที่เรียกใช้ API เช่น จ. พ. |
เดือน | ax_month_of_year | เดือนที่เป็นตัวเลขที่มีการเรียก API เช่น "03" สำหรับเดือนมีนาคม |
เวลา | ax_hour_of_day |
ชั่วโมงแบบ 2 หลักที่มีการเรียก API ตามระบบเวลา 24 ชั่วโมง เช่น การเรียก API ที่เกิดขึ้นในชั่วโมงระหว่าง 22:00 น. ถึง 23:00 น. ax_hours_of_day จะเป็น 22 ค่าเวลาอยู่ในเขตเวลา UTC |
เขตเวลา | ax_geo_timezone | ชื่อทั่วไปของเขตเวลาที่ใช้เรียก API เช่น America/New_York และ Europe/Dublin |
สัปดาห์ของเดือน | ax_week_of_month | สัปดาห์ของเดือนที่เป็นตัวเลข เช่น สำหรับการเรียก API ที่เกิดขึ้นในสัปดาห์ที่ 3 ของเดือน ax_week_of_month คือ 3 |
ตำแหน่ง | ||
เมือง | ax_geo_city | เมืองที่มีการเรียก API |
ทวีป | ax_geo_continent | รหัสตัวอักษร 2 ตัวของทวีปที่มีการเรียก API เช่น NA สำหรับอเมริกาเหนือ |
ประเทศ | ax_geo_country | รหัสแบบ 2 ตัวอักษรของประเทศที่มีการเรียก API เช่น US สำหรับสหรัฐอเมริกา |
พื้นที่ทางภูมิศาสตร์ | ax_geo_region | รหัสที่มีขีดกลางสั้นสำหรับภูมิภาคทางภูมิศาสตร์ เช่น STATE-COUNTRY เช่น WA-US สําหรับวอชิงตัน-สหรัฐอเมริกา |
ภูมิภาค | ax_dn_region | ชื่อของศูนย์ข้อมูล Apigee ที่มีการทำให้พร็อกซี API ใช้งานได้ เช่น us-east-1 |
การสร้างรายได้ | ||
ข้อความละเว้นธุรกรรม Mint | x_apigee_mint_tx_ignoreMessage | แฟล็กที่ระบุว่าจะละเว้นข้อความที่เกี่ยวข้องกับการสร้างรายได้หรือไม่ ตั้งค่าเป็น false สำหรับองค์กรการสร้างรายได้ทั้งหมด |
สถานะธุรกรรม (Mint) | x_apigee_mint_tx_status | สถานะของคำขอการสร้างรายได้ เช่น สำเร็จ ล้มเหลว ไม่ถูกต้อง หรือไม่มี |
ฟิลเตอร์
ตัวกรองช่วยให้คุณจำกัดผลการค้นหาให้แสดงเฉพาะเมตริกที่มีลักษณะเฉพาะได้ ตัวอย่างตัวกรองมีดังนี้ ใช้ชื่อรูปแบบ API เมตริกและมิติข้อมูลเมื่อกำหนดตัวกรอง
แสดงเมตริกสำหรับพร็อกซี API ที่มีชื่อหนังสือหรือเพลง:
filter=(apiproxy in 'books','music')
แสดงเมตริกสำหรับพร็อกซี API ที่มีชื่อขึ้นต้นด้วย "m":
filter=(apiproxy like 'm%')
แสดงเมตริกสำหรับพร็อกซี API ที่มีชื่อไม่ได้ขึ้นต้นด้วย "m":
filter=(apiproxy not like 'm%')
แสดงเมตริกสำหรับการเรียก API ที่มีรหัสสถานะการตอบสนองระหว่าง 400 ถึง 599:
filter=(response_status_code ge 400 and response_status_code le 599)
แสดงเมตริกสำหรับการเรียก API ที่มีรหัสสถานะการตอบสนองเป็น 200 และรหัสการตอบสนองเป้าหมายเป็น 404:
filter=(response_status_code eq 200 and target_response_code eq 404)
แสดงเมตริกสำหรับการเรียก API ที่มีรหัสสถานะการตอบสนอง 500:
filter=(response_status_code eq 500)
แสดงเมตริกสำหรับการเรียก API ที่ไม่ทำให้เกิดข้อผิดพลาด:
filter=(is_error eq 0)
ต่อไปนี้เป็นตัวดำเนินการที่คุณสามารถใช้เพื่อสร้างตัวกรองรายงาน
ผู้ประกอบธุรกิจ | คำอธิบาย |
---|---|
in |
รวมในรายการ |
notin |
ยกเว้นจากรายการ |
eq |
เท่ากับ == |
ne |
ไม่เท่ากับ != |
gt |
มากกว่า > |
lt |
น้อยกว่า < |
ge |
มากกว่าหรือเท่ากับ >= |
le |
น้อยกว่าหรือเท่ากับ <= |
like |
แสดงผลเป็น "จริง" หากรูปแบบสตริงตรงกับรูปแบบที่ระบุ |
not like |
แสดงผลเป็น false ถ้ารูปแบบสตริงตรงกับรูปแบบที่ระบุ |
similar to |
แสดงผลจริงหรือเท็จขึ้นอยู่กับว่ารูปแบบตรงกับสตริงที่ระบุหรือไม่ ซึ่งคล้ายกับ like เว้นแต่ว่าจะตีความรูปแบบโดยใช้คำจำกัดความมาตรฐานของ SQL ของนิพจน์ทั่วไป |
not similar to |
แสดงผล "เท็จ" หรือ "จริง" โดยขึ้นอยู่กับว่ารูปแบบตรงกับสตริงที่ระบุ ซึ่งคล้ายกับ not like เว้นแต่ว่าจะตีความรูปแบบโดยใช้คำจำกัดความมาตรฐานของ SQL ของนิพจน์ทั่วไป |
and |
ให้คุณใช้ตรรกะ "และ" เพื่อรวมนิพจน์ตัวกรองมากกว่า 1 รายการ ตัวกรองมีข้อมูลที่ตรงตามเงื่อนไขทั้งหมด |
or |
ให้คุณใช้ตรรกะ "หรือ" เพื่อประเมินนิพจน์ตัวกรองที่เป็นไปได้แบบต่างๆ ตัวกรองมีข้อมูลที่ตรงกับเงื่อนไขอย่างน้อย 1 รายการ |