PerformanceTrace interface

Интерфейс, представляющий Trace .

Подпись:

export interface PerformanceTrace

Методы

Метод Описание
getAttribute(атрибут) Получает значение, присвоенное настраиваемому атрибуту.
getAttributes() Возвращает карту всех пользовательских атрибутов экземпляра трассировки.
getMetric(имяметрики) Возвращает значение специальной метрики с этим именем. Если специальная метрика с таким именем не существует, она вернет ноль.
приращениеМетрика (имяметрики, число) Увеличивает ценность пользовательской метрики. Если пользовательская метрика с указанным именем не существует, она создает метрику с таким именем и значением, равным заданному числу. Значение будет уменьшено до целого числа.
putAttribute(атрибут, значение) Установите пользовательскому атрибуту трассировки определенное значение.
putMetric(имяметрики, число) Устанавливает значение указанной пользовательской метрики в заданное число независимо от того, существует ли метрика с таким именем в экземпляре трассировки или нет. Значение будет уменьшено до целого числа.
запись (startTime, продолжительность, параметры) Записывает трассировку по заданным параметрам. Это обеспечивает прямой способ использования трассировки без необходимости запуска/остановки. Это полезно в случаях, когда трассировку нельзя использовать напрямую (например, если продолжительность была зафиксирована до загрузки Performance SDK).
удалитьАтрибут (атрибут) Удаляет указанный настраиваемый атрибут из экземпляра трассировки.
начинать() Запускает отсчет времени для экземпляра трассировки.
останавливаться() Останавливает отсчет времени экземпляра трассировки и записывает данные экземпляра.

PerformanceTrace.getAttribute()

Получает значение, присвоенное настраиваемому атрибуту.

Подпись:

getAttribute(attr: string): string | undefined;

Параметры

Параметр Тип Описание
атрибут нить Имя пользовательского атрибута.

Возврат:

строка | неопределенный

PerformanceTrace.getAttributes()

Возвращает карту всех пользовательских атрибутов экземпляра трассировки.

Подпись:

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

Возврат:

{ [ключ: строка]: строка; }

PerformanceTrace.getMetric()

Возвращает значение специальной метрики с этим именем. Если специальная метрика с таким именем не существует, она вернет ноль.

Подпись:

getMetric(metricName: string): number;

Параметры

Параметр Тип Описание
имя метрики нить Название специальной метрики.

Возврат:

число

PerformanceTrace.incrementMetric()

Увеличивает ценность пользовательской метрики. Если пользовательская метрика с указанным именем не существует, она создает метрику с таким именем и значением, равным заданному числу. Значение будет уменьшено до целого числа.

Подпись:

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

Параметры

Параметр Тип Описание
имя метрики нить Название специальной метрики.
число число Число, которое нужно добавить к значению специальной метрики. Если он не указан, используется значение по умолчанию, равное единице.

Возврат:

пустота

PerformanceTrace.putAttribute()

Установите пользовательскому атрибуту трассировки определенное значение.

Подпись:

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

Параметры

Параметр Тип Описание
атрибут нить Имя пользовательского атрибута.
ценить нить Значение пользовательского атрибута.

Возврат:

пустота

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;

Параметры

Параметр Тип Описание
время начала число время начала трассировки с эпохи в миллисекундах.
продолжительность число Длительность трассировки в миллисекундах.
параметры { метрики?: { [ключ: строка]: число; }; атрибуты?: { [ключ: строка]: строка; }; } Объект, который может дополнительно содержать карты пользовательских метрик и пользовательских атрибутов.

Возврат:

пустота

PerformanceTrace.removeAttribute()

Удаляет указанный настраиваемый атрибут из экземпляра трассировки.

Подпись:

removeAttribute(attr: string): void;

Параметры

Параметр Тип Описание
атрибут нить Имя пользовательского атрибута.

Возврат:

пустота

PerformanceTrace.start()

Запускает отсчет времени для экземпляра трассировки.

Подпись: 

start(): void;

Возврат:

пустота

PerformanceTrace.stop()

Останавливает отсчет времени экземпляра трассировки и записывает данные экземпляра.

Подпись: 

stop(): void;

Возврат:

пустота