Поделиться через

TracingClient interface

  • Ссылка
Пакет:
@azure/core-tracing

Представляет клиент, который может интегрироваться с настроенными в настоящее время инструментатором.

Создание экземпляра с помощью createTracingClient.

Методы

createRequestHeaders(TracingContext)

Создает набор заголовков запросов для распространения сведений трассировки на серверную часть.
parseTraceparentHeader(string)

Анализирует значение заголовка traceparent в <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)

Запускает заданный диапазон, но не задает его в качестве активного диапазона.

Необходимо завершить диапазон с помощью конца.

Большую часть времени вы хотите использовать с pan.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Упаковывает обратный вызов с активным контекстом и вызывает обратный вызов. В зависимости от реализации это может задать глобальный активный контекст.

Полезно, если вы хотите оставить границы пакета SDK (выполнить запрос или обратный вызов к пользовательскому коду) и не сможете использовать с API pan.
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)

Анализирует значение заголовка traceparent в <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Параметры

traceparentHeader

string

Заголовок traceparent для синтаксического анализа.

Возвращаемое значение

undefined | TracingContext

Идентификатор конкретной реализации для диапазона.

startSpan<Options>(string, Options, TracingSpanOptions)

Запускает заданный диапазон, но не задает его в качестве активного диапазона.

Необходимо завершить диапазон с помощью конца.

Большую часть времени вы хотите использовать с pan.

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

трассировки и обновленных параметров операции.

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

Упаковывает обратный вызов с активным контекстом и вызывает обратный вызов. В зависимости от реализации это может задать глобальный активный контекст.

Полезно, если вы хотите оставить границы пакета SDK (выполнить запрос или обратный вызов к пользовательскому коду) и не сможете использовать с API pan.

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

Параметры

context
TracingContext

ТрассировкаContext использовать в качестве активного контекста в области обратного вызова.

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

Исходные параметры, переданные методу. Обратный вызов получит эти параметры с только что созданной ТрассировкиContext.

callback

Callback

Обратный вызов, который будет вызываться с помощью обновленных параметров и только что созданного Трассировки.

spanOptions
TracingSpanOptions

Возвращаемое значение

Promise<Resolved<ReturnType<Callback>>>