OpenTelemetryScope class

Paket:

@microsoft/agents-a365-observability

OpenTelemetry izleme kapsamları için temel sınıf

Yöntemler

dispose()	Uyumluluk için eski dispose yöntemi
getSpanContext()	Bu kapsam için span bağlamını alır. Bu, zaman uyumsuz sınırlar arasında açık üst-alt bağlantı için bir ParentSpanRef oluşturmak için kullanılabilir.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Telemetri izleme için birden çok öznitelik anahtarı/değer çifti kaydeder.
recordCancellation(string)	Yayılma alanındaki bir iptal olayını kaydeder. İptal nedeni ile span durumunu ERROR olarak ayarlar ve hata türünü 'TaskCanceledException' olarak işaretler.
recordError(Error)	İşlem sırasında oluşan bir hatayı kaydeder
setEndTime(TimeInput)	Kapsam için özel bir bitiş zamanı ayarlar. Ayarlandığında, dispose geçerli duvar saati saatini kullanmak yerine bu değeri 'a span.end() geçirir. Bu, kapsam atılmadan önce işlemin gerçek bitiş zamanı bilindiğinde yararlıdır.
withActiveSpanAsync<T>(() => Promise<T>)	Zaman uyumsuz geri çağırma yürütme süresi boyunca bu yayılma alanını etkin hale getirir

Yöntem Ayrıntıları

dispose()

Uyumluluk için eski dispose yöntemi

function dispose()

getSpanContext()

Bu kapsam için span bağlamını alır. Bu, zaman uyumsuz sınırlar arasında açık üst-alt bağlantı için bir ParentSpanRef oluşturmak için kullanılabilir.

function getSpanContext(): SpanContext

Döndürülenler

SpanContext

traceId ve spanId içeren SpanContext

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

Telemetri izleme için birden çok öznitelik anahtarı/değer çifti kaydeder.

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

Parametreler

attributes

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

Öznitelik anahtarı/değer çiftleri koleksiyonu ([anahtar, değer] veya nesne eşlemesinin dizisi veya yinelenebilir olması).

recordCancellation(string)

Yayılma alanındaki bir iptal olayını kaydeder. İptal nedeni ile span durumunu ERROR olarak ayarlar ve hata türünü 'TaskCanceledException' olarak işaretler.

function recordCancellation(reason?: string)

Parametreler

reason

string

İsteğe bağlı iptal nedeni. Varsayılan olarak 'Görev iptal edildi'.

recordError(Error)

İşlem sırasında oluşan bir hatayı kaydeder

function recordError(error: Error)

Parametreler

error

Error

Meydana gelen hata

setEndTime(TimeInput)

Kapsam için özel bir bitiş zamanı ayarlar. Ayarlandığında, dispose geçerli duvar saati saatini kullanmak yerine bu değeri 'a span.end() geçirir. Bu, kapsam atılmadan önce işlemin gerçek bitiş zamanı bilindiğinde yararlıdır.

function setEndTime(endTime: TimeInput)

Parametreler

endTime

TimeInput

Dönem, Tarih veya HrTime demetlerinden bu yana geçen bitiş süresi milisaniyedir.

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

Zaman uyumsuz geri çağırma yürütme süresi boyunca bu yayılma alanını etkin hale getirir

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

Parametreler

callback

() => Promise<T>

Döndürülenler

Promise<T>