PerformanceClient class
생성자
| Performance |
핵심 성능 원격 분석 논리를 포함하는 추상 클래스인 PerformanceClient의 인스턴스를 만듭니다. |
메서드
| add |
측정값이 플러시될 때 내보내는 추가 정보를 저장합니다. |
| add |
성능 이벤트를 수신하도록 콜백 함수를 등록합니다. |
| add |
지정된 상관 관계 ID에 대한 QueueMeasurements 배열에 큐 측정 시간을 추가합니다. |
| calculate |
함수가 큐에 대기된 현재 시간과 시간의 차이를 계산합니다. 참고: 현재 시간과 대기 중인 시간이 같으면 큐 시간으로 0을 가질 수 있습니다. |
| discard |
지정된 상관 관계 ID에 대한 측정값 및 보조 데이터를 제거합니다. |
| emit |
등록된 모든 콜백에 이벤트를 내보냅니다. |
| end |
작업의 성능 측정을 중지합니다. 소비자가 startMeasurement에서 반환하는 함수를 대신 사용해야 하므로 PerformanceClient 클래스에서만 직접 호출해야 합니다. 하위 측정에 "[이벤트 이름]DurationMs"라는 새 필드를 추가하고, 그렇지 않으면 이벤트를 완료하고 내보낼 수 있습니다. |
| generate |
고유 ID(일반적으로 guid)를 생성하고 반환합니다. |
| get |
상관 관계 ID별 사전 큐 시간 맵을 가져옵니다. |
| increment |
측정값이 플러시될 때 내보낸 증분 카운터 |
| remove |
addPerformanceCallback에 등록된 콜백을 제거합니다. |
| set |
상관 관계 ID별로 큐 전 시간 설정 |
| start |
지정된 작업에 대한 성능 측정을 시작합니다. 측정을 종료하는 데 사용해야 하는 함수를 반환합니다. |
| start |
IPerformanceMeasurement의 플랫폼별 구현을 시작하고 반환합니다. 참고: 이 함수는 다음 주 버전 범프에서 추상으로 변경할 수 있습니다. |
생성자 세부 정보
PerformanceClient(string, string, Logger, string, string, ApplicationTelemetry, Set<string>, Map<string, string>)
핵심 성능 원격 분석 논리를 포함하는 추상 클래스인 PerformanceClient의 인스턴스를 만듭니다.
new PerformanceClient(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>, abbreviations?: Map<string, string>)
매개 변수
- clientId
-
string
애플리케이션의 클라이언트 ID
- authority
-
string
애플리케이션에서 사용하는 기관
- logger
- Logger
애플리케이션에서 사용하는 로거
- libraryName
-
string
라이브러리의 이름
- libraryVersion
-
string
라이브러리 버전
- applicationTelemetry
- ApplicationTelemetry
애플리케이션 이름 및 버전
- intFields
-
Set<string>
잘리는 정수 필드
- abbreviations
-
Map<string, string>
이벤트 이름 약어
메서드 세부 정보
addFields({[key: string]: {} | undefined}, string)
측정값이 플러시될 때 내보내는 추가 정보를 저장합니다.
function addFields(fields: {[key: string]: {} | undefined}, correlationId: string)
매개 변수
- fields
-
{[key: string]: {} | undefined}
- correlationId
-
string
addPerformanceCallback(PerformanceCallbackFunction)
성능 이벤트를 수신하도록 콜백 함수를 등록합니다.
function addPerformanceCallback(callback: PerformanceCallbackFunction): string
매개 변수
- callback
- PerformanceCallbackFunction
반품
string
addQueueMeasurement(string, string, number, boolean)
지정된 상관 관계 ID에 대한 QueueMeasurements 배열에 큐 측정 시간을 추가합니다.
function addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean)
매개 변수
- eventName
-
string
- correlationId
-
string
- queueTime
-
number
- manuallyCompleted
-
boolean
수동으로 완료된 큐 측정에 대한 표시기
calculateQueuedTime(number, number)
함수가 큐에 대기된 현재 시간과 시간의 차이를 계산합니다. 참고: 현재 시간과 대기 중인 시간이 같으면 큐 시간으로 0을 가질 수 있습니다.
function calculateQueuedTime(preQueueTime: number, currentTime: number): number
매개 변수
- preQueueTime
-
number
- currentTime
-
number
반품
number
discardMeasurements(string)
지정된 상관 관계 ID에 대한 측정값 및 보조 데이터를 제거합니다.
function discardMeasurements(correlationId: string)
매개 변수
- correlationId
-
string
emitEvents(PerformanceEvent[], string)
등록된 모든 콜백에 이벤트를 내보냅니다.
function emitEvents(events: PerformanceEvent[], correlationId?: string)
매개 변수
- events
- correlationId
-
string
endMeasurement(PerformanceEvent, unknown, AccountInfo)
작업의 성능 측정을 중지합니다. 소비자가 startMeasurement에서 반환하는 함수를 대신 사용해야 하므로 PerformanceClient 클래스에서만 직접 호출해야 합니다. 하위 측정에 "[이벤트 이름]DurationMs"라는 새 필드를 추가하고, 그렇지 않으면 이벤트를 완료하고 내보낼 수 있습니다.
function endMeasurement(event: PerformanceEvent, error?: unknown, account?: AccountInfo): null | PerformanceEvent
매개 변수
- event
- PerformanceEvent
- error
-
unknown
- account
- AccountInfo
반품
null | PerformanceEvent
generateId()
고유 ID(일반적으로 guid)를 생성하고 반환합니다.
function generateId(): string
반품
string
getPreQueueTime(string, string)
상관 관계 ID별 사전 큐 시간 맵을 가져옵니다.
function getPreQueueTime(eventName: string, correlationId: string): number | void
매개 변수
- eventName
-
string
- correlationId
-
string
반품
number | void
incrementFields({[key: string]: number | undefined}, string)
측정값이 플러시될 때 내보낸 증분 카운터
function incrementFields(fields: {[key: string]: number | undefined}, correlationId: string)
매개 변수
- fields
-
{[key: string]: number | undefined}
{string[]}
- correlationId
-
string
{string} 상관 관계 식별자
removePerformanceCallback(string)
addPerformanceCallback에 등록된 콜백을 제거합니다.
function removePerformanceCallback(callbackId: string): boolean
매개 변수
- callbackId
-
string
반품
boolean
setPreQueueTime(PerformanceEvents, string)
상관 관계 ID별로 큐 전 시간 설정
function setPreQueueTime(eventName: PerformanceEvents, correlationId?: string)
매개 변수
- eventName
- PerformanceEvents
- correlationId
-
string
startMeasurement(string, string)
지정된 작업에 대한 성능 측정을 시작합니다. 측정을 종료하는 데 사용해야 하는 함수를 반환합니다.
function startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent
매개 변수
- measureName
-
string
- correlationId
-
string
반품
startPerformanceMeasurement(string, string)
경고
이 API는 이제 사용되지 않습니다.
This method will be removed in the next major version
IPerformanceMeasurement의 플랫폼별 구현을 시작하고 반환합니다. 참고: 이 함수는 다음 주 버전 범프에서 추상으로 변경할 수 있습니다.
function startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement
매개 변수
- measureName
-
string
- correlationId
-
string