TelemetryLoggerMiddleware Klasse

  • Referenz
Paket:
com.microsoft.bot.builder
Maven-Artefakt:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.TelemetryLoggerMiddleware

Implementiert

Middleware-

public class TelemetryLoggerMiddleware
implements Middleware

Middleware zum Protokollieren eingehender, ausgehender, aktualisierter oder gelöschter Aktivitätsnachrichten. Verwendet die schnittstelle BotTelemetryClient.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Initialisiert eine neue Instanz der Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillDeleteEventProperties(Activity activity, Map<String,String> additionalProperties)

Füllt die Ereigniseigenschaften für BotMessageDelete aus.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillReceiveEventProperties(Activity activity, Map<String,String> additionalProperties)

Füllt die Ereigniseigenschaften für den BotNachrichtEmpfangen.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillSendEventProperties(Activity activity, Map<String,String> additionalProperties)

Füllt die Ereigniseigenschaften für BotNachrichtSenden aus.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillUpdateEventProperties(Activity activity, Map<String,String> additionalProperties)

Füllt die Ereigniseigenschaften für BotMessageUpdate aus.
BotTelemetryClient getTelemetryClient()

Ruft den aktuell konfigurierten BotTelemetrie-Client ab, der das Ereignis protokolliert.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(Activity activity)

Wird aufgerufen, wenn der Bot eine Nachricht löscht.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onReceiveActivity(Activity activity)

Wird aufgerufen, wenn eine Nachricht vom Benutzer empfangen wird.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onSendActivity(Activity activity)

Wird aufgerufen, wenn der Bot eine Nachricht an den Benutzer sendet.
java.util.concurrent.CompletableFuture<java.lang.Void> onTurn(TurnContext context, NextDelegate next)

Protokolliert Ereignisse basierend auf eingehenden und ausgehenden Aktivitäten mithilfe der BotTelemetryClient Schnittstelle.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onUpdateActivity(Activity activity)

Wird aufgerufen, wenn der Bot eine Nachricht aktualisiert.

Geerbte Methoden von java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Details zum Konstruktor

TelemetryLoggerMiddleware

public TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Initialisiert eine neue Instanz der Klasse.

Parameter:

withTelemetryClient - Die IBotTelemetryClient-Implementierung, die zum Registrieren von Telemetrieereignissen verwendet wird.
withLogPersonalInformation - TRUE, um personenbezogene Informationen einzuschließen.

Details zur Methode

fillDeleteEventProperties

protected CompletableFuture> fillDeleteEventProperties(Activity activity, Map additionalProperties)

Füllt die Ereigniseigenschaften für BotMessageDelete aus. Diese Eigenschaften werden protokolliert, wenn eine Aktivitätsnachricht vom Bot an den Benutzer gesendet wird.

Parameter:

activity - Letzte Aktivität, die vom Benutzer gesendet wurde.
additionalProperties - Zusätzliche Eigenschaften, die dem Ereignis hinzugefügt werden sollen.

Gibt zurück:

Ein Wörterbuch, das als "Properties" an BotTelemetryClient#trackEvent Methode für das BotMessageDelete-Ereignis gesendet wird.

fillReceiveEventProperties

protected CompletableFuture> fillReceiveEventProperties(Activity activity, Map additionalProperties)

Füllt die Ereigniseigenschaften für botMessageReceived aus. Entspricht dem LogPersonalInformation-Flag zum Filtern von Name-, Text- und Speak-Eigenschaften.

Parameter:

activity - Letzte Aktivität, die vom Benutzer gesendet wurde.
additionalProperties - Zusätzliche Eigenschaften, die dem Ereignis hinzugefügt werden sollen.

Gibt zurück:

Ein Wörterbuch, das als "Eigenschaften" an BotTelemetryClient#trackEvent Methode für das BotMessageReceived-Ereignis gesendet wird.

fillSendEventProperties

protected CompletableFuture> fillSendEventProperties(Activity activity, Map additionalProperties)

Füllt die Ereigniseigenschaften für BotMessageSend aus. Diese Eigenschaften werden protokolliert, wenn eine Aktivitätsnachricht vom Bot an den Benutzer gesendet wird.

Parameter:

activity - Letzte Aktivität, die vom Benutzer gesendet wurde.
additionalProperties - Zusätzliche Eigenschaften, die dem Ereignis hinzugefügt werden sollen.

Gibt zurück:

Ein Wörterbuch, das als "Eigenschaften" an BotTelemetryClient#trackEvent Methode für das BotMessageSend-Ereignis gesendet wird.

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

Füllt die Ereigniseigenschaften für BotMessageUpdate aus. Diese Eigenschaften werden protokolliert, wenn eine Aktivitätsnachricht vom Bot an den Benutzer gesendet wird.

Parameter:

activity - Letzte Aktivität, die vom Benutzer gesendet wurde.
additionalProperties - Zusätzliche Eigenschaften, die dem Ereignis hinzugefügt werden sollen.

Gibt zurück:

Ein Wörterbuch, das als "Properties" an BotTelemetryClient#trackEvent Methode für das BotMessageUpdate-Ereignis gesendet wird.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Ruft den aktuell konfigurierten BotTelemetryClient ab, der das Ereignis protokolliert.

Gibt zurück:

Die BotTelemetryClient, die zum Protokollieren von Ereignissen verwendet werden.

onDeleteActivity

protected CompletableFuture onDeleteActivity(Activity activity)

Wird aufgerufen, wenn der Bot eine Nachricht löscht. Führt die Protokollierung von Telemetriedaten mithilfe der BotTelemetryClient#trackEvent-Methode aus. Dieser verwendete Ereignisname lautet "BotMessageDelete".

Parameter:

activity - Aktuelle Aktivität, die vom Benutzer gesendet wurde.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

onReceiveActivity

protected CompletableFuture onReceiveActivity(Activity activity)

Wird aufgerufen, wenn eine Nachricht vom Benutzer empfangen wird. Führt die Protokollierung von Telemetriedaten mithilfe der BotTelemetryClient#trackEvent-Methode aus. Dieser verwendete Ereignisname lautet "BotMessageReceived".

Parameter:

activity - Aktuelle Aktivität, die vom Benutzer gesendet wurde.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

onSendActivity

protected CompletableFuture onSendActivity(Activity activity)

Wird aufgerufen, wenn der Bot eine Nachricht an den Benutzer sendet. Führt die Protokollierung von Telemetriedaten mithilfe der BotTelemetryClient#trackEvent-Methode aus. Dieser verwendete Ereignisname lautet "BotMessageSend".

Parameter:

activity - Aktuelle Aktivität, die vom Benutzer gesendet wurde.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

onTurn

public CompletableFuture onTurn(TurnContext context, NextDelegate next)

Protokolliert Ereignisse basierend auf eingehenden und ausgehenden Aktivitäten mithilfe der BotTelemetryClient Schnittstelle.

Parameter:

context - Das Kontextobjekt für diese Drehung.
next - Die Stellvertretung, die aufgerufen werden soll, um die Bot Middleware-Pipeline fortzusetzen.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

onUpdateActivity

protected CompletableFuture onUpdateActivity(Activity activity)

Wird aufgerufen, wenn der Bot eine Nachricht aktualisiert. Führt die Protokollierung von Telemetriedaten mithilfe der BotTelemetryClient#trackEvent-Methode aus. Dieser verwendete Ereignisname lautet "BotMessageUpdate".

Parameter:

activity - Aktuelle Aktivität, die vom Benutzer gesendet wurde.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Gilt für: