OpenTelemetryScope class

Pakket:

@microsoft/agents-a365-observability

Basisklasse voor OpenTelemetry-traceringsbereiken

Methoden

dispose()	Verouderde verwijderingsmethode voor compatibiliteit
getSpanContext()	Hiermee haalt u de spancontext voor dit bereik op. Dit kan worden gebruikt om een ParentSpanRef te maken voor expliciete bovenliggende en onderliggende koppelingen tussen asynchrone grenzen.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registreert meerdere kenmerksleutel-/waardeparen voor telemetrietracering.
recordCancellation(string)	Registreert een annuleringsevenement voor de periode. Hiermee stelt u de spanstatus in op ERROR met de reden van de annulering en wordt het fouttype gemarkeerd als 'TaskCanceledException'.
recordError(Error)	Registreert een fout die is opgetreden tijdens de bewerking
setEndTime(TimeInput)	Hiermee stelt u een aangepaste eindtijd in voor het bereik. Wanneer dit is ingesteld, wordt deze waarde doorgegeven aan span.end() in plaats van de huidige tijd van de wandklok te gebruiken. Dit is handig wanneer de werkelijke eindtijd van de bewerking bekend is voordat het bereik wordt verwijderd.
withActiveSpanAsync<T>(() => Promise<T>)	Hiermee wordt deze periode actief voor de duur van de uitvoering van de asynchrone callback

Methodedetails

dispose()

Verouderde verwijderingsmethode voor compatibiliteit

function dispose()

getSpanContext()

Hiermee haalt u de spancontext voor dit bereik op. Dit kan worden gebruikt om een ParentSpanRef te maken voor expliciete bovenliggende en onderliggende koppelingen tussen asynchrone grenzen.

function getSpanContext(): SpanContext

Retouren

SpanContext

De SpanContext met traceId en spanId

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

Registreert meerdere kenmerksleutel-/waardeparen voor telemetrietracering.

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

Parameters

attributes

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

Verzameling kenmerksleutel-/waardeparen (matrix of itereerbaar van [sleutel, waarde] of objecttoewijzing).

recordCancellation(string)

Registreert een annuleringsevenement voor de periode. Hiermee stelt u de spanstatus in op ERROR met de reden van de annulering en wordt het fouttype gemarkeerd als 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parameters

reason

string

Optionele annuleringsreden. De standaardwaarde is 'Taak is geannuleerd'.

recordError(Error)

Registreert een fout die is opgetreden tijdens de bewerking

function recordError(error: Error)

Parameters

error

Error

De fout die is opgetreden

setEndTime(TimeInput)

Hiermee stelt u een aangepaste eindtijd in voor het bereik. Wanneer dit is ingesteld, wordt deze waarde doorgegeven aan span.end() in plaats van de huidige tijd van de wandklok te gebruiken. Dit is handig wanneer de werkelijke eindtijd van de bewerking bekend is voordat het bereik wordt verwijderd.

function setEndTime(endTime: TimeInput)

Parameters

endTime

TimeInput

De eindtijd als milliseconden sinds epoch, een datum of een HrTime-tuple.

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

Hiermee wordt deze periode actief voor de duur van de uitvoering van de asynchrone callback

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

Parameters

callback

() => Promise<T>

Retouren

Promise<T>