Instrumenter interface
Implementációs agnosztikus műszert jelöl.
Metódusok
create |
Implementációspecifikus módszert biztosít a TracingSpan fejléckészletre való szerializálásához. |
parse |
Implementációspecifikus metódust biztosít egy olyan elem elemzéséhez https://www.w3.org/TR/trace-context/#traceparent-header<xref:TracingSpanContext> , amely a nem szülős spanok összekapcsolására használható. |
start |
Létrehoz egy új TracingSpant a megadott névvel és beállításokkal, és beállít egy új kontextust. |
with |
Aktív környezettel burkolja a visszahívást, és meghívja a visszahívást. A megvalósítástól függően ez beállíthatja a globálisan elérhető aktív környezetet. |
Metódus adatai
createRequestHeaders(TracingContext)
Implementációspecifikus módszert biztosít a TracingSpan fejléckészletre való szerializálásához.
function createRequestHeaders(tracingContext?: TracingContext): Record<string, string>
Paraméterek
- tracingContext
- TracingContext
A szerializálni kívánt spant tartalmazó környezet.
Válaszok
Record<string, string>
parseTraceparentHeader(string)
Implementációspecifikus metódust biztosít egy olyan elem elemzéséhez https://www.w3.org/TR/trace-context/#traceparent-header<xref:TracingSpanContext> , amely a nem szülős spanok összekapcsolására használható.
function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext
Paraméterek
- traceparentHeader
-
string
Válaszok
undefined | TracingContext
startSpan(string, InstrumenterSpanOptions)
Létrehoz egy új TracingSpant a megadott névvel és beállításokkal, és beállít egy új kontextust.
function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }
Paraméterek
- name
-
string
A span neve. Konvenció szerint ennek a következőnek kell lennie ${className}.${methodName}
: .
- spanOptions
- InstrumenterSpanOptions
A span létrehozásakor használható beállítások.
Válaszok
{ span: TracingSpan, tracingContext: TracingContext }
Egy TracingSpan , amely a span megszüntetésére használható, és az a környezet, amelyen ez a span be van állítva.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)
Aktív környezettel burkolja a visszahívást, és meghívja a visszahívást. A megvalósítástól függően ez beállíthatja a globálisan elérhető aktív környezetet.
function withContext<CallbackArgs, Callback>(context: TracingContext, callback: Callback, callbackArgs: CallbackArgs): ReturnType<Callback>
Paraméterek
- context
- TracingContext
A visszahívás hatókörében aktív környezetként használandó TracingContext.
- callback
-
Callback
Az adott környezettel globálisan aktív környezetként meghívandó visszahívás.
- callbackArgs
-
CallbackArgs
A visszahívási argumentumok.
Válaszok
ReturnType<Callback>