OpenTelemetryScope class

Пакет:

@microsoft/agents-a365-observability

Базовый класс для областей трассировки OpenTelemetry

Методы

dispose()	Устаревший метод удаления для совместимости
getSpanContext()	Возвращает контекст диапазона для этой области. Это можно использовать для создания объекта ParentSpanRef для явного связывания родительского-дочернего элемента между асинхронными границами.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Записывает несколько пар "ключ-значение" для отслеживания телеметрии.
recordCancellation(string)	Записывает событие отмены в диапазоне. Задает состояние диапазона ERROR с причиной отмены и помечает тип ошибки как TaskCanceledException.
recordError(Error)	Записывает ошибку, которая произошла во время операции
setEndTime(TimeInput)	Задает настраиваемое время окончания области. Если задано, удаление будет передавать это значение span.end() вместо использования текущего времени настенные часы. Это полезно, если фактическое время окончания операции известно до удаления области.
withActiveSpanAsync<T>(() => Promise<T>)	Делает этот диапазон активным в течение длительности асинхронного выполнения обратного вызова

Сведения о методе

dispose()

Устаревший метод удаления для совместимости

function dispose()

getSpanContext()

Возвращает контекст диапазона для этой области. Это можно использовать для создания объекта ParentSpanRef для явного связывания родительского-дочернего элемента между асинхронными границами.

function getSpanContext(): SpanContext

Возвращаемое значение

SpanContext

SpanContext, содержащий traceId и spanId

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

Записывает несколько пар "ключ-значение" для отслеживания телеметрии.

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

Параметры

attributes

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

Коллекция пар "ключ-значение" атрибута (массив или итерация [ключ, значение] или карта объектов).

recordCancellation(string)

Записывает событие отмены в диапазоне. Задает состояние диапазона ERROR с причиной отмены и помечает тип ошибки как TaskCanceledException.

function recordCancellation(reason?: string)

Параметры

reason

string

Необязательная причина отмены. По умолчанию значение "Задача отменена".

recordError(Error)

Записывает ошибку, которая произошла во время операции

function recordError(error: Error)

Параметры

error

Error

Ошибка, которая произошла

setEndTime(TimeInput)

Задает настраиваемое время окончания области. Если задано, удаление будет передавать это значение span.end() вместо использования текущего времени настенные часы. Это полезно, если фактическое время окончания операции известно до удаления области.

function setEndTime(endTime: TimeInput)

Параметры

endTime

TimeInput

Время окончания в миллисекундах с эпохи, даты или кортежа HrTime.

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

Делает этот диапазон активным в течение длительности асинхронного выполнения обратного вызова

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

Параметры

callback

() => Promise<T>

Возвращаемое значение

Promise<T>