BotTelemetryClient Schnittstelle

  • Referenz
Paket:
com.microsoft.bot.builder
Maven-Artefakt:
com.microsoft.bot:bot-builder:4.14.3

public interface BotTelemetryClient

Protokollierungsclient für Bot-Telemetrie.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
abstract void flush()

Löscht den Speicherpuffer und alle Metriken, die vorab aggregiert werden.
default void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success)

Senden Sie Informationen zur Verfügbarkeit einer Anwendung.
abstract void trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success, String message, Map<String,String> properties, Map<String,Double> metrics)

Senden Sie Informationen zur Verfügbarkeit einer Anwendung.
abstract void trackDependency(String dependencyTypeName, String target, String dependencyName, String data, OffsetDateTime startTime, Duration duration, String resultCode, boolean success)

Senden Von Informationen zu einer externen Abhängigkeit (ausgehender Aufruf) in der Anwendung.
abstract void trackDialogView(String dialogName, Map<String,String> properties, Map<String,Double> metrics)

Protokollieren Sie ein DialogfeldAnsicht mithilfe derSeite nachverfolgenView-Methode auf dem IBot-Telemetrie-Client, wenn IBotSeiteAnsichtTelemetrie-Client implementiert wurde.
default void trackEvent(String eventName)

Protokolliert benutzerdefinierte Ereignisse mit erweiterbaren benannten Feldern.
default void trackEvent(String eventName, Map<String,String> properties)

Protokolliert benutzerdefinierte Ereignisse mit erweiterbaren benannten Feldern.
abstract void trackEvent(String eventName, Map<String,String> properties, Map<String,Double> metrics)

Protokolliert benutzerdefinierte Ereignisse mit erweiterbaren benannten Feldern.
default void trackException(Exception exception)

Protokolliert eine System exception.
abstract void trackException(Exception exception, Map<String,String> properties, Map<String,Double> metrics)

Protokolliert eine System exception.
abstract void trackTrace(String message, Severity severityLevel, Map<String,String> properties)

Senden einer Ablaufverfolgungsnachricht.

Details zur Methode

flush

public abstract void flush()

Löscht den Speicherpuffer und alle Metriken, die vorab aggregiert werden.

trackAvailability

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

Senden Sie Informationen zur Verfügbarkeit einer Anwendung.

Parameter:

name - Name des Verfügbarkeitstests.
timeStamp - Der Zeitpunkt, zu dem die Verfügbarkeit erfasst wurde.
duration - Die für die Ausführung des Verfügbarkeitstests benötigte Zeit.
runLocation - Name des Speicherorts, von dem der Verfügbarkeitstest ausgeführt wurde.
success - True, wenn der Verfügbarkeitstest erfolgreich ausgeführt wurde.

trackAvailability

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

Senden Sie Informationen zur Verfügbarkeit einer Anwendung.

Parameter:

name - Name des Verfügbarkeitstests.
timeStamp - Der Zeitpunkt, zu dem die Verfügbarkeit erfasst wurde.
duration - Die für die Ausführung des Verfügbarkeitstests benötigte Zeit.
runLocation - Name des Speicherorts, von dem der Verfügbarkeitstest ausgeführt wurde.
success - True, wenn der Verfügbarkeitstest erfolgreich ausgeführt wurde.
message - Fehlermeldung bei Verfügbarkeitstestausführungsfehler.
properties - Benannte Zeichenfolgenwerte, mit deren Hilfe Sie diese Verfügbarkeits-Telemetrie klassifizieren und suchen können.
metrics - Zusätzliche Werte, die dieser Verfügbarkeits-Telemetrie zugeordnet sind.

trackDependency

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

Senden Von Informationen zu einer externen Abhängigkeit (ausgehender Aufruf) in der Anwendung.

Parameter:

dependencyTypeName - Name des Befehls, der mit diesem Abhängigkeitsaufruf initiiert wurde. Niedriger Kardinalitätswert. Beispiele sind SQL, Azure-Tabelle und HTTP.
target - Externes Abhängigkeitsziel.
dependencyName - Name des Befehls, der mit diesem Abhängigkeitsaufruf initiiert wurde. Niedriger Kardinalitätswert. Beispiele sind der Name der gespeicherten Prozedur und die URL-Pfadvorlage.
data - Befehl, der von diesem Abhängigkeitsaufruf initiiert wird. Beispiele sind SQL-Anweisung und HTTP-URL mit allen Abfrageparametern.
startTime - Die Zeit, zu der die Abhängigkeit aufgerufen wurde.
duration - Die Zeit für die Verarbeitung des Aufrufs durch die externe Abhängigkeit.
resultCode - Ergebniscode der Ausführung von Abhängigkeitsaufrufen.
success - True, wenn der Abhängigkeitsaufruf erfolgreich behandelt wurde.

trackDialogView

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

Protokollieren Sie ein DialogView-Objekt mithilfe der TrackPageView-Methode auf dem IBotTelemetryClient, wenn IBotPageViewTelemetryClient implementiert wurde. Alternativ können Sie die Informationen über TrackTrace abmelden.

Parameter:

dialogName - Der Name des Dialogfelds, für das der Eintrag /Start protokolliert werden soll.
properties - Benannte Zeichenfolgenwerte, die Sie zum Suchen und Klassifizieren von Ereignissen verwenden können.
metrics - Messungen, die diesem Ereignis zugeordnet sind.

trackEvent

public default void trackEvent(String eventName)

Protokolliert benutzerdefinierte Ereignisse mit erweiterbaren benannten Feldern.

Parameter:

eventName - Ein Name für das Ereignis.

trackEvent

public default void trackEvent(String eventName, Map properties)

Protokolliert benutzerdefinierte Ereignisse mit erweiterbaren benannten Feldern.

Parameter:

eventName - Ein Name für das Ereignis.
properties - Benannte Zeichenfolgenwerte, die Sie zum Suchen und Klassifizieren von Ereignissen verwenden können.

trackEvent

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

Protokolliert benutzerdefinierte Ereignisse mit erweiterbaren benannten Feldern.

Parameter:

eventName - Ein Name für das Ereignis.
properties - Benannte Zeichenfolgenwerte, die Sie zum Suchen und Klassifizieren von Ereignissen verwenden können.
metrics - Messungen, die diesem Ereignis zugeordnet sind.

trackException

public default void trackException(Exception exception)

Protokolliert eine System exception.

Parameter:

exception - Die Ausnahme zum Protokollieren.

trackException

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

Protokolliert eine System exception.

Parameter:

exception - Die Ausnahme zum Protokollieren.
properties - Benannte Zeichenfolgenwerte, die Sie zum Klassifizieren und Suchen nach dieser Ausnahme verwenden können.
metrics - Dieser Ausnahme zugeordnete zusätzliche Werte.

trackTrace

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

Senden einer Ablaufverfolgungsnachricht.

Parameter:

message - Anzuzeigende Nachricht.
severityLevel - Schweregrad der Ablaufverfolgung.
properties - Benannte Zeichenfolgenwerte, die Sie zum Suchen und Klassifizieren von Ereignissen verwenden können.

Gilt für: