PerformanceTrace interface

อินเทอร์เฟซที่แสดงถึง Trace

ลายเซ็น:

export interface PerformanceTrace

เมธอด

วิธีการ คำอธิบาย
getAttribute(attr) ดึงค่าที่มีการตั้งค่าแอตทริบิวต์ที่กำหนดเอง
getAttributes() แสดงผลการแมปแอตทริบิวต์ที่กำหนดเองทั้งหมดของอินสแตนซ์การติดตาม
getMetric(metricName) แสดงผลค่าของเมตริกที่กำหนดเองตามชื่อนั้น หากไม่มีเมตริกที่กําหนดเองชื่อนั้นอยู่จะแสดงผลเป็น 0
incrementMetric(metricName, จำนวน) เพิ่มค่าของเมตริกที่กำหนดเอง หากไม่มีเมตริกที่กําหนดเองชื่อที่ระบุ ระบบจะสร้างเมตริกที่มีชื่อนั้นและค่าเท่ากับตัวเลขที่ระบุ ระบบจะแบ่งค่าลงเป็นจำนวนเต็ม
putAttribute(attr, value) ตั้งค่าแอตทริบิวต์ที่กำหนดเองของการติดตามเป็นค่าที่ต้องการ
putMetric(metricName, จำนวน) ตั้งค่าเมตริกที่กำหนดเองที่ระบุเป็นจำนวนที่ระบุ ไม่ว่าจะมีเมตริกที่มีชื่อนั้นอยู่แล้วในอินสแตนซ์การติดตามหรือไม่ก็ตาม ระบบจะแบ่งค่าลงเป็นจำนวนเต็ม
record(startTime, ระยะเวลา, ตัวเลือก) บันทึกการติดตามจากพารามิเตอร์ที่ระบุ ซึ่งช่วยให้คุณใช้การติดตามได้โดยตรงโดยไม่จำเป็นต้องเริ่ม/หยุด วิธีนี้มีประโยชน์สําหรับกรณีการใช้งานการติดตาม (เช่น ในกรณีที่บันทึกระยะเวลาก่อนที่จะโหลด Performance SDK)
removeAttribute(attr) นำแอตทริบิวต์ที่กำหนดเองที่ระบุออกจากอินสแตนซ์การติดตาม
start() เริ่มต้นช่วงเวลาสำหรับอินสแตนซ์การติดตาม
stop() หยุดช่วงเวลาของอินสแตนซ์การติดตามและบันทึกข้อมูลของอินสแตนซ์

PerformanceTrace.getAttribute()

ดึงค่าที่มีการตั้งค่าแอตทริบิวต์ที่กำหนดเอง

ลายเซ็น:

getAttribute(attr: string): string | undefined;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
attr สตริง ชื่อของแอตทริบิวต์ที่กำหนดเอง

การคืนสินค้า:

สตริง | ไม่ได้กำหนด

PerformanceTrace.getAttributes()

แสดงผลการแมปแอตทริบิวต์ที่กำหนดเองทั้งหมดของอินสแตนซ์การติดตาม

ลายเซ็น:

getAttributes(): {
        [key: string]: string;
    };

การคืนสินค้า:

{ [คีย์: สตริง]: สตริง; }

PerformanceTrace.getMetric()

แสดงผลค่าของเมตริกที่กำหนดเองตามชื่อนั้น หากไม่มีเมตริกที่กําหนดเองชื่อนั้นอยู่จะแสดงผลเป็น 0

ลายเซ็น:

getMetric(metricName: string): number;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ชื่อเมตริก สตริง ชื่อของเมตริกที่กำหนดเอง

การคืนสินค้า:

ตัวเลข

PerformanceTrace.incrementMetric()

เพิ่มค่าของเมตริกที่กำหนดเอง หากไม่มีเมตริกที่กําหนดเองชื่อที่ระบุ ระบบจะสร้างเมตริกที่มีชื่อนั้นและค่าเท่ากับตัวเลขที่ระบุ ระบบจะแบ่งค่าลงเป็นจำนวนเต็ม

ลายเซ็น:

incrementMetric(metricName: string, num?: number): void;

พารามิเตอร์

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

การคืนสินค้า:

เป็นโมฆะ

PerformanceTrace.putAttribute()

ตั้งค่าแอตทริบิวต์ที่กำหนดเองของการติดตามเป็นค่าที่ต้องการ

ลายเซ็น:

putAttribute(attr: string, value: string): void;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
attr สตริง ชื่อของแอตทริบิวต์ที่กำหนดเอง
value สตริง ค่าของแอตทริบิวต์ที่กำหนดเอง

การคืนสินค้า:

เป็นโมฆะ

PerformanceTrace.putMetric()

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

ลายเซ็น:

putMetric(metricName: string, num: number): void;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ชื่อเมตริก สตริง ชื่อของเมตริกที่กำหนดเอง
จำนวน ตัวเลข ค่าของเมตริกที่กำหนดเอง

การคืนสินค้า:

เป็นโมฆะ

PerformanceTrace.record()

บันทึกการติดตามจากพารามิเตอร์ที่ระบุ ซึ่งช่วยให้คุณใช้การติดตามได้โดยตรงโดยไม่จำเป็นต้องเริ่ม/หยุด วิธีนี้มีประโยชน์ในกรณีการใช้งานการติดตาม (เช่น ในกรณีที่บันทึกระยะเวลาก่อนที่จะโหลด Performance SDK)

ลายเซ็น:

record(startTime: number, duration: number, options?: {
        metrics?: {
            [key: string]: number;
        };
        attributes?: {
            [key: string]: string;
        };
    }): void;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
startTime ตัวเลข ติดตามเวลาเริ่มต้นตั้งแต่ Epoch ในหน่วยมิลลิวินาที
ระยะเวลา ตัวเลข ระยะเวลาของการติดตามในหน่วยมิลลิวินาที
ตัวเลือก { เมตริก: { [key: string]: number; }; ?: { [คีย์: สตริง]: สตริง; }; } ออบเจ็กต์ที่สามารถเลือกเก็บแผนที่ของเมตริกที่กำหนดเองและแอตทริบิวต์ที่กำหนดเองได้

การคืนสินค้า:

เป็นโมฆะ

PerformanceTrace.removeAttribute()

นำแอตทริบิวต์ที่กำหนดเองที่ระบุออกจากอินสแตนซ์การติดตาม

ลายเซ็น:

removeAttribute(attr: string): void;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
attr สตริง ชื่อของแอตทริบิวต์ที่กำหนดเอง

การคืนสินค้า:

เป็นโมฆะ

PerformanceTrace.start()

เริ่มต้นช่วงเวลาสำหรับอินสแตนซ์การติดตาม

ลายเซ็น:

start(): void;

การคืนสินค้า:

เป็นโมฆะ

PerformanceTrace.stop()

หยุดช่วงเวลาของอินสแตนซ์การติดตามและบันทึกข้อมูลของอินสแตนซ์

ลายเซ็น:

stop(): void;

การคืนสินค้า:

เป็นโมฆะ