BotTelemetryClient Interface

  • Référence
Paquet:
com.microsoft.bot.builder
Artefact Maven:
com.microsoft.bot:bot-builder:4.14.3

public interface BotTelemetryClient

Journalisation du client pour la télémétrie bot.

Résumé de la méthode

Modificateur et type Méthode et description
abstract void flush()

Vide la mémoire tampon en mémoire et toutes les métriques pré-agrégées.
default void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success)

Envoyez des informations sur la disponibilité d’une application.
abstract void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success, String message, Map<String,String> properties, Map<String,Double> metrics)

Envoyez des informations sur la disponibilité d’une application.
abstract void trackDependency(String dependencyTypeName, String target, String dependencyName, String data, OffsetDateTime startTime, Duration duration, String resultCode, boolean success)

Envoyez des informations sur une dépendance externe (appel sortant) dans l’application.
abstract void trackDialogView(String dialogName, Map<String,String> properties, Map<String,Double> metrics)

Journaliser une boîte de dialogueAffichage à l’aide de la méthode TrackPageView sur le clientTélémétrie IBotsi IBotPageAfficherTélémétrieClient a été implémenté.
default void trackEvent(String eventName)

Enregistre des événements personnalisés avec des champs nommés extensibles.
default void trackEvent(String eventName, Map<String,String> properties)

Enregistre des événements personnalisés avec des champs nommés extensibles.
abstract void trackEvent(String eventName, Map<String,String> properties, Map<String,Double> metrics)

Enregistre des événements personnalisés avec des champs nommés extensibles.
default void trackException(Exception exception)

Enregistre une exception système.
abstract void trackException(Exception exception, Map<String,String> properties, Map<String,Double> metrics)

Enregistre une exception système.
abstract void trackTrace(String message, Severity severityLevel, Map<String,String> properties)

Envoyez un message de trace.

Détails de la méthode

flush

public abstract void flush()

Vide la mémoire tampon en mémoire et toutes les métriques pré-agrégées.

trackAvailability

public default void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success)

Envoyez des informations sur la disponibilité d’une application.

Paramètres:

name - Nom du test de disponibilité.
timeStamp - Heure à laquelle la disponibilité a été capturée.
duration - Temps nécessaire pour que le test de disponibilité s’exécute.
runLocation - Nom de l’emplacement à partir duquel le test de disponibilité a été exécuté.
success - True si le test de disponibilité s’est exécuté correctement.

trackAvailability

public abstract void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success, String message, Map properties, Map metrics)

Envoyez des informations sur la disponibilité d’une application.

Paramètres:

name - Nom du test de disponibilité.
timeStamp - Heure à laquelle la disponibilité a été capturée.
duration - Temps nécessaire pour que le test de disponibilité s’exécute.
runLocation - Nom de l’emplacement à partir duquel le test de disponibilité a été exécuté.
success - True si le test de disponibilité s’est exécuté correctement.
message - Message d’erreur sur l’échec de l’exécution du test de disponibilité.
properties - Valeurs de chaîne nommées que vous pouvez utiliser pour classifier et rechercher cette télémétrie de disponibilité.
metrics - Valeurs supplémentaires associées à cette télémétrie de disponibilité.

trackDependency

public abstract void trackDependency(String dependencyTypeName, String target, String dependencyName, String data, OffsetDateTime startTime, Duration duration, String resultCode, boolean success)

Envoyez des informations sur une dépendance externe (appel sortant) dans l’application.

Paramètres:

dependencyTypeName - Nom de la commande lancée avec cet appel de dépendance. Valeur de cardinalité faible. Par exemple, SQL, table Azure et HTTP.
target - Cible de dépendance externe.
dependencyName - Nom de la commande lancée avec cet appel de dépendance. Valeur de cardinalité faible. Les exemples sont le nom de procédure stockée et le modèle de chemin d’URL.
data - Commande lancée par cet appel de dépendance. Les exemples sont l’instruction SQL et l’URL HTTP avec tous les paramètres de requête.
startTime - Heure à laquelle la dépendance a été appelée.
duration - Temps nécessaire à la dépendance externe pour gérer l’appel.
resultCode - Code de résultat de l’exécution des appels de dépendance.
success - True si l’appel de dépendance a été géré avec succès.

trackDialogView

public abstract void trackDialogView(String dialogName, Map properties, Map metrics)

Journalisez un DialogView à l’aide de la méthode TrackPageView sur IBotTelemetryClient si IBotPageViewTelemetryClient a été implémenté. Vous pouvez également déconnecter les informations via TrackTrace.

Paramètres:

dialogName - Nom de la boîte de dialogue pour laquelle enregistrer l’entrée/ démarrer.
properties - Valeurs de chaîne nommées que vous pouvez utiliser pour rechercher et classifier des événements.
metrics - Mesures associées à cet événement.

trackEvent

public default void trackEvent(String eventName)

Enregistre des événements personnalisés avec des champs nommés extensibles.

Paramètres:

eventName - Nom de l’événement.

trackEvent

public default void trackEvent(String eventName, Map properties)

Enregistre des événements personnalisés avec des champs nommés extensibles.

Paramètres:

eventName - Nom de l’événement.
properties - Valeurs de chaîne nommées que vous pouvez utiliser pour rechercher et classifier des événements.

trackEvent

public abstract void trackEvent(String eventName, Map properties, Map metrics)

Enregistre des événements personnalisés avec des champs nommés extensibles.

Paramètres:

eventName - Nom de l’événement.
properties - Valeurs de chaîne nommées que vous pouvez utiliser pour rechercher et classifier des événements.
metrics - Mesures associées à cet événement.

trackException

public default void trackException(Exception exception)

Enregistre une exception système.

Paramètres:

exception - Exception à journaliser.

trackException

public abstract void trackException(Exception exception, Map properties, Map metrics)

Enregistre une exception système.

Paramètres:

exception - Exception à journaliser.
properties - Valeurs de chaîne nommées que vous pouvez utiliser pour classifier et rechercher cette exception.
metrics - Valeurs supplémentaires associées à cette exception.

trackTrace

public abstract void trackTrace(String message, Severity severityLevel, Map properties)

Envoyez un message de trace.

Paramètres:

message - Message à afficher.
severityLevel - Niveau de gravité de trace.
properties - Valeurs de chaîne nommées que vous pouvez utiliser pour rechercher et classifier des événements.

S’applique à