BaggageBuilder class

Pakke:

@microsoft/agents-a365-observability

Per forespørsel baggage builder for OpenTelemetry kontekst overføring.

Denne klassen gir en flytende API for å angi bagasjeverdier som skal overføres i OpenTelemetry-konteksten.

Eksempel

const scope = new BaggageBuilder()
  .tenantId("tenant-123")
  .agentId("agent-456")
  .build();

scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context

Metoder

agentAuid(undefined | null | string)	Angi auid-bagasjeverdien for agenten.
agentBlueprintId(undefined | null | string)	Angi agentens plantegnings-ID-bagasjeverdi.
agentDescription(undefined | null | string)	Angi beskrivelsesverdien for agentbeskrivelsen.
agentEmail(undefined | null | string)	Angi verdien for agentens e-postbagasje.
agentId(undefined | null | string)	Angi agent-ID-bagasjeverdien.
agentName(undefined | null | string)	Angi agentens navnebagasjeverdi.
agentPlatformId(undefined | null | string)	Angi agentplattformens ID-bagasjeverdi.
agentVersion(undefined | null | string)	Angi verdi for agentversjon av bagasje.
build()	Bruk den innsamlede bagasjen i gjeldende kontekst.
callerAgentPlatformId(undefined | null | string)	Angi innkallingsagentens plattform-ID-bagasjeverdi.
callerClientIp(undefined | null | string)	Angi ip-bagasjeverdien for anroperklienten. Brukes til å registrere ip-adressen for den opprinnelige klienten for forespørselen, slik at den kan overføres via OpenTelemetry-bagasje.
channelLink(undefined | null | string)	Angi kanalkoblingen/URL-adressen.
channelName(undefined | null | string)	Angi kanalnavnet (f.eks. Teams, Slack).
conversationId(undefined | null | string)	Angi verdi for samtale-ID-bagasje.
conversationItemLink(undefined | null | string)	Angi verdi for koblingsbagasje for samtaleelementet.
invokeAgentServer(undefined | null | string, number)	Angir serveradressen for aktiveringsagenten og portbagasjeverdiene.
operationSource(undefined | null | string)	Angi verdien for brukskildebagasjen. Brukes for serverspenn for å identifisere tjenesten (f.eks. ATG, ACF).
sessionDescription(undefined | null | string)	Angi bagasjeverdien for øktbeskrivelsen.
sessionId(string)	Angi økt-ID-bagasjeverdien.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Angi flere bagasjepar fra en ordliste eller iterbar.
setRequestContext(null | string, null | string)	Praktisk metode for å starte et forespørselsbagasjeomfang med vanlige felt.
tenantId(undefined | null | string)	Angi leier-ID-bagasjeverdien.
userEmail(undefined | null | string)	Angi brukerens verdi for e-postbagasje.
userId(undefined | null | string)	Angi bruker-ID-bagasjeverdien.
userName(undefined | null | string)	Angi brukernavnets bagasjeverdi.

Metodedetaljer

agentAuid(undefined | null | string)

Angi auid-bagasjeverdien for agenten.

function agentAuid(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agenten AUID

Returnerer

BaggageBuilder

Selv for metodekjedering

agentBlueprintId(undefined | null | string)

Angi agentens plantegnings-ID-bagasjeverdi.

function agentBlueprintId(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agenttegnings-ID

Returnerer

BaggageBuilder

Selv for metodekjedering

agentDescription(undefined | null | string)

Angi beskrivelsesverdien for agentbeskrivelsen.

function agentDescription(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agentbeskrivelsen

Returnerer

BaggageBuilder

Selv for metodekjedering

agentEmail(undefined | null | string)

Angi verdien for agentens e-postbagasje.

function agentEmail(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agentens e-post

Returnerer

BaggageBuilder

Selv for metodekjedering

agentId(undefined | null | string)

Angi agent-ID-bagasjeverdien.

function agentId(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agent-IDen

Returnerer

BaggageBuilder

Selv for metodekjedering

agentName(undefined | null | string)

Angi agentens navnebagasjeverdi.

function agentName(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agentnavnet

Returnerer

BaggageBuilder

Selv for metodekjedering

agentPlatformId(undefined | null | string)

Angi agentplattformens ID-bagasjeverdi.

function agentPlatformId(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agentplattform-ID

Returnerer

BaggageBuilder

Selv for metodekjedering

agentVersion(undefined | null | string)

Angi verdi for agentversjon av bagasje.

function agentVersion(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Agentversjonen (f.eks. '1.0.0', '2025-05-01')

Returnerer

BaggageBuilder

Selv for metodekjedering

build()

Bruk den innsamlede bagasjen i gjeldende kontekst.

function build(): BaggageScope

Returnerer

BaggageScope

En kontekstbehandling som gjenoppretter den forrige bagasjen ved utgang

callerAgentPlatformId(undefined | null | string)

Angi innkallingsagentens plattform-ID-bagasjeverdi.

function callerAgentPlatformId(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Plattformidentifikatoren for innringeragenten

Returnerer

BaggageBuilder

Selv for metodekjedering

callerClientIp(undefined | null | string)

Angi ip-bagasjeverdien for anroperklienten. Brukes til å registrere ip-adressen for den opprinnelige klienten for forespørselen, slik at den kan overføres via OpenTelemetry-bagasje.

function callerClientIp(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

IP-adressen til oppringerklienten

Returnerer

BaggageBuilder

Selv for metodekjedering

channelLink(undefined | null | string)

Angi kanalkoblingen/URL-adressen.

function channelLink(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Kanalkoblingen

Returnerer

BaggageBuilder

Selv for metodekjedering

channelName(undefined | null | string)

Angi kanalnavnet (f.eks. Teams, Slack).

function channelName(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Kanalnavnet

Returnerer

BaggageBuilder

Selv for metodekjedering

conversationId(undefined | null | string)

Angi verdi for samtale-ID-bagasje.

function conversationId(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Samtale-ID-en

Returnerer

BaggageBuilder

Selv for metodekjedering

conversationItemLink(undefined | null | string)

Angi verdi for koblingsbagasje for samtaleelementet.

function conversationItemLink(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Koblingen til samtaleelementet

Returnerer

BaggageBuilder

Selv for metodekjedering

invokeAgentServer(undefined | null | string, number)

Angir serveradressen for aktiveringsagenten og portbagasjeverdiene.

function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilder

Parametere

address

undefined | null | string

Serveradressen (vertsnavnet) til målagenttjenesten.

port

number

Valgfri serverport. Bare registrert når forskjellig fra 443.

Returnerer

BaggageBuilder

Gjeldende byggherreforekomst for metodekjedering.

operationSource(undefined | null | string)

Angi verdien for brukskildebagasjen. Brukes for serverspenn for å identifisere tjenesten (f.eks. ATG, ACF).

function operationSource(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Operasjonskilden

Returnerer

BaggageBuilder

Selv for metodekjedering

sessionDescription(undefined | null | string)

Angi bagasjeverdien for øktbeskrivelsen.

function sessionDescription(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Øktbeskrivelsen

Returnerer

BaggageBuilder

Selv for metodekjedering

sessionId(string)

Angi økt-ID-bagasjeverdien.

function sessionId(value: string): BaggageBuilder

Parametere

value

string

Økt-ID-en

Returnerer

BaggageBuilder

Selv for metodekjedering

setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)

Angi flere bagasjepar fra en ordliste eller iterbar.

function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilder

Parametere

pairs

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

Ordliste eller gjentakelse av nøkkelverdipar

Returnerer

BaggageBuilder

Selv for metodekjedering

setRequestContext(null | string, null | string)

Praktisk metode for å starte et forespørselsbagasjeomfang med vanlige felt.

static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScope

Parametere

tenantId

null | string

Leier-ID-en

agentId

null | string

Agent-IDen

Returnerer

BaggageScope

En kontekstbehandling som gjenoppretter den forrige bagasjen ved utgang

tenantId(undefined | null | string)

Angi leier-ID-bagasjeverdien.

function tenantId(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Leier-ID-en

Returnerer

BaggageBuilder

Selv for metodekjedering

userEmail(undefined | null | string)

Angi brukerens verdi for e-postbagasje.

function userEmail(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Brukerens e-post

Returnerer

BaggageBuilder

Selv for metodekjedering

userId(undefined | null | string)

Angi bruker-ID-bagasjeverdien.

function userId(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Bruker-ID-en

Returnerer

BaggageBuilder

Selv for metodekjedering

userName(undefined | null | string)

Angi brukernavnets bagasjeverdi.

function userName(value: undefined | null | string): BaggageBuilder

Parametere

value

undefined | null | string

Brukernavnet

Returnerer

BaggageBuilder

Selv for metodekjedering