Class PerformanceClientAbstract

Hierarchy

Implements

Constructors

  • Creates an instance of PerformanceClient, an abstract class containing core performance telemetry logic.

    Parameters

    • clientId: string

      Client ID of the application

    • authority: string

      Authority used by the application

    • logger: Logger

      Logger used by the application

    • libraryName: string

      Name of the library

    • libraryVersion: string

      Version of the library

    • applicationTelemetry: ApplicationTelemetry

      application name and version

    • Optional intFields: Set<string>

      integer fields to be truncated

    • Optional abbreviations: Map<string, string>

      event name abbreviations

    Returns PerformanceClient

Methods

  • Adds queue measurement time to QueueMeasurements array for given correlation ID.

    Parameters

    • eventName: string
    • Optional correlationId: string
    • Optional queueTime: number
    • Optional manuallyCompleted: boolean

      indicator for manually completed queue measurements

    Returns void

  • Calculates the difference between current time and time when function was queued. Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.

    Parameters

    • preQueueTime: number
    • currentTime: number

    Returns number

  • Gets map of pre-queue times by correlation Id

    Parameters

    • eventName: string
    • correlationId: string

    Returns number | void

  • Increment counters to be emitted when the measurements are flushed

    Parameters

    • fields: {
          [key: string]: number | undefined;
      }

      {string[]}

      • [key: string]: number | undefined
    • correlationId: string

      {string} correlation identifier

    Returns void

Generated using TypeDoc