OpenTelemetryScope class

Pakke:

@microsoft/agents-a365-observability

Basisklasse for OpenTelemetry-sporingsområder

Metoder

dispose()	Ældre metode til fjernelse af kompatibilitet
getSpanContext()	Henter omfangets kontekst for dette område. Dette kan bruges til at oprette en ParentSpanRef til eksplicit overordnet/underordnet-sammenkædning på tværs af asynkrone grænser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registrerer flere attributnøgle-/værdipar til telemetrisporing.
recordCancellation(string)	Registrerer en annulleringshændelse på området. Angiver status for span til ERROR med annulleringsårsagen og markerer fejltypen som 'TaskCanceledException'.
recordError(Error)	Registrerer en fejl, der opstod under handlingen
setEndTime(TimeInput)	Angiver et brugerdefineret sluttidspunkt for området. Når den er indstillet, overføres denne værdi til i stedet for at span.end() bruge det aktuelle vægklokkeslæt. Dette er nyttigt, når det faktiske sluttidspunkt for handlingen er kendt, før området fjernes.
withActiveSpanAsync<T>(() => Promise<T>)	Gør dette tidsrum aktivt i varigheden af den asynkrone tilbagekaldskørsel

Oplysninger om metode

dispose()

Ældre metode til fjernelse af kompatibilitet

function dispose()

getSpanContext()

Henter omfangets kontekst for dette område. Dette kan bruges til at oprette en ParentSpanRef til eksplicit overordnet/underordnet-sammenkædning på tværs af asynkrone grænser.

function getSpanContext(): SpanContext

Returnerer

SpanContext

SpanContext, der indeholder traceId og spanId

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Registrerer flere attributnøgle-/værdipar til telemetrisporing.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Parametre

attributes

undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>

Samling af attributnøgle-/værdipar (matrix eller iterbar af [nøgle, værdi] eller objekttilknytning).

recordCancellation(string)

Registrerer en annulleringshændelse på området. Angiver status for span til ERROR med annulleringsårsagen og markerer fejltypen som 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parametre

reason

string

Valgfri årsag til annullering. Som standard er "Opgaven blev annulleret".

recordError(Error)

Registrerer en fejl, der opstod under handlingen

function recordError(error: Error)

Parametre

error

Error

Den fejl, der opstod

setEndTime(TimeInput)

Angiver et brugerdefineret sluttidspunkt for området. Når den er indstillet, overføres denne værdi til i stedet for at span.end() bruge det aktuelle vægklokkeslæt. Dette er nyttigt, når det faktiske sluttidspunkt for handlingen er kendt, før området fjernes.

function setEndTime(endTime: TimeInput)

Parametre

endTime

TimeInput

Sluttidspunktet som millisekunder siden epoken, en dato eller en TTime-tupel.

withActiveSpanAsync<T>(() => Promise<T>)

Gør dette tidsrum aktivt i varigheden af den asynkrone tilbagekaldskørsel

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

Parametre

callback

() => Promise<T>

Returnerer

Promise<T>