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。