การอ้างอิงเมตริก มิติข้อมูล และตัวกรองของ Analytics

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

หัวข้อนี้เป็นข้อมูลอ้างอิงสําหรับเมตริก มิติข้อมูล และตัวกรองของข้อมูลวิเคราะห์ ดูบริบทเพิ่มเติมเกี่ยวกับการใช้ข้อมูลเหล่านี้ได้ที่ภาพรวมการวิเคราะห์ API

หัวข้อนี้แสดงชื่อเมตริกและมิติข้อมูลตามที่ปรากฏใน UI และตามที่คุณต้องใช้ในการเรียก API

เมตริก

ต่อไปนี้คือเมตริก API ที่คุณเรียกข้อมูลได้ในรายงานที่กําหนดเองและการเรียก API การจัดการ

ชื่อรายงานที่กำหนดเอง ชื่อที่จะใช้ใน Management API ฟังก์ชัน คำอธิบาย
ธุรกรรมต่อวินาทีโดยเฉลี่ย tps ไม่มี

จำนวนธุรกรรมโดยเฉลี่ย ซึ่งหมายถึงคำขอพร็อกซี API ต่อวินาที โปรดทราบว่าหากคุณมีจํานวนธุรกรรมค่อนข้างน้อยในช่วงระยะเวลาหนึ่ง จํานวนธุรกรรมเฉลี่ยต่อวินาทีอาจเป็น 0 ในรายงานที่กําหนดเองของ UI หากจํานวนดังกล่าวมีค่าน้อยกว่าทศนิยม 2 ตําแหน่ง

ไวยากรณ์ API: tps

พบแคช cache_hit รวม

จำนวนคำขอ API ที่สำเร็จซึ่งใช้แคชการตอบกลับแทน การตอบกลับจากบริการเป้าหมาย

ไวยากรณ์ API: sum(cache_hit)

จำนวนองค์ประกอบของแคช L1 ax_cache_l1_count ค่าเฉลี่ย ค่าต่ำสุด ค่าสูงสุด

แสดงผลจำนวนองค์ประกอบในแคช L1 (ในหน่วยความจำ) ต่อธุรกรรมในช่วงระยะเวลาที่กำหนด ตัวอย่างเช่น หากคุณเลือก max เป็นระยะเวลา 1 วัน และ ภายในวันนั้น จำนวนองค์ประกอบสูงสุดในแคชคือ 12 สำหรับธุรกรรมหนึ่งๆ จำนวนที่นับจะเป็น 12 สำหรับ avg หากมีธุรกรรม 3 รายการในช่วงระยะเวลาที่คุณกําลังค้นหา และจำนวนแคชของธุรกรรมเหล่านั้นคือ 5, 6 และ 7 ค่าเฉลี่ยจะเป็น 6 แคช L1 เป็นแคชในหน่วยความจำซึ่งแตกต่างจากแคชฐานข้อมูล L2 ตามที่อธิบายไว้ในส่วนประกอบภายในของแคช

ไวยากรณ์ API: avg(ax_cache_l1_count)

ข้อผิดพลาดเกี่ยวกับนโยบาย policy_error รวม

จำนวนข้อผิดพลาดเกี่ยวกับนโยบายทั้งหมดในช่วงระยะเวลาที่ระบุ

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

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

มิติข้อมูลชื่อนโยบายเมื่อเกิดข้อผิดพลาด (ax_execution_fault_policy_name) มีประโยชน์สำหรับ การจัดกลุ่มข้อผิดพลาดของนโยบายตามชื่อนโยบาย

ความล้มเหลวของเป้าหมาย (เช่น 404 หรือ 503) ไม่ถือเป็นความล้มเหลวของนโยบาย การตอบกลับเหล่านั้น จะนับเป็นการล้มเหลวของพร็อกซี API (is_error)

ไวยากรณ์ API: sum(policy_error)

ข้อผิดพลาดของพร็อกซี is_error รวม

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

มิติข้อมูลพร็อกซี (apiproxy) มีประโยชน์ในการจัดกลุ่มความล้มเหลวของพร็อกซี API ตามพร็อกซี

ไวยากรณ์ API: sum(is_error)

เวลาในการตอบสนองของการประมวลผลคำขอ request_processing_latency ค่าเฉลี่ย ค่าต่ำสุด ค่าสูงสุด

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

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

ไวยากรณ์ API: max(request_processing_latency)

ขนาดคำขอ request_size sum, avg, min, max

ขนาดของเพย์โหลดคำขอที่ Edge ได้รับในหน่วยไบต์

ไวยากรณ์ API: avg(request_size)

แคชการตอบกลับที่ดำเนินการ ax_cache_executed รวม

จำนวนครั้งทั้งหมดที่มีการดำเนินการตามนโยบายแคชการตอบกลับในช่วงระยะเวลาที่กำหนด

เนื่องจากนโยบายแคชการตอบกลับแนบอยู่ใน 2 ที่ในพร็อกซี API (ครั้งหนึ่งในคำขอและอีกครั้งในการตอบกลับ) โดยปกติแล้วนโยบายนี้จะดำเนินการ 2 ครั้งในการเรียก API การ "รับ" จากแคชและ "วาง" ในแคชจะนับเป็นการดำเนินการอย่างละ 1 ครั้ง

อย่างไรก็ตาม การดำเนินการแคชการตอบกลับจะเป็น 0 หากองค์ประกอบ <SkipCacheLookup> ในนโยบายประเมินเป็นจริง (ในคำขอ) และเป็น 0 หากองค์ประกอบ <SkipCachePopulation> ในนโยบายประเมินเป็นจริง (ในการตอบกลับ)

ในเครื่องมือติดตาม คุณสามารถคลิกไอคอนแคชการตอบกลับในการเรียก API ที่ดำเนินการแล้ว และดู responsecache.executed ตัวแปรโฟลว์เพื่อ ดูว่ามีการดำเนินการแคชหรือไม่ (ค่า 1)

ไวยากรณ์ API: sum(ax_cache_executed)

เวลาในการตอบสนองของการประมวลผล response_processing_latency ค่าเฉลี่ย ค่าต่ำสุด ค่าสูงสุด

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

คุณสามารถตรวจสอบเวลาในการตอบสนองของการประมวลผลการตอบกลับตามพร็อกซี API ภูมิภาค และอื่นๆ ได้โดยใช้มิติข้อมูลต่างๆ

ไวยากรณ์ API: min(response_processing_latency)

ขนาดการตอบกลับ response_size sum, avg, min, max

ขนาดของเพย์โหลดการตอบกลับที่แสดงผลกับไคลเอ็นต์ในหน่วยไบต์

ไวยากรณ์ API: max(response_size)

ข้อผิดพลาดของเป้าหมาย target_error รวม

จำนวนการตอบกลับ 5xx ทั้งหมดจากบริการเป้าหมาย ข้อผิดพลาดเหล่านี้เป็นข้อผิดพลาดของบริการเป้าหมาย ที่ไม่ได้เกิดจาก Apigee

ไวยากรณ์ API: sum(target_error)

เวลาตอบกลับตามเป้าหมาย target_response_time sum, avg, min, max

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

โปรดทราบว่าหากการเรียก API แสดงการตอบกลับจากแคช (เช่น ใช้นโยบายแคชการตอบกลับ ) การเรียกจะไม่ไปถึงบริการเป้าหมาย และระบบจะไม่บันทึกเมตริกเวลาในการตอบกลับของเป้าหมาย

ไวยากรณ์ API: avg(target_response_time)

เวลารวมในการตอบสนอง total_response_time sum, avg, min, max

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

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

ไวยากรณ์ API: avg(total_response_time)

การจราจร message_count รวม

จำนวนการเรียก API ทั้งหมดที่ Edge ประมวลผลในช่วงระยะเวลาที่ระบุ

ใช้มิติข้อมูลเพื่อจัดกลุ่มจํานวนการเข้าชมในลักษณะที่มีความหมายมากที่สุดสําหรับคุณ

ไวยากรณ์ API: sum(message_count)

ขนาด

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

ต่อไปนี้คือมิติข้อมูลที่ 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

คีย์ที่มีค่าแคชการตอบกลับที่เข้าถึง ดูข้อมูลเพิ่มเติมเกี่ยวกับ วิธีสร้างคีย์สำหรับแคชการตอบกลับได้ที่นโยบายแคชการตอบกลับ

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

ชื่อแคช ax_cache_name

ชื่อของแคชที่มีคีย์/ค่าที่ใช้นโยบายแคชการตอบกลับ โดยมีคำนำหน้าเป็น orgName__envName__ เช่น หากองค์กรคือ "foo" สภาพแวดล้อมคือ "test" และชื่อแคชคือ "myCache" ax_cache_name จะเป็น foo__test__myCache

ในเครื่องมือติดตาม เมื่อเลือกนโยบายแคชการตอบกลับ คุณจะเห็นค่านี้ใน responsecache.cachename ตัวแปรโฟลว์

แหล่งที่มาของแคช ax_cache_source

ระดับแคช ("L1" ในหน่วยความจำหรือฐานข้อมูล "L2") ที่ดึงแคชการตอบกลับ มิติข้อมูลนี้ยังแสดง "CACHE_MISS" เมื่อมีการส่งการตอบกลับจาก เป้าหมายแทนที่จะเป็นแคช (และระบบรีเฟรชแคชการตอบกลับด้วยการตอบกลับเป้าหมาย) หรือเมื่อคีย์แคชในคำขอไม่ถูกต้อง คีย์แคชมีขนาดได้ไม่เกิน 2 KB

ในเครื่องมือติดตาม เมื่อเลือกนโยบายแคชการตอบกลับ คุณจะเห็นค่านี้ใน responsecache.cachesource ตัวแปรโฟลว์

ดูข้อมูลเพิ่มเติมเกี่ยวกับระดับแคชได้ที่รายละเอียดภายในของแคช

รหัสลูกค้า 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

รหัสข้อบกพร่องของข้อผิดพลาด เช่น messaging.adaptors.http.flow.GatewayTimeout

ชื่อโฟลว์เมื่อเกิดข้อผิดพลาด ax_execution_fault
  _flow_name

โฟลว์ที่มีชื่อในพร็อกซี API ที่ทำให้เกิดข้อผิดพลาด เช่น "PreFlow" "PostFlow" หรือชื่อของโฟลว์แบบมีเงื่อนไขที่คุณสร้าง

โปรดทราบว่าชื่อเต็มที่จะใช้ใน Management API คือ ax_execution_fault_flow_name โดยไม่มีการขึ้นบรรทัดใหม่

หากไม่มีข้อผิดพลาด คุณจะเห็นค่า "(not set)"

ทรัพยากรโฟลว์ flow_resource ใช้สำหรับ Apigee เท่านั้น ดูข้อมูลเพิ่มเติมได้ที่โพสต์ชุมชนนี้
Flow State on Error ax_execution_fault
  _flow_state

ชื่อของสถานะโฟลว์พร็อกซี API ที่ทำให้เกิดข้อผิดพลาด เช่น "PROXY_REQ_FLOW" หรือ "TARGET_RESP_FLOW"

โปรดทราบว่าชื่อเต็มที่จะใช้ใน Management API คือ ax_execution_fault_flow_state โดยไม่มีการขึ้นบรรทัดใหม่

รหัสโฟลว์ของเกตเวย์ gateway_flow_id เมื่อการเรียก API ผ่าน Edge การเรียกแต่ละครั้งจะมีรหัสโฟลว์เกตเวย์ของตัวเอง ตัวอย่าง: rrt329ea-12575-114653952-1. รหัสโฟลว์เกตเวย์มีประโยชน์ในการแยกความแตกต่างของเมตริกใน สถานการณ์ที่มี TPS สูง ซึ่งมิติข้อมูลอื่นๆ เช่น องค์กร สภาพแวดล้อม และการประทับเวลา จะเหมือนกันในการเรียกใช้
องค์กร องค์กร องค์กร Edge ที่มีการทำให้พร็อกซี API ใช้งานได้
ชื่อนโยบายเมื่อเกิดข้อผิดพลาด ax_execution_fault
  _policy_name

ชื่อของนโยบายที่ทำให้เกิดข้อผิดพลาดและทำให้การเรียก API ล้มเหลว

โปรดทราบว่าชื่อเต็มที่จะใช้ใน Management API คือ ax_execution_fault_policy_name โดยไม่มีการขึ้นบรรทัดใหม่

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

พร็อกซี apiproxy ชื่อเครื่อง (ไม่ใช่ชื่อที่แสดง) ของพร็อกซี API
เส้นทางฐานของพร็อกซี proxy_basepath

BasePath ที่กำหนดค่าใน ProxyEndpoint ของพร็อกซี API เส้นทางฐานไม่รวมส่วนโดเมนและพอร์ตของ URL พร็อกซี API ตัวอย่างเช่น หาก URL ฐานของพร็อกซี API คือ https://apigeedocs-test.apigee.net/releasenotes/ เส้นทางฐานคือ /releasenotes

ระบบจะจัดเก็บค่าไว้ในproxy.basepath ตัวแปรโฟลว์ด้วย

คำต่อท้ายเส้นทางพร็อกซี proxy_pathsuffix

เส้นทางทรัพยากรที่เพิ่มลงในเส้นทางฐานของพร็อกซี API ตัวอย่างเช่น หาก URL ฐานของพร็อกซี API คือ https://apigeedocs-test.apigee.net/hello/ และมีการเรียกไปยัง https://apigeedocs-test.apigee.net/hello/json คำต่อท้ายเส้นทางจะเป็น /json

หากไม่ได้ใช้ pathsuffix ค่าจะเป็นค่าว่าง

ระบบจะจัดเก็บค่าไว้ในproxy.pathsuffix ตัวแปรโฟลว์ด้วย

การแก้ไขพร็อกซี apiproxy_revision หมายเลขการแก้ไขของพร็อกซี API ที่จัดการการเรียก API ซึ่งไม่จำเป็นต้องหมายถึงพร็อกซี API เวอร์ชันล่าสุด หากพร็อกซี API มีการแก้ไข 10 รายการ การแก้ไขที่ 8 อาจใช้งานอยู่ในขณะนี้ นอกจากนี้ API อาจมีการแก้ไขหลายรายการที่ทําการติดตั้งใช้งานได้ ตราบใดที่การแก้ไขมีเส้นทางฐานที่แตกต่างกัน ดังที่อธิบายไว้ในการติดตั้งใช้งานพร็อกซีใน UI
IP ไคลเอ็นต์ที่แก้ไขแล้ว ax_resolved_client_ip

มีที่อยู่ IP ของไคลเอ็นต์ต้นทาง ค่าของมิติข้อมูล ax_resolved_client_ip คำนวณจากค่าในมิติข้อมูล ax_true_client_ip และ x_forwarded_for_ip

โปรดทราบว่าเมื่อใช้ผลิตภัณฑ์การกำหนดเส้นทาง เช่น Akamai เพื่อบันทึกที่อยู่ IP จริงของไคลเอ็นต์ ระบบจะส่ง IP ของไคลเอ็นต์ไปยัง Edge ในส่วนหัว HTTP True-Client-IP ซึ่งจะ ใช้เพื่อตั้งค่ามิติข้อมูล ax_true_client_ip

ค่าของมิติข้อมูล ax_resolved_client_ip มีวิธีคำนวณดังนี้

  1. หาก ax_true_client_ip ไม่ใช่ค่า Null และไม่มีที่อยู่ IP ในพื้นที่ ให้ตั้งค่า ax_resolved_client_ip เป็น ax_true_client_ip
  2. หรือตั้งค่า ax_resolved_client_ip เป็นที่อยู่ IP แรกที่ไม่ใช่ที่อยู่ IP ในเครื่องใน x_forwarded_for_ip
  3. หากทั้ง ax_true_client_ip และ x_forwarded_for_ip มี เฉพาะที่อยู่ IP ภายใน ให้ตั้งค่า ax_resolved_client_ip เป็น ที่อยู่ IP ภายในแรกใน x_forwarded_for_ip
  4. หากทั้ง ax_true_client_ip และ x_forwarded_for_ip เป็นค่าว่าง ให้ตั้งค่า ax_resolved_client_ip เป็น (not set)
  5. หาก ax_true_client_ip เป็นที่อยู่ IP ภายในและ x_forwarded_for_ip เป็นค่าว่าง ให้ตั้งค่า ax_resolved_client_ip เป็น (not set)
รหัสสถานะการตอบกลับ 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 ร่วมกับตระกูลระบบปฏิบัติการ (ax_ua_os_family) จะมีประโยชน์ในการดูเวอร์ชันของระบบปฏิบัติการ

IP ไคลเอ็นต์ของพร็อกซี proxy_client_ip

ที่อยู่ IP ของไคลเอ็นต์ที่เรียกใช้ ซึ่งจัดเก็บไว้ในproxy.client.ip ตัวแปรโฟลว์ ซึ่งมักจะเป็นX-Forwarded-Forที่อยู่ของการโทรขาเข้า ซึ่งเป็นที่อยู่ IP ที่ Edge ได้รับจากการแฮนด์เชค TCP ภายนอกครั้งล่าสุด ซึ่งอาจเป็นไคลเอ็นต์ที่เรียกใช้หรือตัวจัดสรรภาระงาน เมื่อมี IP หลายรายการในส่วนหัว X-Forwarded-For นี่คือ IP สุดท้ายที่แสดง

IP ไคลเอ็นต์ที่อ้างอิง ax_true_client_ip

เมื่อใช้ผลิตภัณฑ์การกำหนดเส้นทาง เช่น Akamai เพื่อบันทึกที่อยู่ IP จริงของไคลเอ็นต์ ระบบจะส่ง IP ของไคลเอ็นต์ไปยัง Edge ในส่วนหัว HTTP True-Client-IP มิติข้อมูลนี้ จะบันทึก IP จริงของไคลเอ็นต์จากส่วนหัวนั้น

หากต้องการระบุที่อยู่ IP ของไคลเอ็นต์เดิมที่เข้าถึงผ่านมิติข้อมูล ax_resolved_client_ip Edge จะใช้มิติข้อมูล ax_true_client_ip และ x_forwarded_for_ip

เส้นทางคำขอ request_path

เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย โดยไม่รวมพารามิเตอร์การค้นหา

ตัวอย่างเช่น เป้าหมายตัวอย่างของ Apigee http://mocktarget.apigee.net มีทรัพยากรหลายรายการ รวมถึง /user ซึ่งแสดงผลคำทักทาย ไม่ว่าพร็อกซี API จะเรียกใช้ http://mocktarget.apigee.net/user อย่างไร request_path คือ /user

URI คำขอ request_uri

เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย รวมถึงพารามิเตอร์การค้นหา

ตัวอย่างเช่น เป้าหมายตัวอย่างของ Apigee http://mocktarget.apigee.net มีทรัพยากรหลายรายการ รวมถึงทรัพยากร /user?user={name} และพารามิเตอร์การค้นหา เพื่อแสดงคำทักทายที่กำหนดเองสำหรับชื่อที่ระบุ ไม่ว่าพร็อกซี API จะเรียกใช้ http://mocktarget.apigee.net/user?user=Dude อย่างไร request_uri จะเป็น /user?user=Dude

คำกริยาของคำขอ request_verb คำกริยาของคำขอ HTTP ในคำขอ API เช่น GET, POST, PUT, DELETE
User Agent useragent

ชื่อของ User Agent หรือซอฟต์แวร์เอเจนต์ที่ใช้ในการเรียก API ตัวอย่าง

  • Pixel XL โทรผ่าน Chrome: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
  • iPad ที่โทรผ่าน Chrome: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
  • cURL จากเทอร์มินัล: curl/7.51.0
ตระกูล User Agent ax_ua_agent_family ตระกูลของ User-Agent เช่น "Chrome Mobile" หรือ "cURL"
ประเภท User Agent ax_ua_agent_type ประเภท User Agent เช่น "เบราว์เซอร์" "เบราว์เซอร์บนอุปกรณ์เคลื่อนที่" "ไลบรารี" และอื่นๆ
เวอร์ชันของ User Agent ax_ua_agent_version

เวอร์ชันของ User-Agent

การใช้เป็นมิติข้อมูล "เจาะลึก" ที่ 2 กับตระกูล User Agent (ax_ua_agent_family) จะมีประโยชน์ในการดูเวอร์ชันของตระกูล Agent

ขาออก/เป้าหมาย
เส้นทางฐานเป้าหมาย target_basepath

เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย โดยไม่รวมพารามิเตอร์การค้นหา ที่กำหนดไว้ใน <TargetEndpoint> ของพร็อกซี

ตัวอย่างเช่น สมมติว่าพร็อกซี API เรียกเป้าหมายต่อไปนี้

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

ในตัวอย่างนี้ target_basepath คือ /user

หากเป้าหมายเป็นดังนี้

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net</URL>
</HTTPTargetConnection>

target_basepath จะเป็น null

ในเครื่องมือติดตาม เมื่อคุณ เลือกไอคอน AX ที่ส่วนท้ายของแผนภาพโฟลว์ target.basepath ตัวแปรโฟลว์จะแมปกับ มิติข้อมูล target_basepath

โฮสต์เป้าหมาย 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 Proxy

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

ในตัวอย่างนี้ target_url คือ http://mocktarget.apigee.net/user?user=Dude

โปรดทราบว่าคุณยังลบล้าง URL ในระหว่างการประมวลผลพร็อกซี API ได้ด้วยtarget.url ตัวแปรโฟลว์

ในการเชื่อมต่อพร็อกซี แบบลูกโซ่และเมื่อใช้เป้าหมายสคริปต์ (Node.js) target_url ในพร็อกซีที่เรียกใช้จะเป็นค่าว่าง

X Forwarded For x_forwarded_for_ip

รายการที่อยู่ IP ในส่วนหัว X-Forwarded-For

หากต้องการระบุที่อยู่ IP ของไคลเอ็นต์เดิมที่เข้าถึงผ่านมิติข้อมูล ax_resolved_client_ip Edge จะใช้มิติข้อมูล ax_true_client_ip และ x_forwarded_for_ip

เวลา
วันในสัปดาห์ ax_day_of_week อักษรย่อ 3 ตัวของวันในสัปดาห์ที่มีการเรียก API เช่น จันทร์ อังคาร พุธ
เดือน ax_month_of_year เดือนที่เป็นตัวเลขที่มีการเรียก API เช่น "03" สำหรับเดือนมีนาคม
เวลา ax_hour_of_day

อิงตามนาฬิกาแบบ 24 ชั่วโมง ชั่วโมง 2 หลักที่มีการเรียก API ตัวอย่างเช่น การเรียก API ที่ดำเนินการในชั่วโมงระหว่าง 22:00 น. ถึง 23:00 น. ax_hour_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 Flag ที่ระบุว่าจะไม่สนใจข้อความที่เกี่ยวข้องกับการสร้างรายได้หรือไม่ ตั้งค่าเป็น false สำหรับองค์กรที่สร้างรายได้ทั้งหมด
สถานะธุรกรรมของ Mint x_apigee_mint_tx_status สถานะของคำขอสร้างรายได้ เช่น สำเร็จ ไม่สำเร็จ ไม่ถูกต้อง หรือไม่มี

ตัวกรอง

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

แสดงเมตริกสำหรับพร็อกซี API ที่มีชื่อว่า books หรือ music

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 แสดงค่าเป็นเท็จหากรูปแบบสตริงตรงกับรูปแบบที่ระบุ
similar to แสดงผลเป็นจริงหรือเท็จขึ้นอยู่กับว่ารูปแบบตรงกับสตริงที่ระบุหรือไม่ ซึ่งคล้ายกับ like ยกเว้นว่าจะตีความรูปแบบโดยใช้คําจํากัดความของนิพจน์ทั่วไปตามมาตรฐาน SQL
not similar to แสดงผลเป็นเท็จหรือจริงขึ้นอยู่กับว่ารูปแบบตรงกับสตริงที่ระบุหรือไม่ ซึ่งคล้ายกับ not like แต่จะตีความรูปแบบโดยใช้คำจำกัดความของนิพจน์ทั่วไปตามมาตรฐาน SQL
and ให้คุณใช้ตรรกะ "และ" เพื่อรวมนิพจน์ตัวกรองมากกว่า 1 รายการ ตัวกรอง รวมข้อมูลที่ตรงกับเงื่อนไขทั้งหมด
or ช่วยให้คุณใช้ตรรกะ "หรือ" เพื่อประเมินนิพจน์ตัวกรองที่เป็นไปได้ต่างๆ ตัวกรอง รวมข้อมูลที่ตรงกับเงื่อนไขอย่างน้อย 1 ข้อ