你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
TracingSpan interface
表示与实现无关的跟踪范围。
方法
add |
将事件添加到范围。 |
end() | 结束范围。 |
is |
如果此 TracingSpan 正在记录信息,则返回 true。 根据范围实现的不同,如果未对范围进行采样,则这可能会返回 false。 |
record |
记录 TracingSpan 上的异常,而不修改其状态。 录制应失败范围的未经处理的异常时,请改用 setStatus。 |
set |
设置跨度上的给定属性。 |
set |
设置范围的状态。 提供错误时,也会在跨度上记录该错误。 |
方法详细信息
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。