TracingClient interface

套件:: @azure/core-tracing

表示可與目前設定之檢測工具整合的用戶端。

方法

createRequestHeaders(TracingContext)	建立一組要求標頭，以將追蹤資訊傳播至後端。
parseTraceparentHeader(string)	將追蹤父項目標頭值剖析為 <xref:TracingSpanContext>。
startSpan<Options>(string, Options, TracingSpanOptions)	啟動指定的範圍，但不會將它設定為使用中的範圍。您必須使用結尾結束範圍，。您大部分時間都想要改用 withSpan。
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	以使用中內容包裝回呼，並呼叫回呼。視實作而定，這可能會設定全域可用的使用中內容。當您想要離開 SDK 的界限時很有用（對使用者程式代碼提出要求或回呼），且無法使用 withSpan API。
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	在追蹤範圍中包裝回呼、呼叫回呼，並關閉範圍。這是使用追蹤的主要介面，會處理錯誤記錄，以及設定範圍的狀態。同步和異步函式將會等候，以反映跨度回呼的結果。例： `import { createTracingClient } from "@azure/core-tracing"; const tracingClient = createTracingClient({ namespace: "test.namespace", packageName: "test-package", packageVersion: "1.0.0", }); const options = {}; const myOperationResult = await tracingClient.withSpan( "myClassName.myOperationName", options, (updatedOptions) => { // Do something with the updated options. return "myOperationResult"; }, );`

方法詳細資料

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)

啟動指定的範圍，但不會將它設定為使用中的範圍。

您必須使用結尾結束範圍，。

您大部分時間都想要改用 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)

在追蹤範圍中包裝回呼、呼叫回呼，並關閉範圍。

這是使用追蹤的主要介面，會處理錯誤記錄，以及設定範圍的狀態。

同步和異步函式將會等候，以反映跨度回呼的結果。

例：

import { createTracingClient } from "@azure/core-tracing";

const tracingClient = createTracingClient({
  namespace: "test.namespace",
  packageName: "test-package",
  packageVersion: "1.0.0",
});

const options = {};

const myOperationResult = await tracingClient.withSpan(
  "myClassName.myOperationName",
  options,
  (updatedOptions) => {
    // Do something with the updated options.
    return "myOperationResult";
  },
);

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>>>

共用方式為