次の方法で共有

TracingClient interface

  • リファレンス
パッケージ:
@azure/core-tracing

現在構成されている Instrumenter と統合できるクライアントを表します。

createTracingClient を使用してインスタンスを作成します。

メソッド

createRequestHeaders(TracingContext)

トレース情報をバックエンドに伝達する一連の要求ヘッダーを作成します。
parseTraceparentHeader(string)

トレース親ヘッダー値を に <xref:TracingSpanContext>解析します。
startSpan<Options>(string, Options, TracingSpanOptions)

指定されたスパンを開始しますが、アクティブスパンとして設定しません。

end を使用してスパンを 終了する必要があります。

ほとんどの場合、代わりに withSpan を 使用します。
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

アクティブなコンテキストでコールバックをラップし、コールバックを呼び出します。 実装によっては、グローバルに使用可能なアクティブ コンテキストが設定される場合があります。

SDK の境界を離れて (ユーザー コードに対して要求またはコールバックを行う)、 withSpan API を使用できない場合に便利です。
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

トレーススパンでコールバックをラップし、コールバックを呼び出してスパンを閉じます。

これはトレースを使用するための主要なインターフェイスであり、エラー記録とスパンの状態の設定を処理します。

スパンでのコールバックの結果を反映するために、同期関数と非同期関数の両方が待機されます。

例:

const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

メソッドの詳細

createRequestHeaders(TracingContext)

トレース情報をバックエンドに伝達する一連の要求ヘッダーを作成します。

function createRequestHeaders(tracingContext?: TracingContext): Record<string, string>

パラメーター

tracingContext
TracingContext

伝達するスパンを含むコンテキスト。

戻り値

Record<string, string>

要求に追加するヘッダーのセット。

parseTraceparentHeader(string)

トレース親ヘッダー値を に <xref:TracingSpanContext>解析します。

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

パラメーター

traceparentHeader

string

解析する traceparent ヘッダー。

戻り値

undefined | TracingContext

スパンの実装固有の識別子。

startSpan<Options>(string, Options, TracingSpanOptions)

指定されたスパンを開始しますが、アクティブスパンとして設定しません。

end を使用してスパンを 終了する必要があります。

ほとんどの場合、代わりに withSpan を 使用します。

function startSpan<Options>(name: string, operationOptions?: Options, spanOptions?: TracingSpanOptions): { span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

パラメーター

name

string

スパンの名前。 慣例により、これは にする ${className}.${methodName}必要があります。

operationOptions

Options

元の操作オプション。

spanOptions
TracingSpanOptions

スパンの作成時に使用するオプション。

戻り値

{ span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

TracingSpan と更新された操作オプション。

withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

アクティブなコンテキストでコールバックをラップし、コールバックを呼び出します。 実装によっては、グローバルに使用可能なアクティブ コンテキストが設定される場合があります。

SDK の境界を離れて (ユーザー コードに対して要求またはコールバックを行う)、 withSpan API を使用できない場合に便利です。

function withContext<CallbackArgs, Callback>(context: TracingContext, callback: Callback, callbackArgs: CallbackArgs): ReturnType<Callback>

パラメーター

context
TracingContext

コールバックのスコープでアクティブなコンテキストとして使用する TracingContext 。

callback

Callback

指定したコンテキストをグローバルにアクティブなコンテキストとして設定して呼び出されるコールバック。

callbackArgs

CallbackArgs

コールバック引数。

戻り値

ReturnType<Callback>

withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

トレーススパンでコールバックをラップし、コールバックを呼び出してスパンを閉じます。

これはトレースを使用するための主要なインターフェイスであり、エラー記録とスパンの状態の設定を処理します。

スパンでのコールバックの結果を反映するために、同期関数と非同期関数の両方が待機されます。

例:

const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

function withSpan<Options, Callback>(name: string, operationOptions: Options, callback: Callback, spanOptions?: TracingSpanOptions): Promise<Resolved<ReturnType<Callback>>>

パラメーター

name

string

スパンの名前。 慣例により、これは にする ${className}.${methodName}必要があります。

operationOptions

Options

メソッドに渡された元のオプション。 コールバックは、新しく作成された TracingContext でこれらのオプションを受け取ります。

callback

Callback

更新されたオプションと新しく作成された TracingSpan を使用して呼び出されるコールバック。

spanOptions
TracingSpanOptions

戻り値

Promise<Resolved<ReturnType<Callback>>>