Instrumenter interface
実装に依存しないインストルメンタを表します。
メソッド
| create |
TracingSpan をヘッダーのセットにシリアル化するための実装固有のメソッドを提供します。 |
| parse |
を に解析https://www.w3.org/TR/trace-context/#traceparent-header<xref:TracingSpanContext>する実装固有のメソッドを提供します。これを使用して、親ではないスパンをリンクできます。 |
| start |
指定した名前とオプションを使用して新しい TracingSpan を作成し、新しいコンテキストに設定します。 |
| with |
アクティブなコンテキストでコールバックをラップし、コールバックを呼び出します。 実装によっては、グローバルに使用可能なアクティブ コンテキストが設定される場合があります。 |
メソッドの詳細
createRequestHeaders(TracingContext)
TracingSpan をヘッダーのセットにシリアル化するための実装固有のメソッドを提供します。
function createRequestHeaders(tracingContext?: TracingContext): Record<string, string>パラメーター
- tracingContext
- TracingContext
シリアル化するスパンを含むコンテキスト。
戻り値
Record<string, string>
parseTraceparentHeader(string)
を に解析https://www.w3.org/TR/trace-context/#traceparent-header<xref:TracingSpanContext>する実装固有のメソッドを提供します。これを使用して、親ではないスパンをリンクできます。
function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContextパラメーター
- traceparentHeader
-
string
戻り値
undefined | TracingContext
startSpan(string, InstrumenterSpanOptions)
指定した名前とオプションを使用して新しい TracingSpan を作成し、新しいコンテキストに設定します。
function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }パラメーター
- name
-
string
スパンの名前。 慣例により、これは にする ${className}.${methodName}必要があります。
- spanOptions
- InstrumenterSpanOptions
スパンを作成するときに使用するオプション。
戻り値
{ span: TracingSpan, tracingContext: TracingContext }
スパンを終了するために使用できる TracingSpan と、このスパンが設定されているコンテキスト。
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)
アクティブなコンテキストでコールバックをラップし、コールバックを呼び出します。 実装によっては、グローバルに使用可能なアクティブ コンテキストが設定される場合があります。
function withContext<CallbackArgs, Callback>(context: TracingContext, callback: Callback, callbackArgs: CallbackArgs): ReturnType<Callback>パラメーター
- context
- TracingContext
コールバックのスコープでアクティブなコンテキストとして使用する TracingContext 。
- callback
-
Callback
指定されたコンテキストをグローバルにアクティブなコンテキストとして設定して呼び出されるコールバック。
- callbackArgs
-
CallbackArgs
コールバック引数。
戻り値
ReturnType<Callback>