OutputScope class

Paketti:

@microsoft/agents-a365-observability

Tarjoaa OpenTelemetry-jäljitysalueen tulosviestin seurannalle ja ylätason alueen linkitykselle.

Ulottuu

OpenTelemetryScope

Menetelmät

recordOutputMessages(ResponseMessagesParam)	Kirjaa telemetrian seurannan tulosviestit. Korvaa kaikki aiemmin tallennetut tulosteviestit. Hyväksyy yksittäisen merkkijonon, valikoiman merkkijonoja (automaattisesti paketoitu nimellä OTEL OutputMessage), versiona annetun OutputMessages-rivityksen tai raakadiktin (käsitellään työkalukutsutuloksena OTEL-ominaisuuden mukaan, sarjoitettuna suoraan).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	Luo ja käynnistää uuden vaikutusalueen tulost sanoman jäljitystä varten.

Perityt menetelmät

dispose()	Vanha hävitysmenetelmä yhteensopivuuden vuoksi
getSpanContext()	Hakee alueen span-kontekstin. Tämän avulla voidaan luoda ParentSpanRef eksplisiittistä pää-alikohde-linkkiä varten asynkronisten rajojen yli.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Tallentaa useita määriteavain-/arvo-pareja telemetrian seurantaa varten.
recordCancellation(string)	Kirjaa peruuttamistapahtuma ajanjakson aikana. Määrittää tilan ERROR peruuttamisen syyksi ja merkitsee virhetyypiksi "TaskCanceledException".
recordError(Error)	Kirjaa toiminnon aikana ilmennyt virhe
setEndTime(TimeInput)	Määrittää vaikutusalueen mukautetun päättymisajan. Kun asetus on määritetty, hävitys siirtää tämän arvon kohteeseen span.end() nykyisen seinäkellonajan käyttämisen sijaan. Tästä on hyötyä, kun toiminnon todellinen päättymisaika on tiedossa, ennen kuin vaikutusalue on hävitetty.
withActiveSpanAsync<T>(() => Promise<T>)	Tekee tästä ulottumisesta aktiivisen asynkronisen takaisinkutsun suorituksen ajaksi

Menetelmän tiedot

recordOutputMessages(ResponseMessagesParam)

Kirjaa telemetrian seurannan tulosviestit. Korvaa kaikki aiemmin tallennetut tulosteviestit. Hyväksyy yksittäisen merkkijonon, valikoiman merkkijonoja (automaattisesti paketoitu nimellä OTEL OutputMessage), versiona annetun OutputMessages-rivityksen tai raakadiktin (käsitellään työkalukutsutuloksena OTEL-ominaisuuden mukaan, sarjoitettuna suoraan).

function recordOutputMessages(messages: ResponseMessagesParam)

Parametrit

messages

ResponseMessagesParam

Merkkijono, merkkijonomatriisi, OutputMessages-rivitin tai saneltu.

start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Luo ja käynnistää uuden vaikutusalueen tulost sanoman jäljitystä varten.

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

Parametrit

request

Request

Pyynnön tiedot (kanava, keskustelun tunnus, sisältö, istunnon tunnus).

response

OutputResponse

Ensimmäisten tulosteviestien sisältävä vastaus.

agentDetails

AgentDetails

Tuotoksen tuottava agentti. Vuokraajatunnus johdetaan kohteesta agentDetails.tenantId.

userDetails

UserDetails

Valinnaiset ihmissoittajan käyttäjätietojen tiedot.

spanDetails

SpanDetails

Valinnainen span configuration (parentContext, startTime, endTime, spanLinks).

Palautukset

OutputScope

Uusi OutputScope-esiintymä.

Perityn menetelmän tiedot

dispose()

Vanha hävitysmenetelmä yhteensopivuuden vuoksi

function dispose()

PerittyOpenTelemetryScope.dispose-ominaisuudesta

getSpanContext()

Hakee alueen span-kontekstin. Tämän avulla voidaan luoda ParentSpanRef eksplisiittistä pää-alikohde-linkkiä varten asynkronisten rajojen yli.

function getSpanContext(): SpanContext

Palautukset

SpanContext

SpanContext, joka sisältää traceId-tunnuksen ja spanId-arvon

PerittyKohteesta OpenTelemetryScope.getSpanContext

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

Tallentaa useita määriteavain-/arvo-pareja telemetrian seurantaa varten.

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

Parametrit

attributes

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

Määriteavain-/arvoparien kokoelma (matriisi tai kohteen [avain, arvo] tai objektikartta iterable).

Peritty kohteestaOpenTelemetryScope.recordAttributes

recordCancellation(string)

Kirjaa peruuttamistapahtuma ajanjakson aikana. Määrittää tilan ERROR peruuttamisen syyksi ja merkitsee virhetyypiksi "TaskCanceledException".

function recordCancellation(reason?: string)

Parametrit

reason

string

Valinnainen peruutussyy. Oletusarvo on "Tehtävän peruutettu".

Perittykohteesta OpenTelemetryScope.recordCancellation

recordError(Error)

Kirjaa toiminnon aikana ilmennyt virhe

function recordError(error: Error)

Parametrit

error

Error

Tapahtunut virhe

PerittyOpenTelemetryScope.recordError-kohteesta

setEndTime(TimeInput)

Määrittää vaikutusalueen mukautetun päättymisajan. Kun asetus on määritetty, hävitys siirtää tämän arvon kohteeseen span.end() nykyisen seinäkellonajan käyttämisen sijaan. Tästä on hyötyä, kun toiminnon todellinen päättymisaika on tiedossa, ennen kuin vaikutusalue on hävitetty.

function setEndTime(endTime: TimeInput)

Parametrit

endTime

TimeInput

Tämä on päättymisaika millisekunteina aikakaudesta, päivämäärästä tai hrtime-monikkosta.

Perittykohteesta OpenTelemetryScope.setEndTime

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

Tekee tästä ulottumisesta aktiivisen asynkronisen takaisinkutsun suorituksen ajaksi

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

Parametrit

callback

() => Promise<T>

Palautukset

Promise<T>

PerittyOpenTelemetryScope.withActiveSpanAsync