Instrumenter interface
Mewakili instrumenter agnostik implementasi.
Metode
create |
Menyediakan metode khusus implementasi untuk menserialisasikan TracingSpan ke sekumpulan header. |
parse |
Menyediakan metode khusus implementasi untuk mengurai https://www.w3.org/TR/trace-context/#traceparent-header ke dalam <xref:TracingSpanContext> yang dapat digunakan untuk menautkan rentang non-induk bersama-sama. |
start |
Membuat TracingSpan baru dengan nama dan opsi yang diberikan dan mengaturnya pada konteks baru. |
with |
Membungkus panggilan balik dengan konteks aktif dan memanggil panggilan balik. Tergantung pada implementasinya, ini dapat mengatur konteks aktif yang tersedia secara global. |
Detail Metode
createRequestHeaders(TracingContext)
Menyediakan metode khusus implementasi untuk menserialisasikan TracingSpan ke sekumpulan header.
function createRequestHeaders(tracingContext?: TracingContext): Record<string, string>
Parameter
- tracingContext
- TracingContext
Konteks yang berisi rentang untuk diserialisasikan.
Mengembalikan
Record<string, string>
parseTraceparentHeader(string)
Menyediakan metode khusus implementasi untuk mengurai https://www.w3.org/TR/trace-context/#traceparent-header ke dalam <xref:TracingSpanContext> yang dapat digunakan untuk menautkan rentang non-induk bersama-sama.
function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext
Parameter
- traceparentHeader
-
string
Mengembalikan
undefined | TracingContext
startSpan(string, InstrumenterSpanOptions)
Membuat TracingSpan baru dengan nama dan opsi yang diberikan dan mengaturnya pada konteks baru.
function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }
Parameter
- name
-
string
Nama rentang. Menurut konvensi ini harus ${className}.${methodName}
.
- spanOptions
- InstrumenterSpanOptions
Opsi yang digunakan saat membuat rentang.
Mengembalikan
{ span: TracingSpan, tracingContext: TracingContext }
TracingSpan yang dapat digunakan untuk mengakhiri rentang, dan konteks rentang ini telah diatur.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)
Membungkus panggilan balik dengan konteks aktif dan memanggil panggilan balik. Tergantung pada implementasinya, ini dapat mengatur konteks aktif yang tersedia secara global.
function withContext<CallbackArgs, Callback>(context: TracingContext, callback: Callback, callbackArgs: CallbackArgs): ReturnType<Callback>
Parameter
- context
- TracingContext
TracingContext untuk digunakan sebagai konteks aktif dalam cakupan panggilan balik.
- callback
-
Callback
Panggilan balik yang akan dipanggil dengan konteks yang diberikan ditetapkan sebagai konteks aktif global.
- callbackArgs
-
CallbackArgs
Argumen panggilan balik.
Mengembalikan
ReturnType<Callback>