PerformanceTrace interface

Giao diện đại diện cho một Trace .

Chữ ký:

export interface PerformanceTrace 

phương pháp

Phương pháp Sự miêu tả
getAttr (attr) Truy xuất giá trị mà thuộc tính tùy chỉnh được đặt thành.
getAttribution() Trả về bản đồ của tất cả các thuộc tính tùy chỉnh của một phiên bản theo dõi.
getMetric(metricName) Trả về giá trị của số liệu tùy chỉnh theo tên đó. Nếu số liệu tùy chỉnh có tên đó không tồn tại thì sẽ trả về 0.
tăngMetric(metricName, num) Thêm vào giá trị của số liệu tùy chỉnh. Nếu chỉ số tùy chỉnh có tên được cung cấp không tồn tại thì nó sẽ tạo một chỉ số có tên đó và giá trị bằng số đã cho. Giá trị sẽ được giảm xuống một số nguyên.
putAttribution (attr, giá trị) Đặt thuộc tính tùy chỉnh của dấu vết thành một giá trị nhất định.
putMetric(metricName, num) Đặt giá trị của số liệu tùy chỉnh được chỉ định thành số đã cho bất kể số liệu có tên đó đã tồn tại trên phiên bản theo dõi hay chưa. Giá trị sẽ được giảm xuống một số nguyên.
bản ghi (thời gian bắt đầu, thời lượng, tùy chọn) Ghi lại dấu vết từ các tham số đã cho. Điều này cung cấp một cách trực tiếp để sử dụng dấu vết mà không cần phải bắt đầu/dừng. Điều này hữu ích cho các trường hợp sử dụng trong đó không thể sử dụng trực tiếp dấu vết (ví dụ: nếu thời lượng được ghi lại trước khi tải SDK hiệu suất).
loại bỏAttr(attr) Loại bỏ thuộc tính tùy chỉnh đã chỉ định khỏi một phiên bản theo dõi.
bắt đầu() Bắt đầu tính thời gian cho phiên bản theo dõi.
dừng lại() Dừng thời gian của phiên bản theo dõi và ghi lại dữ liệu của phiên bản.

PerformanceTrace.getAttribution ()

Truy xuất giá trị mà thuộc tính tùy chỉnh được đặt thành.

Chữ ký:

getAttribute(attr: string): string | undefined;

Thông số

Tham số Kiểu Sự miêu tả
attr sợi dây Tên của thuộc tính tùy chỉnh.

Trả về:

chuỗi | không xác định

PerformanceTrace.getAttribut ()

Trả về bản đồ của tất cả các thuộc tính tùy chỉnh của một phiên bản theo dõi.

Chữ ký:

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

Trả về:

{ [khóa: chuỗi]: chuỗi; }

PerformanceTrace.getMetric()

Trả về giá trị của số liệu tùy chỉnh theo tên đó. Nếu số liệu tùy chỉnh có tên đó không tồn tại thì sẽ trả về 0.

Chữ ký:

getMetric(metricName: string): number;

Thông số

Tham số Kiểu Sự miêu tả
tên số liệu sợi dây Tên của chỉ số tùy chỉnh.

Trả về:

con số

PerformanceTrace.incrementMetric()

Thêm vào giá trị của số liệu tùy chỉnh. Nếu chỉ số tùy chỉnh có tên được cung cấp không tồn tại thì nó sẽ tạo một chỉ số có tên đó và giá trị bằng số đã cho. Giá trị sẽ được giảm xuống một số nguyên.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tên số liệu sợi dây Tên của chỉ số tùy chỉnh.
số con số Số sẽ được thêm vào giá trị của chỉ số tùy chỉnh. Nếu không được cung cấp, nó sẽ sử dụng giá trị mặc định là một.

Trả về:

trống rỗng

PerformanceTrace.putAttribution ()

Đặt thuộc tính tùy chỉnh của dấu vết thành một giá trị nhất định.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
attr sợi dây Tên của thuộc tính tùy chỉnh.
giá trị sợi dây Giá trị của thuộc tính tùy chỉnh.

Trả về:

trống rỗng

PerformanceTrace.putMetric()

Đặt giá trị của số liệu tùy chỉnh được chỉ định thành số đã cho bất kể số liệu có tên đó đã tồn tại trên phiên bản theo dõi hay chưa. Giá trị sẽ được giảm xuống một số nguyên.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tên số liệu sợi dây Tên của chỉ số tùy chỉnh.
số con số Giá trị của chỉ số tùy chỉnh.

Trả về:

trống rỗng

PerformanceTrace.record()

Ghi lại dấu vết từ các tham số đã cho. Điều này cung cấp một cách trực tiếp để sử dụng dấu vết mà không cần phải bắt đầu/dừng. Điều này hữu ích cho các trường hợp sử dụng trong đó không thể sử dụng trực tiếp dấu vết (ví dụ: nếu thời lượng được ghi lại trước khi tải SDK hiệu suất).

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
thời gian bắt đầu con số theo dõi thời gian bắt đầu kể từ kỷ nguyên tính bằng mili giây.
khoảng thời gian con số Thời lượng của dấu vết tính bằng mili giây.
tùy chọn { số liệu?: { [key: string]: số; }; thuộc tính?: { [key: string]: string; }; } Một đối tượng có thể tùy ý chứa bản đồ các số liệu tùy chỉnh và thuộc tính tùy chỉnh.

Trả về:

trống rỗng

PerformanceTrace.removeAttribution ()

Loại bỏ thuộc tính tùy chỉnh đã chỉ định khỏi một phiên bản theo dõi.

Chữ ký:

removeAttribute(attr: string): void;

Thông số

Tham số Kiểu Sự miêu tả
attr sợi dây Tên của thuộc tính tùy chỉnh.

Trả về:

trống rỗng

PerformanceTrace.start()

Bắt đầu tính thời gian cho phiên bản theo dõi.

Chữ ký:

start(): void;

Trả về:

trống rỗng

PerformanceTrace.stop()

Dừng thời gian của phiên bản theo dõi và ghi lại dữ liệu của phiên bản.

Chữ ký:

stop(): void;

Trả về:

trống rỗng