PerformanceClient class

Erstellt eine Instanz von PerformanceClient, einer abstrakten Klasse, die kernige Leistungstelemetrielogik enthält.

new PerformanceClient(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>, abbreviations?: Map<string, string>)

Parameter

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

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

Parameter

Registriert eine Rückruffunktion, um Leistungsereignisse zu empfangen.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameter

Gibt zurück

Fügt dem QueueMeasurements-Array für die angegebene Korrelations-ID Die Warteschlangenmesszeit hinzu.

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

Parameter

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

Gibt zurück

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

function discardMeasurements(correlationId: string)

Parameter

Gibt Ereignisse an alle registrierten Rückrufe aus.

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

Parameter

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

Gibt zurück

Generiert und gibt eine eindeutige ID zurück, in der Regel eine GUID.

function generateId(): string

Gibt zurück

Ruft die Zuordnung von Vorwarteschlangenzeiten nach Korrelations-ID ab.

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

Parameter

Gibt zurück

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

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

Parameter

Entfernt einen mit addPerformanceCallback registrierten Rückruf.

function removePerformanceCallback(callbackId: string): boolean

Parameter

Gibt zurück

Legt die Zeit vor der Warteschlange nach Korrelations-ID fest.

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

Parameter

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

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

Parameter

Gibt zurück

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

Gibt zurück