TracingSpan interface
Représente une étendue de suivi indépendant de l’implémentation.
Méthodes
add |
Ajoute un événement à l’étendue. |
end() | Termine l’étendue. |
is |
Retourne true si cette TracingSpan enregistre des informations. Selon l’implémentation de l’étendue, cela peut retourner false si l’étendue n’est pas échantillonné. |
record |
Enregistre une exception sur un TracingSpan sans modifier son état. Lors de l’enregistrement d’une exception non gérée qui doit échouer dans l’étendue, utilisez setStatus à la place. |
set |
Définit un attribut donné sur une étendue. |
set |
Définit l’état de l’étendue. Lorsqu’une erreur est fournie, elle est également enregistrée sur l’étendue. |
Détails de la méthode
addEvent(string, AddEventOptions)
Ajoute un événement à l’étendue.
function addEvent(name: string, options?: AddEventOptions)
Paramètres
- name
-
string
- options
- AddEventOptions
end()
Termine l’étendue.
function end()
isRecording()
Retourne true si cette TracingSpan enregistre des informations.
Selon l’implémentation de l’étendue, cela peut retourner false si l’étendue n’est pas échantillonné.
function isRecording(): boolean
Retours
boolean
recordException(string | Error)
Enregistre une exception sur un TracingSpan sans modifier son état.
Lors de l’enregistrement d’une exception non gérée qui doit échouer dans l’étendue, utilisez setStatus à la place.
function recordException(exception: string | Error)
Paramètres
- exception
-
string | Error
Exception à enregistrer sur l’étendue.
setAttribute(string, unknown)
Définit un attribut donné sur une étendue.
function setAttribute(name: string, value: unknown)
Paramètres
- name
-
string
Nom de l’attribut.
- value
-
unknown
Valeur de l’attribut à définir. Peut être n’importe quelle valeur non nullish.
setStatus(SpanStatus)
Définit l’état de l’étendue. Lorsqu’une erreur est fournie, elle est également enregistrée sur l’étendue.
function setStatus(status: SpanStatus)
Paramètres
- status
- SpanStatus
SpanStatus à définir sur l’étendue.