PerformanceTrace interface

A interface que representa um Trace.

Assinatura:

export interface PerformanceTrace

Métodos

Método Descrição
getAttribute(attr) (link em inglês) Recupera o valor definido para um atributo personalizado.
getAttributes(). Retorna um mapa de todos os atributos personalizados de uma instância de trace.
getMetric(metricName) Retorna o valor da métrica personalizada com esse nome. Se não existir uma métrica personalizada com esse nome, ela retornará zero.
incrementMetric(metricName, num) Adiciona o valor de uma métrica personalizada. Se não existir uma métrica personalizada com o nome fornecido, ela criará uma com esse nome e o valor igual ao número informado. O valor será reduzido a um número inteiro.
putAttribute(attr, value) Define um atributo personalizado de um trace para um determinado valor.
putMetric(metricName, num) Define o valor da métrica personalizada especificada como o número informado, independente de já existir uma métrica com esse nome na instância de trace ou não. O valor será reduzido a um número inteiro.
record(startTime, Duration, options) Registra um trace com base em determinados parâmetros. Isso oferece uma maneira direta de usar o trace sem precisar iniciar/parar. Isso é útil nos casos em que o trace não pode ser usado diretamente (por exemplo, se a duração foi capturada antes do carregamento do SDK de desempenho).
removeAttribute(attr) (link em inglês) Remove o atributo personalizado especificado de uma instância de trace.
start(); Inicia a cronologia da instância de trace.
stop(). Interrompe o tempo da instância de rastreamento e registra os dados da instância.

PerformanceTrace.getAttribute()

Recupera o valor definido para um atributo personalizado.

Assinatura:

getAttribute(attr: string): string | undefined;

Parâmetros

Parâmetro Tipo Descrição
attr string Nome do atributo personalizado.

Retorna:

string | indefinido

PerformanceTrace.getAttributes()

Retorna um mapa de todos os atributos personalizados de uma instância de trace.

Assinatura:

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

Retorna:

{ [chave: string]: string; }

PerformanceTrace.getMetric()

Retorna o valor da métrica personalizada com esse nome. Se não existir uma métrica personalizada com esse nome, ela retornará zero.

Assinatura:

getMetric(metricName: string): number;

Parâmetros

Parâmetro Tipo Descrição
metricName string Nome da métrica personalizada.

Retorna:

number

PerformanceTrace.incrementMetric()

Adiciona o valor de uma métrica personalizada. Se não existir uma métrica personalizada com o nome fornecido, ela criará uma com esse nome e o valor igual ao número informado. O valor será reduzido a um número inteiro.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
metricName string O nome da métrica personalizada.
num number O número a ser adicionado ao valor da métrica personalizada. Se não for informado, o valor padrão será um.

Retorna:

void

PerformanceTrace.putAttribute()

Define um atributo personalizado de um trace para um determinado valor.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
attr string Nome do atributo personalizado.
valor string Valor do atributo personalizado.

Retorna:

void

PerformanceTrace.putMetric()

Define o valor da métrica personalizada especificada como o número informado, independente de já existir uma métrica com esse nome na instância de trace ou não. O valor será reduzido a um número inteiro.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
metricName string Nome da métrica personalizada.
num number Valor da métrica personalizada.

Retorna:

void

PerformanceTrace.record()

Registra um trace com base em determinados parâmetros. Isso oferece uma maneira direta de usar o trace sem precisar iniciar/parar. Isso é útil nos casos em que o trace não pode ser usado diretamente (por exemplo, se a duração foi capturada antes do carregamento do SDK de desempenho).

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
startTime number do horário de início do trace desde o período em milissegundos.
duration number A duração do trace em milissegundos.
options { métricas?: { [key: string]: number; }; atributos? { [chave: string]: string; }; } Um objeto que pode conter mapas de métricas e atributos personalizados.

Retorna:

void

PerformanceTrace.removeAttribute()

Remove o atributo personalizado especificado de uma instância de trace.

Assinatura:

removeAttribute(attr: string): void;

Parâmetros

Parâmetro Tipo Descrição
attr string Nome do atributo personalizado.

Retorna:

void

PerformanceTrace.start()

Inicia a cronologia da instância de trace.

Assinatura:

start(): void;

Retorna:

void

PerformanceTrace.stop()

Interrompe o tempo da instância de rastreamento e registra os dados da instância.

Assinatura:

stop(): void;

Retorna:

void