อินเทอร์เฟซที่แสดงถึง Trace
.
ลายเซ็น:
export interface PerformanceTrace
วิธีการ
วิธี | คำอธิบาย |
---|---|
getAttribute(แอตทริบิวต์) | ดึงค่าที่ตั้งค่าแอตทริบิวต์แบบกำหนดเองไว้ |
รับแอตทริบิวต์() | ส่งคืนแมปของแอตทริบิวต์ที่กำหนดเองทั้งหมดของอินสแตนซ์การติดตาม |
getMetric(ชื่อเมตริก) | ส่งกลับค่าของเมตริกที่กำหนดเองตามชื่อนั้น หากไม่มีเมตริกที่กำหนดเองที่มีชื่อนั้นก็จะคืนค่าเป็นศูนย์ |
ส่วนเพิ่มเมตริก(metricName, num) | เพิ่มมูลค่าให้กับเมตริกที่กำหนดเอง หากไม่มีเมตริกที่กำหนดเองซึ่งมีชื่อที่ระบุ ระบบจะสร้างเมตริกที่มีชื่อนั้นและค่าเท่ากับตัวเลขที่ระบุ ค่าจะถูกปัดลงเป็นจำนวนเต็ม |
putAttribute (แอตทริบิวต์, ค่า) | ตั้งค่าแอตทริบิวต์ที่กำหนดเองของการติดตามเป็นค่าที่แน่นอน |
putMetric(ชื่อเมตริก, หมายเลข) | ตั้งค่าของตัววัดแบบกำหนดเองที่ระบุเป็นตัวเลขที่กำหนด โดยไม่คำนึงว่าตัววัดที่มีชื่อนั้นมีอยู่แล้วในอินสแตนซ์การติดตามหรือไม่ ค่าจะถูกปัดลงเป็นจำนวนเต็ม |
บันทึก (เวลาเริ่มต้น ระยะเวลา ตัวเลือก) | บันทึกการติดตามจากพารามิเตอร์ที่กำหนด นี่เป็นวิธีใช้การติดตามโดยตรงโดยไม่จำเป็นต้องเริ่ม/หยุด สิ่งนี้มีประโยชน์สำหรับกรณีการใช้งานที่ไม่สามารถใช้การติดตามได้โดยตรง (เช่น หากบันทึกระยะเวลาก่อนที่จะโหลด Performance SDK) |
ลบแอตทริบิวต์(attr) | ลบแอ็ตทริบิวต์แบบกำหนดเองที่ระบุออกจากอินสแตนซ์การติดตาม |
เริ่ม() | เริ่มต้นการกำหนดเวลาสำหรับอินสแตนซ์การติดตาม |
หยุด() | หยุดการกำหนดเวลาของอินสแตนซ์การติดตามและบันทึกข้อมูลของอินสแตนซ์ |
PerformanceTrace.getAttribute()
ดึงค่าที่ตั้งค่าแอตทริบิวต์แบบกำหนดเองไว้
ลายเซ็น:
getAttribute(attr: string): string | undefined;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
attr | เชือก | ชื่อของแอตทริบิวต์ที่กำหนดเอง |
ผลตอบแทน:
สตริง | ไม่ได้กำหนด
PerformanceTrace.getAttributes ()
ส่งคืนแมปของแอตทริบิวต์ที่กำหนดเองทั้งหมดของอินสแตนซ์การติดตาม
ลายเซ็น:
getAttributes(): {
[key: string]: string;
};
ผลตอบแทน:
{ [คีย์: สตริง]: สตริง; }
PerformanceTrace.getMetric()
ส่งกลับค่าของเมตริกที่กำหนดเองตามชื่อนั้น หากไม่มีเมตริกที่กำหนดเองซึ่งมีชื่อนั้นก็จะคืนค่าเป็นศูนย์
ลายเซ็น:
getMetric(metricName: string): number;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
metricName | เชือก | ชื่อของเมตริกที่กำหนดเอง |
ผลตอบแทน:
ตัวเลข
PerformanceTrace.increatMetric()
เพิ่มมูลค่าให้กับเมตริกที่กำหนดเอง หากไม่มีเมตริกที่กำหนดเองซึ่งมีชื่อที่ระบุ ระบบจะสร้างเมตริกที่มีชื่อนั้นและค่าเท่ากับตัวเลขที่ระบุ ค่าจะถูกปัดลงเป็นจำนวนเต็ม
ลายเซ็น:
incrementMetric(metricName: string, num?: number): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
metricName | เชือก | ชื่อของเมตริกที่กำหนดเอง |
หมายเลข | ตัวเลข | ตัวเลขที่จะเพิ่มลงในค่าของเมตริกที่กำหนดเอง หากไม่ได้ระบุไว้ ระบบจะใช้ค่าเริ่มต้นเป็นหนึ่ง |
ผลตอบแทน:
เป็นโมฆะ
PerformanceTrace.putAttribute ()
ตั้งค่าแอตทริบิวต์ที่กำหนดเองของการติดตามเป็นค่าที่แน่นอน
ลายเซ็น:
putAttribute(attr: string, value: string): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
attr | เชือก | ชื่อของแอตทริบิวต์ที่กำหนดเอง |
ค่า | เชือก | ค่าของแอตทริบิวต์ที่กำหนดเอง |
ผลตอบแทน:
เป็นโมฆะ
PerformanceTrace.putMetric ()
ตั้งค่าของตัววัดแบบกำหนดเองที่ระบุเป็นตัวเลขที่กำหนด โดยไม่คำนึงว่าตัววัดที่มีชื่อนั้นมีอยู่แล้วในอินสแตนซ์การติดตามหรือไม่ ค่าจะถูกปัดลงเป็นจำนวนเต็ม
ลายเซ็น:
putMetric(metricName: string, num: number): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
metricName | เชือก | ชื่อของเมตริกที่กำหนดเอง |
หมายเลข | ตัวเลข | ค่าของเมตริกที่กำหนดเอง |
ผลตอบแทน:
เป็นโมฆะ
PerformanceTrace.บันทึก ()
บันทึกการติดตามจากพารามิเตอร์ที่กำหนด นี่เป็นวิธีใช้การติดตามโดยตรงโดยไม่จำเป็นต้องเริ่ม/หยุด สิ่งนี้มีประโยชน์สำหรับกรณีการใช้งานที่ไม่สามารถใช้การติดตามได้โดยตรง (เช่น หากบันทึกระยะเวลาก่อนที่จะโหลด Performance SDK)
ลายเซ็น:
record(startTime: number, duration: number, options?: {
metrics?: {
[key: string]: number;
};
attributes?: {
[key: string]: string;
};
}): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
เวลาเริ่มต้น | ตัวเลข | ติดตามเวลาเริ่มต้นตั้งแต่ยุคในหน่วยมิลลิวินาที |
ระยะเวลา | ตัวเลข | ระยะเวลาของการติดตามในหน่วยมิลลิวินาที |
ตัวเลือก | { เมตริก?: { [คีย์: สตริง]: หมายเลข; }; คุณลักษณะ?: { [คีย์: สตริง]: สตริง; }; } | ออบเจ็กต์ที่สามารถเลือกเก็บแผนที่ของเมตริกที่กำหนดเองและแอตทริบิวต์ที่กำหนดเองได้ |
ผลตอบแทน:
เป็นโมฆะ
PerformanceTrace.removeAttribute ()
ลบแอ็ตทริบิวต์แบบกำหนดเองที่ระบุออกจากอินสแตนซ์การติดตาม
ลายเซ็น:
removeAttribute(attr: string): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
attr | เชือก | ชื่อของแอตทริบิวต์ที่กำหนดเอง |
ผลตอบแทน:
เป็นโมฆะ
PerformanceTrace.start()
เริ่มต้นการกำหนดเวลาสำหรับอินสแตนซ์การติดตาม
ลายเซ็น:
start(): void;
ผลตอบแทน:
เป็นโมฆะ
PerformanceTrace.stop()
หยุดการกำหนดเวลาของอินสแตนซ์การติดตามและบันทึกข้อมูลของอินสแตนซ์
ลายเซ็น:
stop(): void;
ผลตอบแทน:
เป็นโมฆะ