PerformanceTrace interface

La interfaz que representa un Trace .

Firma:

export interface PerformanceTrace

Métodos

Método Descripción
obtenerAtributo(atributo) Recupera el valor en el que está establecido un atributo personalizado.
obtenerAtributos() Devuelve un mapa de todos los atributos personalizados de una instancia de seguimiento.
getMetric(nombremétrico) Devuelve el valor de la métrica personalizada con ese nombre. Si una métrica personalizada con ese nombre no existe, devolverá cero.
incrementMetric(nombremétrico, núm) 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 un seguimiento en un valor determinado.
putMetric(nombremétrico, núm) Establece el valor de la métrica personalizada especificada en el número indicado 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 (hora de inicio, duración, opciones) Registra un seguimiento de los parámetros dados. Esto proporciona una forma directa de utilizar el seguimiento sin necesidad de iniciar/detener. Esto es útil para casos de uso en los que el seguimiento no se puede utilizar directamente (por ejemplo, si la duración se capturó antes de cargar el SDK de rendimiento).
eliminarAtributo(atributo) Elimina el atributo personalizado especificado de una instancia de seguimiento.
comenzar() Inicia la sincronización de la instancia de seguimiento.
detener() Detiene la sincronización de la instancia de seguimiento 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 Tipo Descripción
atributo cadena 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 una métrica personalizada con ese nombre no existe, devolverá cero.

Firma:

getMetric(metricName: string): number;

Parámetros

Parámetro Tipo Descripción
nombremétrico cadena 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 Tipo Descripción
nombremétrico cadena 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 un seguimiento en un valor determinado.

Firma:

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

Parámetros

Parámetro Tipo Descripción
atributo cadena Nombre del atributo personalizado.
valor cadena Valor del atributo personalizado.

Devoluciones:

vacío

PerformanceTrace.putMetric()

Establece el valor de la métrica personalizada especificada en el número indicado 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 Tipo Descripción
nombremétrico cadena 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 seguimiento sin necesidad de iniciar/detener. Esto es útil para casos de uso en los que el seguimiento no se puede utilizar directamente (por ejemplo, si la duración se capturó antes de cargar el SDK de rendimiento).

Firma:

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

Parámetros

Parámetro Tipo Descripción
hora de inicio número Hora de inicio del seguimiento desde la época en milisegundos.
duración número La duración del rastro en milisegundos.
opciones { ¿métricas?: { [clave: cadena]: número; }; ¿atributos?: { [clave: cadena]: cadena; }; } Un objeto que, opcionalmente, puede contener mapas de métricas 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 Tipo Descripción
atributo cadena Nombre del atributo personalizado.

Devoluciones:

vacío

PerformanceTrace.start()

Inicia la sincronización de la instancia de seguimiento.

Firma:

start(): void;

Devoluciones:

vacío

PerformanceTrace.stop()

Detiene la sincronización de la instancia de seguimiento y registra los datos de la instancia.

Firma:

stop(): void;

Devoluciones:

vacío