OpenTelemetryScope class

Paket:

@microsoft/agents-a365-observability

Basklass för OpenTelemetry-spårningsomfång

Metoder

dispose()	Äldre bortskaffningsmetod för kompatibilitet
getSpanContext()	Hämtar span-kontexten för det här omfånget. Detta kan användas för att skapa en ParentSpanRef för explicit överordnad-underordnad länkning över asynkrona gränser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registrerar flera attributnyckel/värdepar för telemetrispårning.
recordCancellation(string)	Registrerar en annulleringshändelse i intervallet. Anger span-statusen till FEL med avbokningsorsaken och markerar feltypen som "TaskCanceledException".
recordError(Error)	Registrerar ett fel som inträffade under åtgärden
setEndTime(TimeInput)	Anger en anpassad sluttid för omfånget. När värdet har angetts skickas det här värdet till span.end() i stället för den aktuella tidsåtgången för väggklockan. Detta är användbart när den faktiska sluttiden för åtgärden är känd innan omfånget tas bort.
withActiveSpanAsync<T>(() => Promise<T>)	Gör det här intervallet aktivt under hela körningen av asynkron återanrop

Metodinformation

dispose()

Äldre bortskaffningsmetod för kompatibilitet

function dispose()

getSpanContext()

Hämtar span-kontexten för det här omfånget. Detta kan användas för att skapa en ParentSpanRef för explicit överordnad-underordnad länkning över asynkrona gränser.

function getSpanContext(): SpanContext

Returer

SpanContext

SpanContext som innehåller traceId och spanId

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

Registrerar flera attributnyckel/värdepar för telemetrispårning.

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

Parametrar

attributes

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

Samling attributnyckel/värdepar (matris eller itererbar för [nyckel, värde] eller objektkarta).

recordCancellation(string)

Registrerar en annulleringshändelse i intervallet. Anger span-statusen till FEL med avbokningsorsaken och markerar feltypen som "TaskCanceledException".

function recordCancellation(reason?: string)

Parametrar

reason

string

Valfri avbokningsorsak. Standardvärdet är "Aktiviteten avbröts".

recordError(Error)

Registrerar ett fel som inträffade under åtgärden

function recordError(error: Error)

Parametrar

error

Error

Felet som uppstod

setEndTime(TimeInput)

Anger en anpassad sluttid för omfånget. När värdet har angetts skickas det här värdet till span.end() i stället för den aktuella tidsåtgången för väggklockan. Detta är användbart när den faktiska sluttiden för åtgärden är känd innan omfånget tas bort.

function setEndTime(endTime: TimeInput)

Parametrar

endTime

TimeInput

Sluttiden som millisekunder sedan epoken, ett datum eller en HrTime-tupplar.

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

Gör det här intervallet aktivt under hela körningen av asynkron återanrop

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

Parametrar

callback

() => Promise<T>

Returer

Promise<T>