PerformanceTrace interface

A interface que representa um Trace .

Assinatura:

export interface PerformanceTrace

Métodos

Método Descrição
getAttribute(atributo) Recupera o valor para o qual um atributo personalizado está definido.
getAttributes() Retorna um mapa de todos os atributos customizados de uma instância de rastreamento.
getMetric(metricName) Retorna o valor da métrica personalizada com esse nome. Se não existir uma métrica personalizada com esse nome, retornará zero.
incrementMetric(metricName, num) Adiciona ao valor de uma métrica personalizada. Se não existir uma métrica personalizada com o nome fornecido, ele cria uma com esse nome e o valor igual ao número fornecido. O valor será reduzido a um número inteiro.
putAttribute(atributo, valor) Defina um atributo personalizado de um rastreamento para um determinado valor.
putMetric(metricName, num) Define o valor da métrica personalizada especificada para o número fornecido, independentemente de já existir ou não uma métrica com esse nome na instância de rastreamento. O valor será reduzido a um número inteiro.
record(startTime, duração, opções) Registra um rastreamento de determinados parâmetros. Isso fornece uma maneira direta de usar o rastreamento sem a necessidade de iniciar/parar. Isso é útil para casos de uso em que o rastreamento não pode ser usado diretamente (por exemplo, se a duração foi capturada antes do carregamento do SDK de desempenho).
removeAttribute(atributo) Remove o atributo customizado especificado de uma instância de rastreamento.
começar() Inicia a cronometragem da instância de rastreamento.
parar() Interrompe o tempo da instância de rastreamento e registra os dados da instância.

PerformanceTrace.getAttribute()

Recupera o valor para o qual um atributo personalizado está definido.

Assinatura:

getAttribute(attr: string): string | undefined;

Parâmetros

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

Retorna:

corda | indefinido

PerformanceTrace.getAttributes()

Retorna um mapa de todos os atributos customizados de uma instância de rastreamento.

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, retornará zero.

Assinatura:

getMetric(metricName: string): number;

Parâmetros

Parâmetro Tipo Descrição
métricaName corda Nome da métrica personalizada.

Retorna:

número

PerformanceTrace.incrementMetric()

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
métricaName corda O nome da métrica personalizada.
número número O número a ser adicionado ao valor da métrica personalizada. Se não for fornecido, ele usará um valor padrão de um.

Retorna:

vazio

PerformanceTrace.putAttribute()

Defina um atributo personalizado de um rastreamento para um determinado valor.

Assinatura:

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

Parâmetros

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

Retorna:

vazio

PerformanceTrace.putMetric()

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
métricaName corda Nome da métrica personalizada.
número número Valor para da métrica personalizada.

Retorna:

vazio

PerformanceTrace.record()

Registra um rastreamento de determinados parâmetros. Isso fornece uma maneira direta de usar o rastreamento sem a necessidade de iniciar/parar. Isso é útil para casos de uso em que o rastreamento 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
hora de início número rastrear a hora de início desde a época em milissegundos.
duração número A duração do rastreamento em milissegundos.
opções {métricas?: {[chave: string]: número; }; atributos?: { [chave: string]: string; }; } Um objeto que pode opcionalmente conter mapas de métricas e atributos personalizados.

Retorna:

vazio

PerformanceTrace.removeAttribute()

Remove o atributo customizado especificado de uma instância de rastreamento.

Assinatura:

removeAttribute(attr: string): void;

Parâmetros

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

Retorna:

vazio

PerformanceTrace.start()

Inicia a cronometragem da instância de rastreamento.

Assinatura:

start(): void;

Retorna:

vazio

DesempenhoTrace.stop()

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

Assinatura:

stop(): void;

Retorna:

vazio