BotTelemetryClient インターフェイス

パッケージ:

com.microsoft.bot.builder

Maven 成果物:

com.microsoft.bot:bot-builder:4.14.3

public interface BotTelemetryClient

ボット テレメトリのログ クライアント。

メソッドの概要

修飾子と型	メソッドと説明
abstract void	flush() メモリ内バッファーと事前に集計されているメトリックをフラッシュします。
default void	trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success) アプリケーションの可用性に関する情報を送信します。
abstract void	trackAvailability(String name, OffsetDateTime timeStamp, Duration duration, String runLocation, boolean success, String message, Map<String,String> properties, Map<String,Double> metrics) アプリケーションの可用性に関する情報を送信します。
abstract void	trackDependency(String dependencyTypeName, String target, String dependencyName, String data, OffsetDateTime startTime, Duration duration, String resultCode, boolean success) アプリケーションの外部依存関係 (発信呼び出し) に関する情報を送信します。
abstract void	trackDialogView(String dialogName, Map<String,String> properties, Map<String,Double> metrics) IBot ページ ビュー テレメトリ クライアントが実装されている場合は、IBotテレメトリクライアントの [ページ ビューの追跡] メソッドを使用してダイアログビューをログに記録します。
default void	trackEvent(String eventName) 拡張可能な名前付きフィールドを使用してカスタム イベントをログに記録します。
default void	trackEvent(String eventName, Map<String,String> properties) 拡張可能な名前付きフィールドを使用してカスタム イベントをログに記録します。
abstract void	trackEvent(String eventName, Map<String,String> properties, Map<String,Double> metrics) 拡張可能な名前付きフィールドを使用してカスタム イベントをログに記録します。
default void	trackException(Exception exception) システム例外をログに記録します。
abstract void	trackException(Exception exception, Map<String,String> properties, Map<String,Double> metrics) システム例外をログに記録します。
abstract void	trackTrace(String message, Severity severityLevel, Map<String,String> properties) トレース メッセージを送信します。

メソッドの詳細

flush

public abstract void flush()

メモリ内バッファーと事前に集計されているメトリックをフラッシュします。

trackAvailability

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

アプリケーションの可用性に関する情報を送信します。

Parameters:

name - 可用性テスト名。

timeStamp - 可用性がキャプチャされた時刻。

duration - 可用性テストの実行にかかった時間。

runLocation - 可用性テストの実行元の場所の名前。

success - 可用性テストが正常に実行された場合は True。

trackAvailability

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

アプリケーションの可用性に関する情報を送信します。

Parameters:

name - 可用性テスト名。

timeStamp - 可用性がキャプチャされた時刻。

duration - 可用性テストの実行にかかった時間。

runLocation - 可用性テストの実行元の場所の名前。

success - 可用性テストが正常に実行された場合は True。

message - 可用性テストの実行エラーに関するエラー メッセージ。

properties - この可用性テレメトリを分類して検索するために使用できる名前付き文字列値。

metrics - この可用性テレメトリに関連付けられている追加の値。

trackDependency

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

アプリケーションの外部依存関係 (発信呼び出し) に関する情報を送信します。

Parameters:

dependencyTypeName - この依存関係呼び出しで開始されたコマンドの名前。 小さなカーディナリティの値です。 例: SQL、Azure テーブル、HTTP。

target - 外部依存関係のターゲット。

dependencyName - この依存関係呼び出しで開始されたコマンドの名前。 小さなカーディナリティの値です。 例として、ストアド プロシージャ名と URL パス テンプレートがあります。

data - この依存関係呼び出しによって開始されるコマンド。 たとえば、すべてのクエリ パラメーターを含む SQL ステートメントと HTTP URL です。

startTime - 依存関係が呼び出された時刻。

duration - 外部依存関係が呼び出しを処理するのにかかった時間。

resultCode - 依存関係呼び出し実行の結果コード。

success - 依存関係の呼び出しが正常に処理された場合は True。

trackDialogView

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

IBotPageViewTelemetryClient が実装されている場合は、IBotTelemetryClient の TrackPageView メソッドを使用して DialogView をログに記録します。 または、TrackTrace を使用して情報をログアウトします。

Parameters:

dialogName - エントリ/開始をログに記録するダイアログの名前。

properties - イベントの検索と分類に使用できる名前付き文字列値。

metrics - このイベントに関連付けられている測定値。

trackEvent

public default void trackEvent(String eventName)

拡張可能な名前付きフィールドを使用してカスタム イベントをログに記録します。

Parameters:

eventName - イベントの名前。

trackEvent

public default void trackEvent(String eventName, Map properties)

拡張可能な名前付きフィールドを使用してカスタム イベントをログに記録します。

Parameters:

eventName - イベントの名前。

properties - イベントの検索と分類に使用できる名前付き文字列値。

trackEvent

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

拡張可能な名前付きフィールドを使用してカスタム イベントをログに記録します。

Parameters:

eventName - イベントの名前。

properties - イベントの検索と分類に使用できる名前付き文字列値。

metrics - このイベントに関連付けられている測定値。

trackException

public default void trackException(Exception exception)

システム例外をログに記録します。

Parameters:

exception - ログに記録される例外。

trackException

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

システム例外をログに記録します。

Parameters:

exception - ログに記録される例外。

properties - この例外を分類して検索するために使用できる名前付き文字列値。

metrics - この例外に関連付けられている追加の値。

trackTrace

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

トレース メッセージを送信します。

Parameters:

message - 表示するメッセージ。

severityLevel - 重大度レベル。

properties - イベントの検索と分類に使用できる名前付き文字列値。