OpenTelemetryScope class

Pakke:

@microsoft/agents-a365-observability

Basisklasse for OpenTelemetry-sporingsomfang

Metoder

dispose()	Eldre fjerningsmetode for kompatibilitet
getSpanContext()	Henter span-konteksten for dette omfanget. Dette kan brukes til å opprette en ParentSpanRef for eksplisitt overordnet-underordnet kobling på tvers av aynkrone grenser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registrerer flere attributtnøkkel-/verdipar for telemetrisporing.
recordCancellation(string)	Registrerer en avlysningshendelse i tidsrommet. Angir span-statusen til ERROR med årsaken til kanselleringen, og merker feiltypen som TaskCanceledException.
recordError(Error)	Registrerer en feil som oppstod under operasjonen
setEndTime(TimeInput)	Angir et egendefinert sluttidspunkt for omfanget. Når den er angitt, sendes denne verdien til i stedet for å span.end() bruke gjeldende veggklokketid. Dette er nyttig når det faktiske sluttidspunktet for operasjonen er kjent før omfanget fjernes.
withActiveSpanAsync<T>(() => Promise<T>)	Gjør dette tidsrommet aktivt for varigheten av den aynkrone tilbakeringingskjøringen

Metodedetaljer

dispose()

Eldre fjerningsmetode for kompatibilitet

function dispose()

getSpanContext()

Henter span-konteksten for dette omfanget. Dette kan brukes til å opprette en ParentSpanRef for eksplisitt overordnet-underordnet kobling på tvers av aynkrone grenser.

function getSpanContext(): SpanContext

Returnerer

SpanContext

SpanContext som inneholder traceId og spanId

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

Registrerer flere attributtnøkkel-/verdipar for telemetrisporing.

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

Parametere

attributes

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

Samling av attributtnøkkel-/verdipar (matrise eller iterbar for [nøkkel, verdi] eller objektkart).

recordCancellation(string)

Registrerer en avlysningshendelse i tidsrommet. Angir span-statusen til ERROR med årsaken til kanselleringen, og merker feiltypen som TaskCanceledException.

function recordCancellation(reason?: string)

Parametere

reason

string

Valgfri annulleringsårsak. Standardinnstillingene for «Oppgaven ble avbrutt».

recordError(Error)

Registrerer en feil som oppstod under operasjonen

function recordError(error: Error)

Parametere

error

Error

Feilen som oppstod

setEndTime(TimeInput)

Angir et egendefinert sluttidspunkt for omfanget. Når den er angitt, sendes denne verdien til i stedet for å span.end() bruke gjeldende veggklokketid. Dette er nyttig når det faktiske sluttidspunktet for operasjonen er kjent før omfanget fjernes.

function setEndTime(endTime: TimeInput)

Parametere

endTime

TimeInput

Sluttidspunktet som millisekunder siden epoke, dato eller hrtime tuppel.

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

Gjør dette tidsrommet aktivt for varigheten av den aynkrone tilbakeringingskjøringen

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

Parametere

callback

() => Promise<T>

Returnerer

Promise<T>