PerformanceTrace interface

L'interface représentant une Trace .

Signature:

export interface PerformanceTrace 

Méthodes

PerformanceTrace.getAttribute()

Récupère la valeur à laquelle un attribut personnalisé est défini.

Signature:

getAttribute(attr: string): string | undefined;

Paramètres

Retour:

chaîne | indéfini

PerformanceTrace.getAttributes()

Renvoie une carte de tous les attributs personnalisés d'une instance de trace.

Signature:

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

Retour:

{ [clé : chaîne] : chaîne ; }

PerformanceTrace.getMetric()

Renvoie la valeur de la métrique personnalisée portant ce nom. Si une métrique personnalisée portant ce nom n’existe pas, elle renverra zéro.

Signature:

getMetric(metricName: string): number;

Paramètres

Retour:

nombre

PerformanceTrace.incrementMetric()

Ajoute à la valeur d’une métrique personnalisée. Si une métrique personnalisée portant le nom fourni n’existe pas, elle en crée une avec ce nom et la valeur égale au nombre donné. La valeur sera ramenée à un nombre entier.

Signature:

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

Paramètres

Retour:

vide

PerformanceTrace.putAttribute()

Définissez un attribut personnalisé d'une trace sur une certaine valeur.

Signature:

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

Paramètres

Retour:

vide

PerformanceTrace.putMetric()

Définit la valeur de la métrique personnalisée spécifiée sur le nombre donné, qu'une métrique portant ce nom existe déjà sur l'instance de trace ou non. La valeur sera ramenée à un nombre entier.

Signature:

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

Paramètres

Retour:

vide

PerformanceTrace.record()

Enregistre une trace à partir de paramètres donnés. Cela fournit un moyen direct d’utiliser trace sans avoir besoin de démarrer/arrêter. Ceci est utile pour les cas d'utilisation dans lesquels la trace ne peut pas être utilisée directement (par exemple, si la durée a été capturée avant le chargement du SDK Performance).

Signature:

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

Paramètres

Retour:

vide

PerformanceTrace.removeAttribute()

Supprime l'attribut personnalisé spécifié d'une instance de trace.

Signature:

removeAttribute(attr: string): void;

Paramètres

Retour:

vide

PerformanceTrace.start()

Démarre le timing de l'instance de trace.

Signature:

start(): void;

Retour:

vide

PerformanceTrace.stop()

Arrête le timing de l'instance de trace et enregistre les données de l'instance.

Signature:

stop(): void;

Retour:

vide