TracingSpan interface
Reprezentuje niezależny zakres śledzenia implementacji.
Metody
add |
Dodaje zdarzenie do zakresu. |
end() | Kończy rozpiętość. |
is |
Zwraca wartość true, jeśli ta TracingSpan rejestruje informacje. W zależności od implementacji zakresu może to zwracać wartość false, jeśli zakres nie jest próbkowany. |
record |
Rejestruje wyjątek TracingSpan bez modyfikowania jego stanu. Podczas rejestrowania nieobsługiwanego wyjątku, który powinien zakończyć się niepowodzeniem, użyj setStatus. |
set |
Ustawia dany atrybut na rozpiętości. |
set |
Ustawia stan zakresu. Po podaniu błędu zostanie on również zarejestrowany na rozpiętości. |
Szczegóły metody
addEvent(string, AddEventOptions)
Dodaje zdarzenie do zakresu.
function addEvent(name: string, options?: AddEventOptions)
Parametry
- name
-
string
- options
- AddEventOptions
end()
Kończy rozpiętość.
function end()
isRecording()
Zwraca wartość true, jeśli ta TracingSpan rejestruje informacje.
W zależności od implementacji zakresu może to zwracać wartość false, jeśli zakres nie jest próbkowany.
function isRecording(): boolean
Zwraca
boolean
recordException(string | Error)
Rejestruje wyjątek TracingSpan bez modyfikowania jego stanu.
Podczas rejestrowania nieobsługiwanego wyjątku, który powinien zakończyć się niepowodzeniem, użyj setStatus.
function recordException(exception: string | Error)
Parametry
- exception
-
string | Error
Wyjątek do rejestrowania w zakresie.
setAttribute(string, unknown)
Ustawia dany atrybut na rozpiętości.
function setAttribute(name: string, value: unknown)
Parametry
- name
-
string
Nazwa atrybutu.
- value
-
unknown
Wartość atrybutu do ustawienia. Może być dowolną wartością inną niż null.
setStatus(SpanStatus)
Ustawia stan zakresu. Po podaniu błędu zostanie on również zarejestrowany na rozpiętości.
function setStatus(status: SpanStatus)
Parametry
- status
- SpanStatus
SpanStatus ustawić na rozpiętości.