A interface que representa um Trace
.
Assinatura:
export interface PerformanceTrace
Métodos
Método | Descrição |
---|---|
getAttribute(attr) | Recupera o valor para o qual um atributo personalizado está definido. |
getAtributos() | Retorna um mapa de todos os atributos personalizados de uma instância de rastreamento. |
getMetric(metricName) | Retorna o valor da métrica personalizada com esse nome. Se uma métrica personalizada com esse nome não existir, retornará zero. |
incrementMetric(metricName, num) | Adiciona o valor de uma métrica personalizada. Se uma métrica personalizada com o nome fornecido não existir, ela criará uma com esse nome e o valor igual ao número fornecido. O valor será reduzido para um número inteiro. |
putAttribute(attr, 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 uma métrica com esse nome já existir ou não na instância de rastreamento. O valor será reduzido para um número inteiro. |
record(startTime, duração, opções) | Grava um rastreamento de parâmetros fornecidos. 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 Performance SDK). |
removeAttribute(attr) | Remove o atributo personalizado especificado de uma instância de rastreamento. |
começar() | Inicia o tempo para a instância de rastreamento. |
Pare() | 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 | Modelo | Descrição |
---|---|---|
atr | corda | Nome do atributo personalizado. |
Devoluções:
seqüência | Indefinido
PerformanceTrace.getAttributes()
Retorna um mapa de todos os atributos personalizados de uma instância de rastreamento.
Assinatura:
getAttributes(): {
[key: string]: string;
};
Devoluções:
{ [chave: string]: string; }
PerformanceTrace.getMetric()
Retorna o valor da métrica personalizada com esse nome. Se uma métrica personalizada com esse nome não existir, retornará zero.
Assinatura:
getMetric(metricName: string): number;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
metricName | corda | Nome da métrica personalizada. |
Devoluções:
número
PerformanceTrace.incrementMetric()
Adiciona o valor de uma métrica personalizada. Se uma métrica personalizada com o nome fornecido não existir, ela criará uma com esse nome e o valor igual ao número fornecido. O valor será reduzido para um número inteiro.
Assinatura:
incrementMetric(metricName: string, num?: number): void;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
metricName | 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. |
Devoluções:
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 | Modelo | Descrição |
---|---|---|
atr | corda | Nome do atributo personalizado. |
valor | corda | Valor do atributo personalizado. |
Devoluções:
vazio
PerformanceTrace.putMetric()
Define o valor da métrica personalizada especificada para o número fornecido, independentemente de uma métrica com esse nome já existir ou não na instância de rastreamento. O valor será reduzido para um número inteiro.
Assinatura:
putMetric(metricName: string, num: number): void;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
metricName | corda | Nome da métrica personalizada. |
número | número | Valor para da métrica personalizada. |
Devoluções:
vazio
PerformanceTrace.record()
Grava um rastreamento de parâmetros fornecidos. 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 Performance SDK).
Assinatura:
record(startTime: number, duration: number, options?: {
metrics?: {
[key: string]: number;
};
attributes?: {
[key: string]: string;
};
}): void;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
hora de início | número | trace a hora de início desde a época em milissegundos. |
duração | número | A duração do traço em milissegundos. |
opções | { métricas?: { [chave: string]: número; }; atributos?: { [chave: string]: string; }; } | Um objeto que pode, opcionalmente, conter mapas de métricas personalizadas e atributos personalizados. |
Devoluções:
vazio
PerformanceTrace.removeAttribute()
Remove o atributo personalizado especificado de uma instância de rastreamento.
Assinatura:
removeAttribute(attr: string): void;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
atr | corda | Nome do atributo personalizado. |
Devoluções:
vazio
PerformanceTrace.start()
Inicia o tempo para a instância de rastreamento.
Assinatura:
start(): void;
Devoluções:
vazio
PerformanceTrace.stop()
Interrompe o tempo da instância de rastreamento e registra os dados da instância.
Assinatura:
stop(): void;
Devoluções:
vazio