PerformanceTrace interface

La interfaz que representa un Trace .

Firma:

export interface PerformanceTrace 

Métodos

Método Descripción
getAttribute(atributo) Recupera el valor en el que está establecido un atributo personalizado.
getAttributes() Devuelve un mapa de todos los atributos personalizados de una instancia de seguimiento.
getMetric(nombreMetrica) Devuelve el valor de la métrica personalizada con ese nombre. Si no existe una métrica personalizada con ese nombre, devolverá cero.
incrementMetric(metricName, num) Se suma al valor de una métrica personalizada. Si no existe una métrica personalizada con el nombre proporcionado, crea una con ese nombre y el valor igual al número dado. El valor se reducirá a un número entero.
putAttribute(atributo, valor) Establezca un atributo personalizado de una traza en un valor determinado.
putMetric(nombreMetrica, num) Establece el valor de la métrica personalizada especificada en el número dado, independientemente de si ya existe una métrica con ese nombre en la instancia de seguimiento o no. El valor se reducirá a un número entero.
registro (startTime, duración, opciones) Registra un seguimiento de los parámetros dados. Esto proporciona una forma directa de utilizar el rastreo sin necesidad de iniciar/detener. Esto es útil para casos de uso en los que la traza no se puede usar directamente (por ejemplo, si la duración se capturó antes de que se cargara el SDK de rendimiento).
removeAttribute(atributo) Elimina el atributo personalizado especificado de una instancia de seguimiento.
comienzo() Inicia el tiempo para la instancia de seguimiento.
deténgase() Detiene el tiempo de la instancia de rastreo y registra los datos de la instancia.

PerformanceTrace.getAttribute()

Recupera el valor en el que está establecido un atributo personalizado.

Firma:

getAttribute(attr: string): string | undefined;

Parámetros

Parámetro Escribe Descripción
atributo cuerda Nombre del atributo personalizado.

Devoluciones:

cadena | indefinido

PerformanceTrace.getAttributes()

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

Firma:

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

Devoluciones:

{ [clave: cadena]: cadena; }

PerformanceTrace.getMetric()

Devuelve el valor de la métrica personalizada con ese nombre. Si no existe una métrica personalizada con ese nombre, devolverá cero.

Firma:

getMetric(metricName: string): number;

Parámetros

Parámetro Escribe Descripción
metricName cuerda Nombre de la métrica personalizada.

Devoluciones:

número

PerformanceTrace.incrementMetric()

Se suma al valor de una métrica personalizada. Si no existe una métrica personalizada con el nombre proporcionado, crea una con ese nombre y el valor igual al número dado. El valor se reducirá a un número entero.

Firma:

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

Parámetros

Parámetro Escribe Descripción
metricName cuerda El nombre de la métrica personalizada.
número número El número que se agregará al valor de la métrica personalizada. Si no se proporciona, utiliza un valor predeterminado de uno.

Devoluciones:

vacío

PerformanceTrace.putAttribute()

Establezca un atributo personalizado de una traza en un valor determinado.

Firma:

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

Parámetros

Parámetro Escribe Descripción
atributo cuerda Nombre del atributo personalizado.
valor cuerda Valor del atributo personalizado.

Devoluciones:

vacío

PerformanceTrace.putMetric()

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

Firma:

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

Parámetros

Parámetro Escribe Descripción
metricName cuerda Nombre de la métrica personalizada.
número número Valor de la métrica personalizada.

Devoluciones:

vacío

PerformanceTrace.record()

Registra un seguimiento de los parámetros dados. Esto proporciona una forma directa de utilizar el rastreo sin necesidad de iniciar/detener. Esto es útil para casos de uso en los que la traza no se puede usar directamente (por ejemplo, si la duración se capturó antes de que se cargara el SDK de rendimiento).

Firma:

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

Parámetros

Parámetro Escribe Descripción
hora de inicio número rastrear la hora de inicio desde la época en milisegundos.
duración número La duración de la traza en milisegundos.
opciones { métricas?: { [clave: cadena]: número; }; atributos?: { [clave: cadena]: cadena; }; } Un objeto que opcionalmente puede contener mapas de métricas personalizadas y atributos personalizados.

Devoluciones:

vacío

PerformanceTrace.removeAttribute()

Elimina el atributo personalizado especificado de una instancia de seguimiento.

Firma:

removeAttribute(attr: string): void;

Parámetros

Parámetro Escribe Descripción
atributo cuerda Nombre del atributo personalizado.

Devoluciones:

vacío

PerformanceTrace.start()

Inicia el tiempo para la instancia de seguimiento.

Firma:

start(): void;

Devoluciones:

vacío

PerformanceTrace.stop()

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

Firma:

stop(): void;

Devoluciones:

vacío