คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่
เอกสารประกอบของ Apigee X info
อะไร
ช่วยให้คุณรวบรวมสถิติของข้อมูลในข้อความ เช่น รหัสผลิตภัณฑ์ ราคา การดำเนินการ REST URL ของไคลเอ็นต์และเป้าหมาย รวมถึงความยาวของข้อความ ข้อมูลอาจมาจากตัวแปรโฟลว์ ที่ Apigee กำหนดไว้ล่วงหน้าหรือตัวแปรที่กำหนดเองที่คุณกำหนด
ระบบจะส่งข้อมูลสถิติไปยังเซิร์ฟเวอร์การวิเคราะห์ ซึ่งจะวิเคราะห์สถิติและ สร้างรายงาน คุณสามารถดูรายงานได้โดยใช้อินเทอร์เฟซผู้ใช้การจัดการของ Edge หรือ Edge API
ตัวอย่าง
ตัวอย่างพื้นฐาน
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="productID" ref="product.id" type="string">999999</Statistic> <Statistic name="price" ref="product.price" type="string">0</Statistic> </Statistics> </StatisticsCollector>
ในตัวอย่างนี้ คุณจะรวบรวมข้อมูลสถิติเกี่ยวกับตัวแปรที่กำหนดเอง 2 รายการ ได้แก่ product.id และ product.price นโยบาย Statistics Collector จะเขียนค่าของตัวแปรทั้ง 2 รายการนี้ไปยังเซิร์ฟเวอร์การวิเคราะห์ในทุกคำขอ
ตัวอย่างนี้ยังกำหนดค่าเริ่มต้นที่ไม่บังคับสำหรับตัวแปรแต่ละรายการ โดยค่าเริ่มต้น ของ product.id คือ 999999 และค่าเริ่มต้น product.price คือ 0 หากตัวแปรไม่ได้กำหนดไว้และคุณไม่ได้ระบุค่าเริ่มต้น ระบบจะไม่บันทึกข้อมูลสำหรับตัวแปรนั้น หากคุณระบุค่าเริ่มต้น ระบบจะบันทึกค่าเริ่มต้นเมื่อตัวแปรไม่ได้กำหนดไว้
หลังจากรวบรวมข้อมูลสถิติแล้ว คุณสามารถใช้อินเทอร์เฟซผู้ใช้การจัดการของ Edge หรือ API เพื่อดึงข้อมูลสถิติได้ เมื่อดึงข้อมูลสถิติ คุณจะอ้างอิงข้อมูลที่รวบรวมไว้สำหรับ ตัวแปรเหล่านี้เป็น productID และ price ตามลำดับ
การเข้าถึงสถิติ
ในตัวอย่างนี้ คุณจะใช้ Edge Management API เพื่อดูข้อมูลสถิติสำหรับการ
รวบรวมที่ชื่อว่า productID คำขอนี้จะสร้างรายงานที่กำหนดเองสำหรับ
รหัสผลิตภัณฑ์โดยอิงตามผลรวมของจำนวนข้อความที่ส่งสำหรับรหัสผลิตภัณฑ์แต่ละรายการในแต่ละ
วัน แทนที่ชื่อองค์กรด้วยตัวแปร {org_name} และ
แทนที่อีเมลและรหัสผ่านของบัญชีใน Apigee Edge ด้วย
email:password
ตั้งค่าพารามิเตอร์ timeRange ให้รวมช่วงเวลาที่รวบรวมข้อมูล
โดยค่าเริ่มต้น คุณจะเข้าถึงข้อมูลที่เก่ากว่า 6 เดือนนับจากวันที่ปัจจุบันไม่ได้ หากต้องการเข้าถึงข้อมูลที่เก่ากว่า 6 เดือน โปรดติดต่อทีมสนับสนุนของ Apigee Edge
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/productID?"select=sum(message_count)&timeRange=1/19/2015%2000:00~6/21/2015%2000:00&timeUnit=day"
-u email:password
ในคำตอบ ฟิลด์ชื่อ จะมีรหัสผลิตภัณฑ์และค่าจะแสดงจำนวนคำขอในแต่ละวัน ดังนี้
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [ {
"name" : "sum(message_count)",
"values" : [ {
"timestamp" : 1353369600000,
"value" : "4.0"
} ]
} ],
"name" : "52"
}, {
"metrics" : [ {
"name" : "sum(message_count)",
"values" : [ {
"timestamp" : 1353369600000,
"value" : "19.0"
} ]
} ],
"name" : "14"
}, ...
} ],
"metaData" : {
"samplingRate" : "100"
}
}การแยกข้อมูลสำหรับการรวบรวม
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ExtractVariables async="false" continueOnError="false" enabled="true" name="GetWeatherData"> <VariablePrefix>weather</VariablePrefix> <XMLPayload> <Namespaces> <Namespace prefix="yweather">http://xml.weather.yahoo.com/ns/rss/1.0</Namespace> </Namespaces> <Variable name="location" type="string"> <XPath>/rss/channel/yweather:location/@city</XPath> </Variable> <Variable name="condition" type="string"> <XPath>/rss/channel/item/yweather:condition/@text</XPath> </Variable> </XMLPayload> </ExtractVariables>
นโยบาย Statistics Collector กำหนดให้จัดเก็บข้อมูลที่รวบรวมไว้ในตัวแปร ตัวแปรเหล่านี้อาจเป็นตัวแปรที่ Apigee กำหนดไว้ล่วงหน้าหรือตัวแปรที่กำหนดเองที่คุณกำหนด
ในตัวอย่างนี้ คุณจะใช้นโยบาย Extract Variables เพื่อแยกข้อมูลจากเพย์โหลด XML ที่มีข้อมูลสภาพอากาศ นโยบายนี้จะทำดังนี้
- แยกชื่อเมืองและเขียนลงในตัวแปรที่ชื่อว่า weather.location
- แยกสภาพอากาศปัจจุบันและเขียนลงในตัวแปรที่ชื่อว่า weather.condition
จากนั้นคุณสามารถใช้นโยบาย Statistics Collector เพื่อรวบรวมข้อมูลเกี่ยวกับตัวแปรได้ดังที่แสดงด้านล่าง
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="weatherLocation" ref="weather.location" type="string"></Statistic> <Statistic name="weatherCondition" ref="weather.condition" type="string"></Statistic> </Statistics> </StatisticsCollector>
ดูบทแนะนำฉบับสมบูรณ์ที่แสดงวิธีแยกข้อมูลจากเพย์โหลด XML สำหรับนโยบาย Statistics Collector ได้ที่วิเคราะห์เนื้อหาข้อความ API โดยใช้การวิเคราะห์ที่กำหนดเอง
เกี่ยวกับนโยบาย Statistics Collector
เมื่อทำงาน นโยบาย Statistics Collector จะบันทึกค่าปัจจุบันของตัวแปรอย่างน้อย 1 รายการ ตัวแปรเหล่านี้อาจเป็นตัวแปรโฟลว์ที่ Apigee กำหนดไว้ล่วงหน้าหรือตัวแปรที่กำหนดเองที่คุณกำหนด ระบบจะเขียนข้อมูลนี้ไปยังเซิร์ฟเวอร์การวิเคราะห์ของ Edge
หากต้องการเข้าถึงข้อมูลสถิติที่นโยบายรวบรวมไว้ ให้ใช้ Edge API หรืออินเทอร์เฟซผู้ใช้การจัดการของ Edge เช่น คุณสามารถใช้อินเทอร์เฟซผู้ใช้การจัดการของ Edge เพื่อสร้างรายงานที่กำหนดเองที่ แสดงข้อมูลที่รวบรวมไว้ในรูปแบบต่างๆ
ดูบทแนะนำฉบับสมบูรณ์โดยใช้นโยบาย Statistics Collector ได้ที่วิเคราะห์เนื้อหาข้อความ API โดยใช้การวิเคราะห์ที่กำหนดเอง
ตำแหน่งที่จะวางนโยบาย
คุณสามารถวางนโยบาย Statistics Collector ไว้ในโฟลว์คำขอหรือการตอบกลับของพร็อกซี API อย่างไรก็ตาม หากคุณวางนโยบาย Statistics Collector หลายรายการไว้ในพร็อกซี นโยบายที่ทำงานเป็นรายการสุดท้าย จะเป็นตัวกำหนดข้อมูลที่จะเขียนไปยังเซิร์ฟเวอร์การวิเคราะห์ และข้อมูลที่นโยบาย Statistics Collector ก่อนหน้านี้เขียนไว้จะสูญหาย
สถานการณ์หนึ่งที่คุณอาจมีนโยบาย Statistics Collector หลายรายการในพร็อกซี API คือ เมื่อคุณมีนโยบายหนึ่งในโฟลว์คำขอหรือการตอบกลับ และอีกนโยบายหนึ่งในตัวจัดการข้อผิดพลาด หากเกิดข้อผิดพลาด ในพร็อกซี API นโยบาย Statistics Collector ในตัวจัดการข้อผิดพลาดจะเป็นตัวกำหนดข้อมูล ที่จะรวบรวม คุณสามารถใช้นโยบาย Statistics Collector นั้นเพื่อบันทึกข้อมูลเกี่ยวกับข้อผิดพลาด หรือเพื่อ บันทึกข้อมูลอื่นๆ ที่คุณคิดว่าจำเป็น นโยบาย Statistics Collector ในตัวจัดการข้อผิดพลาด จะเป็นตัวกำหนดข้อมูลที่จะรวบรวม ไม่ว่านโยบาย Statistics Collector ในคำขอ/การตอบกลับจะทำงานแล้วหรือไม่ก็ตาม
ดูข้อมูลเพิ่มเติมได้ที่ การจัดการ ข้อผิดพลาด
ข้อมูลอ้างอิงองค์ประกอบ
ข้อมูลอ้างอิงองค์ประกอบจะอธิบายองค์ประกอบและแอตทริบิวต์ของนโยบาย Statistics Collector
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <StatisticsCollector async="false" continueOnError="false" enabled="true" name="Statistics-Collector-1"> <DisplayName>Statistics Collector 1</DisplayName> <Statistics> <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic> </Statistics> </StatisticsCollector>
แอตทริบิวต์ <StatisticsCollector>
<StatisticsCollector async="false" continueOnError="false" enabled="true" name="Stats-1">
ตารางต่อไปนี้อธิบายแอตทริบิวต์ทั่วไปในองค์ประกอบระดับบนสุดของนโยบายทั้งหมด
| แอตทริบิวต์ | คำอธิบาย | ค่าเริ่มต้น | การมีบุคคลอยู่ |
|---|---|---|---|
name |
ชื่อภายในของนโยบาย ค่าของแอตทริบิวต์ (ไม่บังคับ) ใช้องค์ประกอบ |
ไม่มี | ต้องระบุ |
continueOnError |
ตั้งค่าเป็น ตั้งค่าเป็น |
เท็จ | ไม่บังคับ |
enabled |
ตั้งค่าเป็น ตั้งค่าเป็น |
จริง | ไม่บังคับ |
async |
แอตทริบิวต์นี้เลิกใช้งานแล้ว |
เท็จ | เลิกใช้ |
<DisplayName> องค์ประกอบ
ใช้เพิ่มเติมจากแอตทริบิวต์ name เพื่อติดป้ายกำกับนโยบายใน
เครื่องมือแก้ไขพร็อกซี UI การจัดการด้วยชื่อที่เป็นภาษาธรรมชาติต่างกัน
<DisplayName>Policy Display Name</DisplayName>
| ค่าเริ่มต้น |
ไม่มี หากไม่ใส่องค์ประกอบนี้ ค่าของแอตทริบิวต์ |
|---|---|
| การมีบุคคลอยู่ | ไม่บังคับ |
| ประเภท | สตริง |
องค์ประกอบ <Statistics>/<Statistic>
<Statistics> <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic> </Statistics>
| แอตทริบิวต์ | คำอธิบาย | ค่าเริ่มต้น | การมีอยู่ |
|---|---|---|---|
| name |
ชื่อที่ใช้เพื่ออ้างอิงข้อมูลที่รวบรวมไว้สำหรับตัวแปรที่ระบุ เมื่อดูข้อมูลการวิเคราะห์ ให้ใช้ชื่อนี้เพื่ออ้างอิงข้อมูลที่รวบรวมไว้เกี่ยวกับตัวแปรที่ระบุโดยแอตทริบิวต์ หากตัวแปรที่ระบุโดย ข้อจำกัดในการตั้งชื่อ ข้อจำกัดในการตั้งชื่อต่อไปนี้มีผลกับตัวแปรการวิเคราะห์ที่กำหนดเอง
|
ไม่มี | ต้องระบุ |
| ref |
ตัวแปรโฟลว์ที่คุณกำลังรวบรวมสถิติ ตัวแปรนี้อาจเป็นตัวแปรโฟลว์ ที่ Apigee กำหนดไว้ล่วงหน้าหรือตัวแปรที่กำหนดเองที่คุณกำหนดไว้ในพร็อกซี API แอตทริบิวต์ ref มักจะอ้างอิงตัวแปรที่กำหนดเองที่กำหนดโดยนโยบาย Extract Variables ดูข้อมูลเพิ่มเติมได้ที่นโยบาย Extract Variables |
ไม่มี | ต้องระบุ |
| type |
ระบุประเภทข้อมูลของตัวแปรที่ระบุโดยแอตทริบิวต์ ref ค่าที่ใช้ได้มีดังนี้: string/integer/float/long/double/boolean สำหรับข้อมูลประเภทสตริง ให้อ้างอิงข้อมูลสถิติเป็น มิติข้อมูล ใน รายงานที่กำหนดเอง สำหรับประเภทข้อมูลตัวเลข (integer/float/long/double) ให้อ้างอิงข้อมูลสถิติในรายงานที่กำหนดเองเป็น มิติข้อมูล หรือ เมตริก ดูข้อมูลเพิ่มเติมได้ที่ จัดการรายงานที่กำหนดเอง คุณจะละเว้นค่าของ type ได้ก็ต่อเมื่อ ref อ้างอิงตัวแปรโฟลว์ Apigee ที่กำหนดไว้ล่วงหน้า หรือมีการประกาศประเภทในเพย์โหลด XML ของนโยบาย Extract Variables |
สตริง | ไม่บังคับ |
ข้อมูลอ้างอิงข้อผิดพลาด
ส่วนนี้จะอธิบายข้อความแสดงข้อผิดพลาดและตัวแปรของขั้นตอนที่ตั้งค่าไว้เมื่อนโยบายนี้ทริกเกอร์ข้อผิดพลาด ข้อมูลนี้สำคัญต่อการพัฒนากฎข้อบกพร่องสําหรับพร็อกซี ดูข้อมูลเพิ่มเติมได้ที่สิ่งที่คุณต้องทราบเกี่ยวกับข้อผิดพลาดด้านนโยบายและการจัดการข้อบกพร่อง
ข้อผิดพลาดเกี่ยวกับรันไทม์
ไม่มี
ข้อผิดพลาดในการทำให้ใช้งานได้
| ชื่อข้อผิดพลาด | สาเหตุ | แก้ไข |
|---|---|---|
UnsupportedDatatype |
หากระบบไม่รองรับประเภทตัวแปรที่ระบุโดยแอตทริบิวต์ ref ในองค์ประกอบ <Statistic> ของนโยบายเครื่องมือรวบรวมสถิติ การติดตั้งใช้งานพร็อกซี API จะดำเนินการไม่สำเร็จ ประเภทข้อมูลที่รองรับ ได้แก่ string, integer,
float, long, double และ boolean |
build |
InvalidName |
หากชื่อที่ใช้อ้างอิงข้อมูลที่รวบรวมสําหรับตัวแปรที่ระบุซึ่งกําหนดภายในองค์ประกอบ <Statistic> ของนโยบายเครื่องมือรวบรวมสถิติขัดแย้งกับตัวแปรที่ระบบกําหนด การติดตั้งใช้งานพร็อกซี API จะดำเนินการไม่สําเร็จ ตัวแปรที่ระบบกําหนดซึ่งเป็นที่รู้จัก ได้แก่ organization และ environment |
build |
DatatypeMissing |
หากไม่มีประเภทตัวแปรที่ระบุโดยแอตทริบิวต์ ref ในองค์ประกอบ <Statistic> ของนโยบายเครื่องมือรวบรวมสถิติ การติดตั้งใช้งานพร็อกซี API จะดำเนินการไม่สำเร็จ |
build |
ตัวแปรข้อบกพร่อง
ไม่มี
สคีมา
ประเภทนโยบายแต่ละประเภทกำหนดโดยสคีมา XML (.xsd) คุณสามารถดูสคีมานโยบาย
ได้ใน GitHub
หัวข้อที่เกี่ยวข้อง
ดูข้อมูลเพิ่มเติมได้ที่