BrowserPerformanceClient class
- Extends
Metoder
| add |
Beräknar och lägger till kötidsmätning för angiven prestandahändelse. |
| generate |
|
| set |
Lägger till förkötid till preQueueTimeByCorrelationId-karta. |
| start |
Börjar mäta prestanda för en viss åtgärd. Returnerar en funktion som ska användas för att avsluta mätningen. Samlar även in webbläsarsidans synlighetState. |
Ärvda metoder
| add |
Sparar extra information som ska genereras när mätningarna töms |
| add |
Registrerar en återanropsfunktion för att ta emot prestandahändelser. |
| calculate |
Beräknar skillnaden mellan aktuell tid och tid när funktionen köades. Obs! Det går att ha 0 som kötid om den aktuella tiden och den köade tiden var densamma. |
| discard |
Tar bort mått och aux-data för ett visst korrelations-ID. |
| emit |
Genererar händelser till alla registrerade återanrop. |
| end |
Stoppar mätning av prestanda för en åtgärd. Bör bara anropas direkt av PerformanceClient-klasser, eftersom konsumenterna i stället bör använda funktionen som returneras av startMeasurement. Lägger till ett nytt fält med namnet "[event name]DurationMs" för undermätningar, slutför och genererar en händelse i annat fall. |
| get |
Hämtar karta över tider före kön efter korrelations-ID |
| increment |
Öka räknare som ska genereras när mätningarna töms |
| remove |
Tar bort ett återanrop som registrerats med addPerformanceCallback. |
| start |
Startar och returnerar en plattformsspecifik implementering av IPerformanceMeasurement. Obs! Den här funktionen kan ändras till abstrakt vid nästa större versionsuppbubbel. |
Konstruktorinformation
BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)
new BrowserPerformanceClient(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>)
Parametrar
- configuration
- Configuration
- intFields
-
Set<string>
- abbreviations
-
Map<string, string>
Metodinformation
addQueueMeasurement(string, string, number, boolean)
Beräknar och lägger till kötidsmätning för angiven prestandahändelse.
function addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean)
Parametrar
- eventName
-
string
- correlationId
-
string
- queueTime
-
number
- manuallyCompleted
-
boolean
indikator för manuellt slutförda kömätningar
generateId()
function generateId(): string
Returer
string
setPreQueueTime(PerformanceEvents, string)
Lägger till förkötid till preQueueTimeByCorrelationId-karta.
function setPreQueueTime(eventName: PerformanceEvents, correlationId?: string)
Parametrar
- eventName
- PerformanceEvents
- correlationId
-
string
startMeasurement(string, string)
Börjar mäta prestanda för en viss åtgärd. Returnerar en funktion som ska användas för att avsluta mätningen. Samlar även in webbläsarsidans synlighetState.
function startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent
Parametrar
- measureName
-
string
- correlationId
-
string
Returer
Ärvd metodinformation
addFields({[key: string]: {} | undefined}, string)
Sparar extra information som ska genereras när mätningarna töms
function addFields(fields: {[key: string]: {} | undefined}, correlationId: string)
Parametrar
- fields
-
{[key: string]: {} | undefined}
- correlationId
-
string
Ärvd från PerformanceClient.addFields
addPerformanceCallback(PerformanceCallbackFunction)
Registrerar en återanropsfunktion för att ta emot prestandahändelser.
function addPerformanceCallback(callback: PerformanceCallbackFunction): string
Parametrar
- callback
- PerformanceCallbackFunction
Returer
string
Ärvd från PerformanceClient.addPerformanceCallback
calculateQueuedTime(number, number)
Beräknar skillnaden mellan aktuell tid och tid när funktionen köades. Obs! Det går att ha 0 som kötid om den aktuella tiden och den köade tiden var densamma.
function calculateQueuedTime(preQueueTime: number, currentTime: number): number
Parametrar
- preQueueTime
-
number
- currentTime
-
number
Returer
number
Ärvd från PerformanceClient.calculateQueuedTime
discardMeasurements(string)
Tar bort mått och aux-data för ett visst korrelations-ID.
function discardMeasurements(correlationId: string)
Parametrar
- correlationId
-
string
Ärvd från PerformanceClient.discardMeasurements
emitEvents(PerformanceEvent[], string)
Genererar händelser till alla registrerade återanrop.
function emitEvents(events: PerformanceEvent[], correlationId?: string)
Parametrar
- events
- correlationId
-
string
Ärvd från PerformanceClient.emitEvents
endMeasurement(PerformanceEvent, unknown, AccountInfo)
Stoppar mätning av prestanda för en åtgärd. Bör bara anropas direkt av PerformanceClient-klasser, eftersom konsumenterna i stället bör använda funktionen som returneras av startMeasurement. Lägger till ett nytt fält med namnet "[event name]DurationMs" för undermätningar, slutför och genererar en händelse i annat fall.
function endMeasurement(event: PerformanceEvent, error?: unknown, account?: AccountInfo): null | PerformanceEvent
Parametrar
- event
- PerformanceEvent
- error
-
unknown
- account
- AccountInfo
Returer
null | PerformanceEvent
Ärvd från PerformanceClient.endMeasurement
getPreQueueTime(string, string)
Hämtar karta över tider före kön efter korrelations-ID
function getPreQueueTime(eventName: string, correlationId: string): number | void
Parametrar
- eventName
-
string
- correlationId
-
string
Returer
number | void
Ärvd från PerformanceClient.getPreQueueTime
incrementFields({[key: string]: number | undefined}, string)
Öka räknare som ska genereras när mätningarna töms
function incrementFields(fields: {[key: string]: number | undefined}, correlationId: string)
Parametrar
- fields
-
{[key: string]: number | undefined}
{string[]}
- correlationId
-
string
Korrelationsidentifierare för {string}
Ärvd från PerformanceClient.incrementFields
removePerformanceCallback(string)
Tar bort ett återanrop som registrerats med addPerformanceCallback.
function removePerformanceCallback(callbackId: string): boolean
Parametrar
- callbackId
-
string
Returer
boolean
Ärvd från PerformanceClient.removePerformanceCallback
startPerformanceMeasurement(string, string)
Varning
Det här API:et är nu inaktuellt.
This method will be removed in the next major version
Startar och returnerar en plattformsspecifik implementering av IPerformanceMeasurement. Obs! Den här funktionen kan ändras till abstrakt vid nästa större versionsuppbubbel.
function startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement
Parametrar
- measureName
-
string
- correlationId
-
string
Returer
Ärvd från PerformanceClient.startPerformanceMeasurement