BrowserPerformanceClient class

Extends

Methoden

addQueueMeasurement(string, string, number, boolean)

Berechnet und fügt die Warteschlangenzeitmessung für ein bestimmtes Leistungsereignis hinzu.

generateId()
setPreQueueTime(PerformanceEvents, string)

Fügt pre-queue time to preQueueTimeByCorrelationId map hinzu.

startMeasurement(string, string)

Beginnt mit der Messung der Leistung für einen bestimmten Vorgang. Gibt eine Funktion zurück, die zum Beenden der Messung verwendet werden soll. Erfasst auch browserseitige SichtbarkeitState.

Geerbte Methoden

addFields({[key: string]: {} | undefined}, string)

Speichert zusätzliche Informationen, die ausgegeben werden sollen, wenn die Maße geleert werden

addPerformanceCallback(PerformanceCallbackFunction)

Registriert eine Rückruffunktion, um Leistungsereignisse zu empfangen.

calculateQueuedTime(number, number)

Berechnet die Differenz zwischen der aktuellen Uhrzeit und der Uhrzeit, zu der die Funktion in die Warteschlange eingereiht wurde. Hinweis: Es ist möglich, 0 als Warteschlangenzeit zu haben, wenn die aktuelle Uhrzeit und die in die Warteschlange eingereihte Zeit identisch waren.

discardMeasurements(string)

Entfernt Maße und Aux-Daten für eine bestimmte Korrelations-ID.

emitEvents(PerformanceEvent[], string)

Gibt Ereignisse an alle registrierten Rückrufe aus.

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Beendet die Messung der Leistung für einen Vorgang. Sollte nur direkt von PerformanceClient-Klassen aufgerufen werden, da Consumer stattdessen die von startMeasurement zurückgegebene Funktion verwenden sollten. Fügt ein neues Feld mit dem Namen "[Ereignisname]DurationMs" für Untermessungen hinzu, schließt ein Ereignis ab und gibt es andernfalls aus.

getPreQueueTime(string, string)

Ruft die Zuordnung von Vorwarteschlangenzeiten nach Korrelations-ID ab.

incrementFields({[key: string]: number | undefined}, string)

Inkrementzähler, die ausgegeben werden sollen, wenn die Maße geleert werden

removePerformanceCallback(string)

Entfernt einen mit addPerformanceCallback registrierten Rückruf.

startPerformanceMeasurement(string, string)

Startet und gibt eine plattformspezifische Implementierung von IPerformanceMeasurement zurück. Hinweis: Diese Funktion kann beim nächsten Hauptversionsstoß in abstrahieren geändert werden.

Details zum Konstruktor

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

new BrowserPerformanceClient(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>)

Parameter

configuration
Configuration
intFields

Set<string>

abbreviations

Map<string, string>

Details zur Methode

addQueueMeasurement(string, string, number, boolean)

Berechnet und fügt die Warteschlangenzeitmessung für ein bestimmtes Leistungsereignis hinzu.

function addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean)

Parameter

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

Indikator für manuell abgeschlossene Warteschlangenmessungen

generateId()

function generateId(): string

Gibt zurück

string

setPreQueueTime(PerformanceEvents, string)

Fügt pre-queue time to preQueueTimeByCorrelationId map hinzu.

function setPreQueueTime(eventName: PerformanceEvents, correlationId?: string)

Parameter

eventName
PerformanceEvents
correlationId

string

startMeasurement(string, string)

Beginnt mit der Messung der Leistung für einen bestimmten Vorgang. Gibt eine Funktion zurück, die zum Beenden der Messung verwendet werden soll. Erfasst auch browserseitige SichtbarkeitState.

function startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent

Parameter

measureName

string

correlationId

string

Gibt zurück

Details zur geerbten Methode

addFields({[key: string]: {} | undefined}, string)

Speichert zusätzliche Informationen, die ausgegeben werden sollen, wenn die Maße geleert werden

function addFields(fields: {[key: string]: {} | undefined}, correlationId: string)

Parameter

fields

{[key: string]: {} | undefined}

correlationId

string

Geerbt von PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Registriert eine Rückruffunktion, um Leistungsereignisse zu empfangen.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameter

Gibt zurück

string

Geerbt von PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

Berechnet die Differenz zwischen der aktuellen Uhrzeit und der Uhrzeit, zu der die Funktion in die Warteschlange eingereiht wurde. Hinweis: Es ist möglich, 0 als Warteschlangenzeit zu haben, wenn die aktuelle Uhrzeit und die in die Warteschlange eingereihte Zeit identisch waren.

function calculateQueuedTime(preQueueTime: number, currentTime: number): number

Parameter

preQueueTime

number

currentTime

number

Gibt zurück

number

Geerbt von PerformanceClient.calculateQueuedTime

discardMeasurements(string)

Entfernt Maße und Aux-Daten für eine bestimmte Korrelations-ID.

function discardMeasurements(correlationId: string)

Parameter

correlationId

string

Geerbt von PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Gibt Ereignisse an alle registrierten Rückrufe aus.

function emitEvents(events: PerformanceEvent[], correlationId?: string)

Parameter

events

PerformanceEvent[]

correlationId

string

Geerbt von PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Beendet die Messung der Leistung für einen Vorgang. Sollte nur direkt von PerformanceClient-Klassen aufgerufen werden, da Consumer stattdessen die von startMeasurement zurückgegebene Funktion verwenden sollten. Fügt ein neues Feld mit dem Namen "[Ereignisname]DurationMs" für Untermessungen hinzu, schließt ein Ereignis ab und gibt es andernfalls aus.

function endMeasurement(event: PerformanceEvent, error?: unknown, account?: AccountInfo): null | PerformanceEvent

Parameter

error

unknown

account
AccountInfo

Gibt zurück

Geerbt von PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Ruft die Zuordnung von Vorwarteschlangenzeiten nach Korrelations-ID ab.

function getPreQueueTime(eventName: string, correlationId: string): number | void

Parameter

eventName

string

correlationId

string

Gibt zurück

number | void

Geerbt von PerformanceClient.getPreQueueTime

incrementFields({[key: string]: number | undefined}, string)

Inkrementzähler, die ausgegeben werden sollen, wenn die Maße geleert werden

function incrementFields(fields: {[key: string]: number | undefined}, correlationId: string)

Parameter

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Korrelationsbezeichner für {string}

Geerbt von PerformanceClient.incrementFields

removePerformanceCallback(string)

Entfernt einen mit addPerformanceCallback registrierten Rückruf.

function removePerformanceCallback(callbackId: string): boolean

Parameter

callbackId

string

Gibt zurück

boolean

Geerbt von PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Warnung

Diese API ist nun veraltet.

This method will be removed in the next major version

Startet und gibt eine plattformspezifische Implementierung von IPerformanceMeasurement zurück. Hinweis: Diese Funktion kann beim nächsten Hauptversionsstoß in abstrahieren geändert werden.

function startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement

Parameter

measureName

string

correlationId

string

Gibt zurück

Geerbt von PerformanceClient.startPerformanceMeasurement