PerformanceTrace interface

La interfaz que representa un Trace.

Firma:

export interface PerformanceTrace

Métodos

Método Descripción
getAttribute(attr) Recupera el valor establecido para un atributo personalizado.
getAttributes() Muestra un mapa de todos los atributos personalizados de una instancia de seguimiento.
getMetric(Nombredemetric) Muestra el valor de la métrica personalizada según ese nombre. Si no existe una métrica personalizada con ese nombre, se mostrará cero.
incrementMetric(metricName, num) Aumenta el valor de una métrica personalizada. Si no existe una métrica personalizada con el nombre proporcionado, se crea una con ese nombre y un valor igual a la cantidad especificada. El valor se reducirá a un número entero.
putAttribute(attr, value) Configura un atributo personalizado de un seguimiento en un valor determinado.
putMetric(metricName, num) Establece el valor de la métrica personalizada especificada en el número especificado, independientemente de si ya existe o no una métrica con ese nombre en la instancia de seguimiento. El valor se reducirá a un número entero.
record(startTime, duration, opciones) Registra un seguimiento a partir de parámetros determinados. Esto proporciona una forma directa de usar el registro sin necesidad de iniciarlo o detenerlo. Esto es útil para casos de uso en los que no se puede usar el seguimiento directamente (p.ej., si se capturó la duración antes de cargar el SDK de Performance).
removeAttribute(attr) Quita el atributo personalizado especificado de una instancia de seguimiento.
Iniciar() Inicia el tiempo de la instancia de seguimiento.
stop() Detiene el tiempo de la instancia de seguimiento y registra los datos de la instancia.

PerformanceTrace.getAttribute().

Recupera el valor establecido para un atributo personalizado.

Firma:

getAttribute(attr: string): string | undefined;

Parámetros

Parámetro Tipo Descripción
attr string Es el nombre del atributo personalizado.

Muestra:

cadena | indefinido

PerformanceTrace.getAttributes()

Muestra un mapa de todos los atributos personalizados de una instancia de seguimiento.

Firma:

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

Muestra:

{ [clave: cadena]: cadena; }.

PerformanceTrace.getMetric()

Muestra el valor de la métrica personalizada según ese nombre. Si no existe una métrica personalizada con ese nombre, se mostrará cero.

Firma:

getMetric(metricName: string): number;

Parámetros

Parámetro Tipo Descripción
NombreMétrica string Nombre de la métrica personalizada.

Muestra:

número

PerformanceTrace.incrementMetric()

Aumenta el valor de una métrica personalizada. Si no existe una métrica personalizada con el nombre proporcionado, se crea una con ese nombre y un valor igual a la cantidad especificada. El valor se reducirá a un número entero.

Firma:

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

Parámetros

Parámetro Tipo Descripción
NombreMétrica string Es el nombre de la métrica personalizada.
num número Es el número que se agregará al valor de la métrica personalizada. Si no se proporciona, se usa un valor predeterminado de uno.

Muestra:

void

PerformanceTrace.putAttribute().

Configura un atributo personalizado de un seguimiento en un valor determinado.

Firma:

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

Parámetros

Parámetro Tipo Descripción
attr string Es el nombre del atributo personalizado.
valor string Valor del atributo personalizado.

Muestra:

void

PerformanceTrace.putMetric()

Establece el valor de la métrica personalizada especificada en el número especificado, independientemente de si ya existe o no una métrica con ese nombre en la instancia de seguimiento. El valor se reducirá a un número entero.

Firma:

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

Parámetros

Parámetro Tipo Descripción
NombreMétrica string Nombre de la métrica personalizada.
num número Valor de la métrica personalizada.

Muestra:

void

PerformanceTrace.record().

Registra un seguimiento a partir de parámetros determinados. Esto proporciona una forma directa de usar el registro sin necesidad de iniciarlo o detenerlo. Esto es útil para casos de uso en los que no se puede usar el seguimiento directamente (p.ej., si se capturó la duración antes de cargar el SDK de Performance).

Firma:

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

Parámetros

Parámetro Tipo Descripción
startTime número seguimiento del tiempo de inicio desde el ciclo de entrenamiento en milisegundos.
duración número La duración del seguimiento en milisegundos.
opciones { métricas?: { [key: string]: number; }. atributos?: { [clave: cadena]: cadena; }. }. Es un objeto que, de manera opcional, puede contener mapas de métricas y atributos personalizados.

Muestra:

void

PerformanceTrace.removeAttribute().

Quita el atributo personalizado especificado de una instancia de seguimiento.

Firma:

removeAttribute(attr: string): void;

Parámetros

Parámetro Tipo Descripción
attr string Es el nombre del atributo personalizado.

Muestra:

void

PerformanceTrace.start()

Inicia el tiempo de la instancia de seguimiento.

Firma:

start(): void;

Muestra:

void

PerformanceTrace.stop()

Detiene el tiempo de la instancia de seguimiento y registra los datos de la instancia.

Firma:

stop(): void;

Muestra:

void