PerformanceTrace interface

Die Schnittstelle, die einen Trace darstellt .

Unterschrift:

export interface PerformanceTrace

Methoden

Methode Beschreibung
getAttribute(attr) Ruft den Wert ab, auf den ein benutzerdefiniertes Attribut festgelegt ist.
getAttributes() Gibt eine Karte aller benutzerdefinierten Attribute einer Trace-Instanz zurück.
getMetric(metricName) Gibt den Wert der benutzerdefinierten Metrik mit diesem Namen zurück. Wenn keine benutzerdefinierte Metrik mit diesem Namen vorhanden ist, wird Null zurückgegeben.
incrementMetric(metricName, num) Erhöht den Wert einer benutzerdefinierten Metrik. Wenn keine benutzerdefinierte Metrik mit dem angegebenen Namen vorhanden ist, wird eine mit diesem Namen und einem Wert erstellt, der der angegebenen Zahl entspricht. Der Wert wird auf eine ganze Zahl reduziert.
putAttribute(attr, value) Legen Sie ein benutzerdefiniertes Attribut einer Ablaufverfolgung auf einen bestimmten Wert fest.
putMetric(metricName, num) Setzt den Wert der angegebenen benutzerdefinierten Metrik auf die angegebene Zahl, unabhängig davon, ob in der Trace-Instanz bereits eine Metrik mit diesem Namen vorhanden ist oder nicht. Der Wert wird auf eine ganze Zahl reduziert.
Datensatz (Startzeit, Dauer, Optionen) Zeichnet eine Ablaufverfolgung von angegebenen Parametern auf. Dies bietet eine direkte Möglichkeit, Trace zu verwenden, ohne starten/stoppen zu müssen. Dies ist nützlich für Anwendungsfälle, in denen der Trace nicht direkt verwendet werden kann (z. B. wenn die Dauer erfasst wurde, bevor das Performance SDK geladen wurde).
removeAttribute(attr) Entfernt das angegebene benutzerdefinierte Attribut aus einer Trace-Instanz.
Start() Startet das Timing für die Trace-Instanz.
stoppen() Stoppt das Timing der Trace-Instanz und protokolliert die Daten der Instanz.

PerformanceTrace.getAttribute()

Ruft den Wert ab, auf den ein benutzerdefiniertes Attribut festgelegt ist.

Unterschrift:

getAttribute(attr: string): string | undefined;

Parameter

Parameter Typ Beschreibung
attr Zeichenfolge Name des benutzerdefinierten Attributs.

Kehrt zurück:

Zeichenfolge | nicht definiert

PerformanceTrace.getAttributes()

Gibt eine Karte aller benutzerdefinierten Attribute einer Trace-Instanz zurück.

Unterschrift:

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

Kehrt zurück:

{ [Schlüssel: Zeichenfolge]: Zeichenfolge; }

PerformanceTrace.getMetric()

Gibt den Wert der benutzerdefinierten Metrik mit diesem Namen zurück. Wenn keine benutzerdefinierte Metrik mit diesem Namen vorhanden ist, wird Null zurückgegeben.

Unterschrift:

getMetric(metricName: string): number;

Parameter

Parameter Typ Beschreibung
metricName Zeichenfolge Name der benutzerdefinierten Metrik.

Kehrt zurück:

Nummer

PerformanceTrace.incrementMetric()

Erhöht den Wert einer benutzerdefinierten Metrik. Wenn keine benutzerdefinierte Metrik mit dem angegebenen Namen vorhanden ist, wird eine mit diesem Namen und einem Wert erstellt, der der angegebenen Zahl entspricht. Der Wert wird auf eine ganze Zahl reduziert.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
metricName Zeichenfolge Der Name der benutzerdefinierten Metrik.
Num Nummer Die Zahl, die zum Wert der benutzerdefinierten Metrik hinzugefügt werden soll. Wenn nicht angegeben, wird der Standardwert eins verwendet.

Kehrt zurück:

Leere

PerformanceTrace.putAttribute()

Legen Sie ein benutzerdefiniertes Attribut einer Ablaufverfolgung auf einen bestimmten Wert fest.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
attr Zeichenfolge Name des benutzerdefinierten Attributs.
Wert Zeichenfolge Wert des benutzerdefinierten Attributs.

Kehrt zurück:

Leere

PerformanceTrace.putMetric()

Setzt den Wert der angegebenen benutzerdefinierten Metrik auf die angegebene Zahl, unabhängig davon, ob in der Trace-Instanz bereits eine Metrik mit diesem Namen vorhanden ist oder nicht. Der Wert wird auf eine ganze Zahl reduziert.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
metricName Zeichenfolge Name der benutzerdefinierten Metrik.
Num Nummer Wert bis der benutzerdefinierten Metrik.

Kehrt zurück:

Leere

PerformanceTrace.record()

Zeichnet eine Ablaufverfolgung von angegebenen Parametern auf. Dies bietet eine direkte Möglichkeit, Trace zu verwenden, ohne starten/stoppen zu müssen. Dies ist nützlich für Anwendungsfälle, in denen der Trace nicht direkt verwendet werden kann (z. B. wenn die Dauer erfasst wurde, bevor das Performance SDK geladen wurde).

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Startzeit Nummer Trace-Startzeit seit Epoche in Millisekunden.
Dauer Nummer Die Dauer der Spur in Millisekunden.
Optionen { metrics?: { [key: string]: number; }; Attribute?: { [key: string]: string; }; } Ein Objekt, das optional Karten von benutzerdefinierten Metriken und benutzerdefinierten Attributen enthalten kann.

Kehrt zurück:

Leere

PerformanceTrace.removeAttribute()

Entfernt das angegebene benutzerdefinierte Attribut aus einer Trace-Instanz.

Unterschrift:

removeAttribute(attr: string): void;

Parameter

Parameter Typ Beschreibung
attr Zeichenfolge Name des benutzerdefinierten Attributs.

Kehrt zurück:

Leere

PerformanceTrace.start()

Startet das Timing für die Trace-Instanz.

Unterschrift:

start(): void;

Kehrt zurück:

Leere

PerformanceTrace.stop()

Stoppt das Timing der Trace-Instanz und protokolliert die Daten der Instanz.

Unterschrift:

stop(): void;

Kehrt zurück:

Leere