TracingSpan interface

套件:

@azure/core-tracing

表示與實作無關的追蹤範圍。

方法

addEvent(string, AddEventOptions)	將事件加入至範圍。
end()	結束範圍。
isRecording()	如果此 TracingSpan 正在錄製資訊，則傳回 true。 視範圍實作而定，如果未取樣範圍，這可能會傳回 false。
recordException(string | Error)	記錄 TracingSpan 上的例外狀況，而不需修改其狀態。 錄製應該失敗範圍的未處理例外狀況時，請改用 setStatus 。
setAttribute(string, unknown)	設定範圍上的指定屬性。
setStatus(SpanStatus)	設定範圍的狀態。 提供錯誤時，也會記錄在範圍上。

方法詳細資料

addEvent(string, AddEventOptions)

將事件加入至範圍。

function addEvent(name: string, options?: AddEventOptions)

參數

name

string

options

AddEventOptions

end()

結束範圍。

function end()

isRecording()

如果此 TracingSpan 正在錄製資訊，則傳回 true。

視範圍實作而定，如果未取樣範圍，這可能會傳回 false。

function isRecording(): boolean

傳回

boolean

recordException(string | Error)

記錄 TracingSpan 上的例外狀況，而不需修改其狀態。

錄製應該失敗範圍的未處理例外狀況時，請改用 setStatus 。

function recordException(exception: string | Error)

參數

exception

string | Error

在範圍上記錄的例外狀況。

setAttribute(string, unknown)

設定範圍上的指定屬性。

function setAttribute(name: string, value: unknown)

參數

name

string

屬性的名稱。

value

unknown

要設定的屬性值。 可以是任何非 Null 值。

setStatus(SpanStatus)

設定範圍的狀態。 提供錯誤時，也會記錄在範圍上。

function setStatus(status: SpanStatus)

參數

status

SpanStatus

要設定於範圍的 SpanStatus。