Instrumenter interface
表示与实现无关的检测程序。
方法
create |
提供特定于实现的方法,用于将 TracingSpan 序列化为一组标头。 |
parse |
提供特定于实现的方法,用于将 https://www.w3.org/TR/trace-context/#traceparent-header 分析为 <xref:TracingSpanContext>,该 <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>,该 <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>