OpenTelemetryScope class

Balíček:

@microsoft/agents-a365-observability

Základní třída pro obory trasování OpenTelemetry

Metody

dispose()	Starší metoda Dispose pro zajištění kompatibility
getSpanContext()	Získá kontext rozsahu pro tento obor. To lze použít k vytvoření ParentSpanRef pro explicitní propojení nadřazené-podřízené přes async hranice.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Zaznamenává několik párů klíč/hodnota atributu pro sledování telemetrie.
recordCancellation(string)	Zaznamenává událost zrušení v rozsahu. Nastaví stav rozsahu na ERROR s důvodem zrušení a označí typ chyby jako TaskCanceledException.
recordError(Error)	Zaznamenává chybu, ke které došlo během operace.
setEndTime(TimeInput)	Nastaví vlastní koncový čas oboru. Při nastavení funkce Dispose tuto hodnotu span.end() předá místo použití aktuálního času na zdi. To je užitečné, když je skutečný čas ukončení operace známý před odstraněním oboru.
withActiveSpanAsync<T>(() => Promise<T>)	Nastaví toto rozsah aktivní po dobu provádění asynchronního zpětného volání.

Podrobnosti metody

dispose()

Starší metoda Dispose pro zajištění kompatibility

function dispose()

getSpanContext()

Získá kontext rozsahu pro tento obor. To lze použít k vytvoření ParentSpanRef pro explicitní propojení nadřazené-podřízené přes async hranice.

function getSpanContext(): SpanContext

Návraty

SpanContext

SpanContext obsahující traceId a spanId

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

Zaznamenává několik párů klíč/hodnota atributu pro sledování telemetrie.

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

Parametry

attributes

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

Kolekce párů klíč/hodnota atributu (pole nebo iterable z [klíč, hodnota] nebo mapování objektů).

recordCancellation(string)

Zaznamenává událost zrušení v rozsahu. Nastaví stav rozsahu na ERROR s důvodem zrušení a označí typ chyby jako TaskCanceledException.

function recordCancellation(reason?: string)

Parametry

reason

string

Volitelný důvod zrušení Výchozí hodnota je "Úkol byl zrušen".

recordError(Error)

Zaznamenává chybu, ke které došlo během operace.

function recordError(error: Error)

Parametry

error

Error

Chyba, která nastala

setEndTime(TimeInput)

Nastaví vlastní koncový čas oboru. Při nastavení funkce Dispose tuto hodnotu span.end() předá místo použití aktuálního času na zdi. To je užitečné, když je skutečný čas ukončení operace známý před odstraněním oboru.

function setEndTime(endTime: TimeInput)

Parametry

endTime

TimeInput

Koncový čas jako milisekundy od epochy, data nebo řazené kolekce členů HrTime.

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

Nastaví toto rozsah aktivní po dobu provádění asynchronního zpětného volání.

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

Parametry

callback

() => Promise<T>

Návraty

Promise<T>