PerformanceTrace interface

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

Chữ ký:

export interface PerformanceTrace

Phương thức

Phương thức Mô tả
getAttribute(attr) Truy xuất giá trị mà thuộc tính tuỳ chỉnh đã được đặt.
getAttributes() Trả về bản đồ chứa tất cả thuộc tính tuỳ chỉnh của một thực thể dấu vết.
getMetric(metricName) Trả về giá trị của chỉ số tuỳ chỉnh theo tên đó. Nếu chỉ số tuỳ chỉnh có tên đó không tồn tại thì kết quả trả về sẽ là 0.
incrementMetric(metricName; num) Thêm vào giá trị của chỉ số tuỳ chỉnh. Nếu không có một chỉ số tuỳ chỉnh có tên được cung cấp, hệ thống sẽ tạo một chỉ số có tên đó với giá trị bằng số đã cho. Giá trị sẽ được giảm xuống còn một số nguyên.
putAttribute(attr, value) Đặt thuộc tính tuỳ 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 chỉ số tuỳ chỉnh được chỉ định thành một số đã cho, bất kể chỉ số 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 còn một số nguyên.
bản ghi(startTime, thời lượng, tuỳ chọn) Ghi lại dấu vết từ các tham số đã cho. Tính năng này cung cấp một cách trực tiếp để sử dụng tính năng theo dõi mà không cần bắt đầu/dừng. Điều này rất hữu ích cho các trường hợp sử dụng mà 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 SDK Hiệu suất được tải).
removeAttribute(attr) Xoá thuộc tính tuỳ chỉnh đã chỉ định khỏi một phiên bản theo dõi.
start() Bắt đầu thời gian cho thực thể theo dõi.
dừng() Dừng thời gian của thực thể theo dõi và ghi nhật ký dữ liệu của thực thể đó.

PerformanceTrace.getAttribute()

Truy xuất giá trị mà thuộc tính tuỳ chỉnh đã được đặt.

Chữ ký:

getAttribute(attr: string): string | undefined;

Thông số

Thông số Loại Mô tả
attr chuỗi Tên của thuộc tính tuỳ chỉnh.

Trường hợp trả lại hàng:

chuỗi | chưa xác định

PerformanceTrace.getAttributes()

Trả về bản đồ chứa tất cả thuộc tính tuỳ chỉnh của một thực thể dấu vết.

Chữ ký:

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

Trường hợp trả lại hàng:

{ [khoá: string]: string; }

PerformanceTrace.getMetric()

Trả về giá trị của chỉ số tuỳ chỉnh theo tên đó. Nếu chỉ số tuỳ chỉnh có tên đó không tồn tại thì kết quả trả về sẽ là 0.

Chữ ký:

getMetric(metricName: string): number;

Thông số

Thông số Loại Mô tả
Tên chỉ số chuỗi Tên của chỉ số tuỳ chỉnh.

Trường hợp trả lại hàng:

số

PerformanceTrace.incrementMetric()

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

Chữ ký:

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

Thông số

Thông số Loại Mô tả
Tên chỉ số chuỗi Tên của chỉ số tuỳ chỉnh.
số số Con số cần thêm vào giá trị của chỉ số tuỳ chỉnh. Nếu không được cung cấp, cột này sẽ sử dụng giá trị mặc định là 1.

Trường hợp trả lại hàng:

trống

PerformanceTrace.putAttribute()

Đặt thuộc tính tuỳ 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ố

Thông số Loại Mô tả
attr chuỗi Tên của thuộc tính tuỳ chỉnh.
value chuỗi Giá trị của thuộc tính tuỳ chỉnh.

Trường hợp trả lại hàng:

trống

PerformanceTrace.putMetric()

Đặt giá trị của chỉ số tuỳ chỉnh được chỉ định thành một số đã cho, bất kể chỉ số 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 còn một số nguyên.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
Tên chỉ số chuỗi Tên của chỉ số tuỳ chỉnh.
số số Giá trị đối với của chỉ số tuỳ chỉnh.

Trường hợp trả lại hàng:

trống

PerformanceTrace.record()

Ghi lại dấu vết từ các tham số đã cho. Tính năng này cung cấp một cách trực tiếp để sử dụng tính năng theo dõi mà không cần bắt đầu/dừng. Điều này rất hữu ích cho các trường hợp sử dụng mà 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 SDK Hiệu suất được tải).

Chữ ký:

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

Thông số

Thông số Loại Mô tả
startTime số theo dõi thời gian bắt đầu kể từ thời gian bắt đầu của hệ thống (tính bằng mili giây).
thời lượng số Thời lượng của dấu vết tính bằng mili giây.
tuỳ chọn { chỉ số?: { [key: string]: number; }; thuộc tính?: { [khoá: string]: string; }; } Đối tượng có thể tuỳ ý lưu giữ bản đồ của các chỉ số tuỳ chỉnh và thuộc tính tuỳ chỉnh.

Trường hợp trả lại hàng:

trống

PerformanceTrace.removeAttribute()

Xoá thuộc tính tuỳ chỉnh đã chỉ định khỏi một phiên bản theo dõi.

Chữ ký:

removeAttribute(attr: string): void;

Thông số

Thông số Loại Mô tả
attr chuỗi Tên của thuộc tính tuỳ chỉnh.

Trường hợp trả lại hàng:

trống

PerformanceTrace.start()

Bắt đầu thời gian cho thực thể theo dõi.

Chữ ký:

start(): void;

Trường hợp trả lại hàng:

trống

PerformanceTrace.stop()

Dừng thời gian của thực thể theo dõi và ghi nhật ký dữ liệu của thực thể đó.

Chữ ký:

stop(): void;

Trường hợp trả lại hàng:

trống